| 1 | # Changelog
|
| 2 |
|
| 3 | ## 5.0.1
|
| 4 |
|
| 5 | The API has been completely revamped to increase clarity and enable a very wide range of new usage. **Please read the readme for all the details.**
|
| 6 |
|
| 7 | While the defaults remain just as useful as before — and you can still pass no options at all — now you can also do all kinds of wild and crazy things.
|
| 8 |
|
| 9 | - The `loaders` option allows you specify custom functions to derive config objects from files. Your loader functions could parse ES2015 modules or TypeScript, JSON5, even INI or XML. Whatever suits you.
|
| 10 | - The `searchPlaces` option allows you to specify exactly where cosmiconfig looks within each directory it searches.
|
| 11 | - The combination of `loaders` and `searchPlaces` means that you should be able to load pretty much any kind of configuration file you want, from wherever you want it to look.
|
| 12 |
|
| 13 | Additionally, the overloaded `load()` function has been split up into several clear and focused functions:
|
| 14 |
|
| 15 | - `search()` now searches up the directory tree, and `load()` loads a configuration file that you don't need to search for.
|
| 16 | - The `sync` option has been replaced with separate synchronous functions: `searchSync()` and `loadSync()`.
|
| 17 | - `clearFileCache()` and `clearDirectoryCache()` have been renamed to `clearLoadCache()` and `clearSearchPath()` respectively.
|
| 18 |
|
| 19 | More details:
|
| 20 |
|
| 21 | - The default JS loader uses `require`, instead of `require-from-string`. So you *could* use `require` hooks to control the loading of JS files (e.g. pass them through esm or Babel). In most cases it is probably preferable to use a custom loader.
|
| 22 | - The options `rc`, `js`, and `rcExtensions` have all been removed. You can accomplish the same and more with `searchPlaces`.
|
| 23 | - The default `searchPlaces` include `rc` files with extensions, e.g. `.thingrc.json`, `.thingrc.yaml`, `.thingrc.yml`. This is the equivalent of switching the default value of the old `rcExtensions` option to `true`.
|
| 24 | - The option `rcStrictJson` has been removed. To get the same effect, you can specify `noExt: cosmiconfig.loadJson` in your `loaders` object.
|
| 25 | - `packageProp` no longer accepts `false`. If you don't want to look in `package.json`, write a `searchPlaces` array that does not include it.
|
| 26 | - By default, empty files are ignored by `search()`. The new option `ignoreEmptySearchPlaces` allows you to load them, instead, in case you want to do something with empty files.
|
| 27 | - The option `configPath` has been removed. Just pass your filepaths directory to `load()`.
|
| 28 | - Removed the `format` option. Formats are now all handled via the file extensions specified in `loaders`.
|
| 29 |
|
| 30 | (If you're wondering with happened to 5.0.0 ... it was a silly publishing mistake.)
|
| 31 |
|
| 32 | ## 4.0.0
|
| 33 |
|
| 34 | - Licensing improvement: updated `parse-json` from `3.0.0` to `4.0.0`(see [sindresorhus/parse-json#12][parse-json-pr-12]).
|
| 35 | - Changed: error message format for `JSON` parse errors(see [#101][pr-101]). If you were relying on the format of JSON-parsing error messages, this will be a breaking change for you.
|
| 36 | - Changed: set default for `searchPath` as `process.cwd()` in `explorer.load`.
|
| 37 |
|
| 38 | ## 3.1.0
|
| 39 |
|
| 40 | - Added: infer format based on filePath
|
| 41 |
|
| 42 | ## 3.0.1
|
| 43 |
|
| 44 | - Fixed: memory leak due to bug in `require-from-string`.
|
| 45 | - Added: for JSON files, append position to end of error message.
|
| 46 |
|
| 47 | ## 3.0.0
|
| 48 |
|
| 49 | - Removed: support for loading config path using the `--config` flag. cosmiconfig will not parse command line arguments. Your application can parse command line arguments and pass them to cosmiconfig.
|
| 50 | - Removed: `argv` config option.
|
| 51 | - Removed: support for Node versions < 4.
|
| 52 | - Added: `sync` option.
|
| 53 | - Fixed: Throw a clear error on getting empty config file.
|
| 54 | - Fixed: when a `options.configPath` is `package.json`, return the package prop, not the entire JSON file.
|
| 55 |
|
| 56 | ## 2.2.2
|
| 57 |
|
| 58 | - Fixed: `options.configPath` and `--config` flag are respected.
|
| 59 |
|
| 60 | ## 2.2.0, 2.2.1
|
| 61 |
|
| 62 | - 2.2.0 included a number of improvements but somehow broke stylelint. The changes were reverted in 2.2.1, to be restored later.
|
| 63 |
|
| 64 | ## 2.1.3
|
| 65 |
|
| 66 | - Licensing improvement: switched from `json-parse-helpfulerror` to `parse-json`.
|
| 67 |
|
| 68 | ## 2.1.2
|
| 69 |
|
| 70 | - Fixed: bug where an `ENOENT` error would be thrown is `searchPath` referenced a non-existent file.
|
| 71 | - Fixed: JSON parsing errors in Node v7.
|
| 72 |
|
| 73 | ## 2.1.1
|
| 74 |
|
| 75 | - Fixed: swapped `graceful-fs` for regular `fs`, fixing a garbage collection problem.
|
| 76 |
|
| 77 | ## 2.1.0
|
| 78 |
|
| 79 | - Added: Node 0.12 support.
|
| 80 |
|
| 81 | ## 2.0.2
|
| 82 |
|
| 83 | - Fixed: Node version specified in `package.json`.
|
| 84 |
|
| 85 | ## 2.0.1
|
| 86 |
|
| 87 | - Fixed: no more infinite loop in Windows.
|
| 88 |
|
| 89 | ## 2.0.0
|
| 90 |
|
| 91 | - Changed: module now creates cosmiconfig instances with `load` methods (see README).
|
| 92 | - Added: caching (enabled by the change above).
|
| 93 | - Removed: support for Node versions <4.
|
| 94 |
|
| 95 | ## 1.1.0
|
| 96 |
|
| 97 | - Add `rcExtensions` option.
|
| 98 |
|
| 99 | ## 1.0.2
|
| 100 |
|
| 101 | - Fix handling of `require()`'s within JS module configs.
|
| 102 |
|
| 103 | ## 1.0.1
|
| 104 |
|
| 105 | - Switch Promise implementation to pinkie-promise.
|
| 106 |
|
| 107 | ## 1.0.0
|
| 108 |
|
| 109 | - Initial release.
|
| 110 |
|
| 111 | [parse-json-pr-12]: https://github.com/sindresorhus/parse-json/pull/12
|
| 112 |
|
| 113 | [pr-101]: https://github.com/davidtheclark/cosmiconfig/pull/101
|