conf

Breaking

• Require Node.js 10 e28b8d9

Improvements

• Move to TypeScript (#104) 41b0c10
  This hopefully should result in better types.

https://github.com/sindresorhus/conf/compare/v6.2.4...v7.0.0

• Fix issue with package.json inference when using the cwd option (#107) 3ef2da0

https://github.com/sindresorhus/conf/compare/v6.2.3...v6.2.4

• Work around EXDEV error (#106) 64b386a

https://github.com/sindresorhus/conf/compare/v6.2.1...v6.2.3

• Improve docs 3ec30d2 66b1058 7e6fcbe

https://github.com/sindresorhus/conf/compare/v6.2.0...v6.2.1

• Warning: The migrations option is buggy. Don't use it at this time.
• Add semver range capabilities into migrations (#88) df3a256

https://github.com/sindresorhus/conf/compare/v6.1.0...v6.2.0

• Add .reset() method (#87) 52ca0dd
• Add watch option (#77) 8bd3352

https://github.com/sindresorhus/conf/compare/v6.0.1...v6.1.0

• Fix the TypeScript types (#90) b5a4676
  The types were accidentally looser than intended.

https://github.com/sindresorhus/conf/compare/v6.0.0...v6.0.1

Breaking for TypeScript users

• Improve TypeScript typings (#73) ef63b11 ff54952 93ace80
  The types were made much better, but it will probably break for some users. You can now properly define a strongly-typed store. Example.
  Note: There's no way to use a dot-path like config.get('foo.bar') with a typed store. We're looking into how to support that: https://github.com/sindresorhus/conf/issues/86

Enhancements

• Add support for migrations (#83) 931ffce

Fixes

• Add temporary workaround for Conf being packaged in a Snap app 68bbb46

https://github.com/sindresorhus/conf/compare/v5.0.0...v6.0.0

This version does not have any breaking changes. It's a major version as it has an automatic migration-step for the encryptionKey option. So if you're using that option, please continue reading.

Short story, Node.js deprecated the below APIs and we had to do encryption differently. Conf should be able to read both the new and old encryption format and it will write the new encryption format if you change any config. The migration is fully automatic, but please test your app thoroughly in case there are any issues.

• Replace deprecated crypto.createDecipher() and crypto.createCipher() Node.js methods (#76) 177fe65

https://github.com/sindresorhus/conf/compare/v4.1.0...v5.0.0

• Add accessPropertiesByDotNotation option (#67) 94f71c5
• Add .onDidAnyChange method (#66) 0c942e1

https://github.com/sindresorhus/conf/compare/v4.0.2...v4.1.0

• TypeScript - Fix parameter name order for onDidChange callback (#70) 201c2ff

https://github.com/sindresorhus/conf/compare/v4.0.1...v4.0.2

• TypeScript - Fix return type of onDidChange (#65) 2bda368

https://github.com/sindresorhus/conf/compare/v4.0.0...v4.0.1

Breaking

• The config is now stored in %APPDATA% instead of %LOCALAPPDATA% on Windows, which is more correct. There's unfortunately no automatic migration path. To continue using the old config location, run npm i 'env-paths@^1.0.0' and set the cwd option:

   const Conf = require('conf');
   const envPaths = require('env-paths');
   
   const config = new Conf({
   	cwd: envPaths('<projectName>', {suffix: 'nodejs'}).config
   });
  

• For TypeScript users only: Refactor TypeScript definition to CommonJS compatible export (#64) 277d70a
  - You need to change import Conf from 'conf'; to import Conf = require('conf');

Enhancements

• Add support for JSON schema (#58) 373afb9
• Fix path derivation logic (#62) bb26c4f

https://github.com/sindresorhus/conf/compare/v3.0.0...v4.0.0

Breaking:

• Require Node.js 8 e30cdad
• Prevent unsupported JSON values d162504

Enhancements:

• Add TypeScript definition (#61) 330e011
• Add clearInvalidConfig option d725709
• Add serialize and deserialize options (#59) e18a4a3

https://github.com/sindresorhus/conf/compare/v2.2.0...v3.0.0

• Allow extension-less config filename f1f1c59