cosmiconfig

• breaking

  The required version range is now ^22.18 || >=24.

• breaking

  Remove typescript in favor of Node's own type stripping. This means that TypeScript 7 projects are supported, but non-erasable type syntax like namespace or enum is unsupported.

• breaking

  JSON parsing uses the JSON.parse function directly. parse-json is no longer used for better error messages, since Node has improved theirs.

• Remove import-fresh dependency in favor of directly clearing the cache.

• Added support for UTF-16 config files

• Added searchStrategy option:

  • The none value means that cosmiconfig does not traverse any directories upwards.

    • Breaking change: This is the default value if you don't pass a stopDir option, which means that cosmiconfig no longer traverses directories by default, and instead just looks in the current working directory.

      • If you want to achieve maximum backwards compatibility without adding an explicit stopDir, add the searchStrategy: 'global' option.

  • The project value means that cosmiconfig traverses upwards until it finds a package.json (or .yaml) file.

  • The global value means that cosmiconfig traverses upwards until the passed stopDir, or your home directory if no stopDir is given.

• breaking

  Meta config files (i.e. config.js and similar) are not looked for in the current working directory anymore. Instead, it looks in the .config subfolder.

• breaking

  When defining searchPlaces in a meta config file, the tool-defined searchPlaces are merged into this. Users may specify mergeSearchPlaces: false to disable this.

• Added support for a special $import key which will import another configuration file

  • The imported file will act as a base file - all properties from that file will be applied to the configuration, but can be overridden by the importing file

  • For more information, read the import section of the README

• Added searching in OS conventional folders (XDG compatible on Linux, %APPDATA% on Windows, Library/Preferences on macOS) for searchStrategy: 'global'

• Fixed crash when trying to load a file that is not readable due to file system permissions

• Fixed wrong ERR_REQUIRE_ESM error being thrown when there is an issue loading an ESM file

No major breaking changes! We dropped support for Node 10 and 12 -- which you're probably not using. And we swapped out the YAML parser -- which you probably won't notice.

• breaking

  Drop support for Node 10 and 12.

• breaking

  Use npm package js-yaml to parse YAML instead of npm package yaml.

• Added: Loader errors now include the path of the file that was tried to be loaded.

• breaking

  The package now has named exports. See examples below.

• breaking

  Separate async and sync APIs, accessible from different named exports. If you used explorer.searchSync() or explorer.loadSync(), you'll now create a sync explorer with cosmiconfigSync(), then use explorerSync.search() and explorerSync.load().

  // OLD: cosmiconfig v5
  import cosmiconfig from 'cosmiconfig';
  
  const explorer = cosmiconfig('example');
  const searchAsyncResult = await explorer.search();
  const loadAsyncResult = await explorer.load('./file/to/load');
  const searchSyncResult = explorer.searchSync();
  const loadSyncResult = explorer.loadSync('./file/to/load');
  
  // NEW: cosmiconfig v6
  import { cosmiconfig, cosmiconfigSync } from 'cosmiconfig';
  
  const explorer = cosmiconfig('example');
  const searchAsyncResult = await explorer.search();
  const loadAsyncResult = await explorer.load('./file/to/load');
  
  const explorerSync = cosmiconfigSync('example');
  const searchSyncResult = explorerSync.search();
  const loadSyncResult = explorerSync.load('./file/to/load');

• breaking

  Remove support for Node 4 and 6. Requires Node 8+.

• breaking

  Use npm package yaml to parse YAML instead of npm package js-yaml.

• breaking

  Remove cosmiconfig.loaders and add named export defaultLoaders that exports the default loaders used for each extension.

  import { defaultLoaders } from 'cosmiconfig';
  
  console.log(Object.entries(defaultLoaders));
  // [
  //   [ '.js', [Function: loadJs] ],
  //   [ '.json', [Function: loadJson] ],
  //   [ '.yaml', [Function: loadYaml] ],
  //   [ '.yml', [Function: loadYaml] ],
  //   [ 'noExt', [Function: loadYaml] ]
  // ]

• Migrate from Flowtype to Typescript.

• Lazy load all default loaders.

• Added: packageProp values can be arrays of strings, to allow for property names that include periods. (This was possible before, but not documented or deliberately supported.)

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.

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.

• 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.

• The searchPlaces option allows you to specify exactly where cosmiconfig looks within each directory it searches.

• 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.

Additionally, the overloaded load() function has been split up into several clear and focused functions:

• search() now searches up the directory tree, and load() loads a configuration file that you don't need to search for.

• The sync option has been replaced with separate synchronous functions: searchSync() and loadSync().

• clearFileCache() and clearDirectoryCache() have been renamed to clearLoadCache() and clearSearchPath() respectively.

More details:

• 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.

• The options rc, js, and rcExtensions have all been removed. You can accomplish the same and more with searchPlaces.

• 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.

• The option rcStrictJson has been removed. To get the same effect, you can specify noExt: cosmiconfig.loadJson in your loaders object.

• breaking

  packageProp no longer accepts false. If you don't want to look in package.json, write a searchPlaces array that does not include it.

• 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.

• The option configPath has been removed. Just pass your filepaths directory to load().

• removed

  Removed the format option. Formats are now all handled via the file extensions specified in loaders.

(If you're wondering with happened to 5.0.0 ... it was a silly publishing mistake.)

• 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.

• Removed: argv config option.

• Removed: support for Node versions < 4.

• Added: sync option.

• Fixed: Throw a clear error on getting empty config file.

• Fixed: when a options.configPath is package.json, return the package prop, not the entire JSON file.