UNPKG

5.18 kBMarkdownView Raw
1# Changelog
2
3## 5.0.3
4
5- Docs: Minor corrections to documentation. *Released to update package documentation on npm*.
6
7## 5.0.2
8
9- Fixed: Allow `searchSync` and `loadSync` to load JS configuration files whose export is a Promise.
10
11## 5.0.1
12
13The 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.**
14
15While 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.
16
17- 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.
18- The `searchPlaces` option allows you to specify exactly where cosmiconfig looks within each directory it searches.
19- 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.
20
21Additionally, the overloaded `load()` function has been split up into several clear and focused functions:
22
23- `search()` now searches up the directory tree, and `load()` loads a configuration file that you don't need to search for.
24- The `sync` option has been replaced with separate synchronous functions: `searchSync()` and `loadSync()`.
25- `clearFileCache()` and `clearDirectoryCache()` have been renamed to `clearLoadCache()` and `clearSearchPath()` respectively.
26
27More details:
28
29- 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.
30- The options `rc`, `js`, and `rcExtensions` have all been removed. You can accomplish the same and more with `searchPlaces`.
31- 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`.
32- The option `rcStrictJson` has been removed. To get the same effect, you can specify `noExt: cosmiconfig.loadJson` in your `loaders` object.
33- `packageProp` no longer accepts `false`. If you don't want to look in `package.json`, write a `searchPlaces` array that does not include it.
34- 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.
35- The option `configPath` has been removed. Just pass your filepaths directory to `load()`.
36- Removed the `format` option. Formats are now all handled via the file extensions specified in `loaders`.
37
38(If you're wondering with happened to 5.0.0 ... it was a silly publishing mistake.)
39
40## 4.0.0
41
42- Licensing improvement: updated `parse-json` from `3.0.0` to `4.0.0`(see [sindresorhus/parse-json#12][parse-json-pr-12]).
43- 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.
44- Changed: set default for `searchPath` as `process.cwd()` in `explorer.load`.
45
46## 3.1.0
47
48- Added: infer format based on filePath
49
50## 3.0.1
51
52- Fixed: memory leak due to bug in `require-from-string`.
53- Added: for JSON files, append position to end of error message.
54
55## 3.0.0
56
57- 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.
58- Removed: `argv` config option.
59- Removed: support for Node versions < 4.
60- Added: `sync` option.
61- Fixed: Throw a clear error on getting empty config file.
62- Fixed: when a `options.configPath` is `package.json`, return the package prop, not the entire JSON file.
63
64## 2.2.2
65
66- Fixed: `options.configPath` and `--config` flag are respected.
67
68## 2.2.0, 2.2.1
69
70- 2.2.0 included a number of improvements but somehow broke stylelint. The changes were reverted in 2.2.1, to be restored later.
71
72## 2.1.3
73
74- Licensing improvement: switched from `json-parse-helpfulerror` to `parse-json`.
75
76## 2.1.2
77
78- Fixed: bug where an `ENOENT` error would be thrown is `searchPath` referenced a non-existent file.
79- Fixed: JSON parsing errors in Node v7.
80
81## 2.1.1
82
83- Fixed: swapped `graceful-fs` for regular `fs`, fixing a garbage collection problem.
84
85## 2.1.0
86
87- Added: Node 0.12 support.
88
89## 2.0.2
90
91- Fixed: Node version specified in `package.json`.
92
93## 2.0.1
94
95- Fixed: no more infinite loop in Windows.
96
97## 2.0.0
98
99- Changed: module now creates cosmiconfig instances with `load` methods (see README).
100- Added: caching (enabled by the change above).
101- Removed: support for Node versions <4.
102
103## 1.1.0
104
105- Add `rcExtensions` option.
106
107## 1.0.2
108
109- Fix handling of `require()`'s within JS module configs.
110
111## 1.0.1
112
113- Switch Promise implementation to pinkie-promise.
114
115## 1.0.0
116
117- Initial release.
118
119[parse-json-pr-12]: https://github.com/sindresorhus/parse-json/pull/12
120
121[pr-101]: https://github.com/davidtheclark/cosmiconfig/pull/101