V6

.eslintrc.js

@@ -0,0 +1,163 @@
+'use strict';
+
+// first node 8.x LTS release
+const supportedNodeVersion = '8.9';
+const allExtensions = ['.js', '.jsx', '.ts', '.tsx', '.mjs', '.json'];
+
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    sourceType: 'module',
+    project: './tsconfig.eslint.json',
+  },
+  extends: [
+    'eslint-config-davidtheclark-node',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:import/typescript',
+    'plugin:jest/recommended',
+    'prettier',
+    'prettier/@typescript-eslint',
+  ],
+  plugins: ['jest', '@typescript-eslint', 'import'],
+  rules: {
+    'no-var': 'off',
+    'prefer-const': 'off',
+    'prefer-arrow-callback': 'off',
+    'func-names': ['error', 'always'],
+    'prefer-template': 'error',
+    'no-prototype-builtins': 'error',
+    'object-shorthand': [
+      'error',
+      'always',
+      { avoidExplicitReturnArrows: true },
+    ],
+
+    /**
+     * eslint-plugin-typescript
+     */
+    '@typescript-eslint/explicit-function-return-type': [
+      'error',
+      {
+        allowTypedFunctionExpressions: true,
+      },
+    ],
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/array-type': ['error', { default: 'generic' }],
+
+    // requires type information rules
+    '@typescript-eslint/await-thenable': 'error',
+    '@typescript-eslint/no-floating-promises': 'error',
+    '@typescript-eslint/no-for-in-array': 'error',
+    '@typescript-eslint/no-unnecessary-qualifier': 'error',
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    '@typescript-eslint/prefer-includes': 'error',
+    '@typescript-eslint/prefer-namespace-keyword': 'error',
+    // '@typescript-eslint/prefer-readonly': 'error',
+    '@typescript-eslint/prefer-regexp-exec': 'error',
+    '@typescript-eslint/prefer-string-starts-ends-with': 'error',
+    '@typescript-eslint/promise-function-async': ['error', { allowAny: true }],
+    '@typescript-eslint/require-array-sort-compare': 'error',
+    '@typescript-eslint/restrict-plus-operands': 'error',
+    // '@typescript-eslint/strict-boolean-expressions': 'error',
+    '@typescript-eslint/unbound-method': 'error',
+
+    // rules not in recommended
+    '@typescript-eslint/ban-ts-ignore': 'off', // maybe enable?
+    '@typescript-eslint/member-ordering': 'off', // maybe enable?
+    '@typescript-eslint/no-empty-function': 'error',
+    '@typescript-eslint/no-extraneous-class': 'error',
+    '@typescript-eslint/no-require-imports': 'error',
+    '@typescript-eslint/no-this-alias': 'error',
+    '@typescript-eslint/no-useless-constructor': 'error',
+    '@typescript-eslint/prefer-for-of': 'error',
+    '@typescript-eslint/prefer-function-type': 'error',
+    '@typescript-eslint/unified-signatures': 'error',
+
+    /**
+     * eslint-plugin-node
+     */
+    'node/no-unpublished-require': 'off',
+    'node/no-unsupported-features': 'off',
+    'node/no-unsupported-features/es-builtins': 'off',
+    'node/no-unsupported-features/es-syntax': 'off',
+    'node/no-unsupported-features/node-builtins': 'off',
+    // Redundant with import/no-extraneous-dependencies
+    'node/no-extraneous-import': 'off',
+    'node/no-extraneous-require': 'off',
+    // Redundant with import/no-unresolved
+    'node/no-missing-import': 'off',
+    'node/no-missing-require': 'off',
+
+    /**
+     * eslint-plugin-import
+     */
+    'import/no-default-export': 'error',
+    'import/no-named-export': 'off',
+    'import/prefer-default-export': 'off',
+
+    /**
+     * eslint-plugin-jest
+     */
+    'jest/consistent-test-it': ['error', { fn: 'test' }],
+    'jest/no-empty-title': 'error',
+    'jest/no-test-callback': 'error',
+    'jest/prefer-todo': 'error',
+    'jest/require-tothrow-message': 'error',
+  },
+  settings: {
+    node: {
+      convertPath: {
+        'src/**/*.{js,ts}': ['^src/(.+?)\\.(js|ts)$', 'dist/$1.js'],
+        'src/**/.*.{js,ts}': ['^src/(.+?)\\.(js|ts)$', 'dist/$1.js'],
+      },
+      tryExtensions: allExtensions,
+    },
+    'import/resolver': {
+      node: {
+        extensions: allExtensions,
+      },
+    },
+    'import/extensions': allExtensions,
+  },
+  overrides: [
+    {
+      files: ['*.test.{js,ts}', '.*.test.{js,ts}'],
+      rules: {
+        '@typescript-eslint/ban-ts-ignore': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        '@typescript-eslint/no-require-imports': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/require-await': 'off',
+      },
+    },
+    {
+      files: ['*.js', '.*.js'],
+      excludedFiles: ['*/**', '*/.**'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+      rules: {
+        strict: ['error', 'safe'],
+
+        'node/no-unpublished-require': 'off',
+        'node/no-unsupported-features/es-builtins': [
+          'error',
+          { version: supportedNodeVersion },
+        ],
+        'node/no-unsupported-features/es-syntax': [
+          'error',
+          { version: supportedNodeVersion },
+        ],
+        'node/no-unsupported-features/node-builtins': [
+          'error',
+          { version: supportedNodeVersion },
+        ],
+      },
+    },
+  ],
+};

.gitignore

@@ -6,3 +6,4 @@ coverage
 dist
 .idea
 .vscode
+wallaby.config.js

.npmrc

@@ -1 +1,2 @@
-"package-lock=false" 
+package-lock=false
+save-exact=false

.prettierignore

@@ -0,0 +1,10 @@
+node_modules
+*.log
+.nyc_output
+coverage
+flow-typed
+*.DS_Store
+dist
+.idea
+.vscode
+*.md

.travis.yml

@@ -5,10 +5,14 @@ cache: yarn
 branches:
   only:
     - master
+    - v6
 matrix:
   include:
-    - node_js: "4"
-    - node_js: "6"
-    - node_js: "8"
-      after_success: "bash <(curl -s https://codecov.io/bash)"
-    - node_js: "10"
+    - node_js: '8'
+    - node_js: '10'
+      after_success: 'bash <(curl -s https://codecov.io/bash)'
+    - node_js: '12'
+install:
+  - yarn install --frozen-lockfile
+script:
+  - yarn run check:all

.yarnrc

@@ -0,0 +1,2 @@
+save-prefix "^"
+--no-lockfile true

CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 6.0.0
+
+- **Breaking change:** The package now has named exports. See examples below.
+- **Breaking change:** 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()`.
+
+  ```js
+  // 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 change:** Remove support for Node 4 and 6. Requires Node 8+.
+- **Breaking change:** Use npm package [yaml](https://www.npmjs.com/package/yaml) to parse YAML instead of npm package [js-yaml](https://www.npmjs.com/package/js-yaml).
+- **Breaking change:** Remove `cosmiconfig.loaders` and add named export `defaultLoaders` that exports the default loaders used for each extension.
+
+  ```js
+  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.
+
 ## 5.2.1
 
 - Chore: Upgrade `js-yaml` to avoid npm audit warning.