feat: support .jsonc/json5 config.

jaywcjlove · Jun 2, 2023 · d5f4c9a · d5f4c9a
1 parent 0396a53
commit d5f4c9a
Show file tree

Hide file tree

Showing 9 changed files with 103 additions and 3 deletions.
diff --git a/core/README.md b/core/README.md
@@ -7,6 +7,11 @@ Auto Config Loader
 
 Find and load configuration from a `package.json` property, `rc` file, or `CommonJS` module. It has smart defaults based on traditional expectations in the JavaScript ecosystem. But it's also flexible enough to search anywhere you want and load whatever you want.
 
+## Features
+
+- Support [JSON](https://www.json.org), [JSONC](https://github.com/microsoft/node-jsonc-parser), [JSON5](), [YAML](https://yaml.org/), [TOML](https://toml.io), CJS, [Typescript](https://www.typescriptlang.org/), and ESM config load.
+- Reads config from the nearest `package.json` file
+
 ## Install
 
 ```bash
@@ -18,6 +23,22 @@ $ npm i auto-config-loader
 ```js
 import load from 'auto-config-loader';
 
+// will look for:
+// process.cwd() + '.namespacerc'
+// process.cwd() + '.namespacerc.js'
+// process.cwd() + '.namespacerc.ts'
+// process.cwd() + '.namespacerc.mjs'
+// process.cwd() + '.namespacerc.cjs'
+// process.cwd() + '.namespacerc.json'
+// process.cwd() + '.namespacerc.json5'
+// process.cwd() + '.namespacerc.jsonc'
+// process.cwd() + '.namespacerc.yaml'
+// process.cwd() + '.namespacerc.yml'
+// process.cwd() + '.namespacerc.toml'
+// process.cwd() + 'namespace.config.mjs'
+// process.cwd() + 'namespace.config.cjs'
+// process.cwd() + 'namespace.config.js'
+// ........
 const data = load('namespace', {
   defaults: {
     testItem2: 'some value'
@@ -30,7 +51,7 @@ const data = load('namespace', {
 Load the JS file and return the result, support `.js`, `.cjs`, `.mjs`, `.ts`.
 
 ```js
-// => app.config.js
+// => ./app/app.config.js
 export default {
   name: 'app'
 }
@@ -81,6 +102,8 @@ Discover configurations in the specified directory order. When configuring a too
   'package.json',
   `.${moduleName}rc`,
   `.${moduleName}rc.json`,
+  `.${moduleName}rc.json5`,
+  `.${moduleName}rc.jsonc`,
   `.${moduleName}rc.yaml`,
   `.${moduleName}rc.yml`,
   `.${moduleName}rc.toml`,
@@ -90,6 +113,8 @@ Discover configurations in the specified directory order. When configuring a too
   `.${moduleName}rc.mjs`,
   `.config/${moduleName}rc`,
   `.config/${moduleName}rc.json`,
+  `.config/${moduleName}rc.json5`,
+  `.config/${moduleName}rc.jsonc`,
   `.config/${moduleName}rc.yaml`,
   `.config/${moduleName}rc.yml`,
   `.config/${moduleName}rc.toml`,

diff --git a/core/config-example/ext-json/.autoconfrc.json b/core/config-example/ext-json/.autoconfrc.json
@@ -0,0 +1,3 @@
+{
+  "projectName": "ext-json"
+}
diff --git a/core/config-example/ext-json5/.autoconfrc.json5 b/core/config-example/ext-json5/.autoconfrc.json5
@@ -0,0 +1,14 @@
+{
+  // 注释
+  "projectName": "ext-json",
+  name: 'my-app',
+  // 允许使用十六进制和八进制数值
+  hex: 0x1a,
+  octal: 0o755,
+  // 允许使用 NaN、Infinity 和 -Infinity
+  max: Infinity,
+  min: -Infinity,
+  notANumber: NaN,
+  // 允许使用尾随逗号
+  'react-dom': '^16.13.1',
+}
diff --git a/core/config-example/ext-jsonc/.autoconfrc.jsonc b/core/config-example/ext-jsonc/.autoconfrc.jsonc
@@ -0,0 +1,4 @@
+{
+  // 注释
+  "projectName": "ext-jsonc"
+}
diff --git a/core/package.json b/core/package.json
@@ -21,7 +21,24 @@
     "coverage": "tsbb test --coverage --bail"
   },
   "keywords": [
+    "rc",
     "config",
+    "loader",
+    "load",
+    "configuration",
+    "cjs",
+    "commonjs",
+    "esm",
+    "es module",
+    "yml-config",
+    "js-config",
+    "ts-config",
+    "toml-config",
+    "yml",
+    "js",
+    "ts",
+    "toml",
+    "typescript",
     "config-loader",
     "auto-config-loader"
   ],
@@ -44,6 +61,7 @@
     "jiti": "^1.18.2",
     "lodash.merge": "^4.6.2",
     "sucrase": "^3.32.0",
+    "jsonc-eslint-parser": "^2.3.0",
     "toml-eslint-parser": "^0.6.0",
     "yaml-eslint-parser": "^1.2.2"
   },

diff --git a/core/src/index.ts b/core/src/index.ts
@@ -34,10 +34,12 @@ export interface AutoConfOption<T> {
 export default function autoConf<T>(namespace: string = 'autoconf', option: AutoConfOption<T> = {}) {
   const { searchPlaces = [], defaluts = {}, cwd = process.cwd(), jsOption } = option;
   const loaders: Loader<T> = {
-    '.json': jsonLoader,
     '.yml': yamlLoader,
     '.yaml': yamlLoader,
     '.toml': tomlLoader,
+    '.json': jsonLoader,
+    '.json5': jsonLoader,
+    '.jsonc': jsonLoader,
     '.js': jsLoader,
     '.ts': jsLoader,
     '.cjs': jsLoader,

diff --git a/core/src/loader/jsonloader.ts b/core/src/loader/jsonloader.ts
@@ -1,3 +1,7 @@
+import type { AST } from 'jsonc-eslint-parser';
+import { parseJSON, getStaticJSONValue } from 'jsonc-eslint-parser';
+
 export function jsonLoader<T>(_: string, content: string): T {
-  return JSON.parse(content) as T;
+  const ast: AST.JSONProgram = parseJSON(content);
+  return getStaticJSONValue(ast) as T;
 }
diff --git a/core/src/utils.ts b/core/src/utils.ts
@@ -6,6 +6,8 @@ export function findConfigFile(moduleName: string, root: string, searchPlaces: s
     ...searchPlaces,
     `.${moduleName}rc`,
     `.${moduleName}rc.json`,
+    `.${moduleName}rc.json5`,
+    `.${moduleName}rc.jsonc`,
     `.${moduleName}rc.yaml`,
     `.${moduleName}rc.yml`,
     `.${moduleName}rc.toml`,
@@ -15,6 +17,8 @@ export function findConfigFile(moduleName: string, root: string, searchPlaces: s
     `.${moduleName}rc.mjs`,
     `.config/${moduleName}rc`,
     `.config/${moduleName}rc.json`,
+    `.config/${moduleName}rc.json5`,
+    `.config/${moduleName}rc.jsonc`,
     `.config/${moduleName}rc.yaml`,
     `.config/${moduleName}rc.yml`,
     `.config/${moduleName}rc.toml`,

diff --git a/core/test/config.test.ts b/core/test/config.test.ts
@@ -16,6 +16,32 @@ test('Loader .autoconfrc.json', () => {
   expect(data?.name).toBe('auto-conf');
 });
 
+
+test('Loader .autoconfrc.json', () => {
+  const data = autoConf<{ projectName: string; }>(undefined, {
+    cwd: path.resolve(__dirname, '../config-example/ext-json'),
+  });
+  expect(data?.projectName).toBe('ext-json');
+});
+
+test('Loader .autoconfrc.json5', () => {
+  const data = autoConf<any>(undefined, {
+    cwd: path.resolve(__dirname, '../config-example/ext-json5'),
+  });
+  expect(data?.projectName).toBe('ext-json');
+  expect(data?.name).toBe('my-app');
+  expect(data?.max).toBe(Infinity);
+  expect(data?.min).toBe(-Infinity);
+  expect(data?.notANumber).toBe(NaN);
+});
+
+test('Loader .autoconfrc.jsonc', () => {
+  const data = autoConf<{ projectName: string; }>(undefined, {
+    cwd: path.resolve(__dirname, '../config-example/ext-jsonc'),
+  });
+  expect(data?.projectName).toBe('ext-jsonc');
+});
+
 test('Loader .autoconfrc.js ESM', () => {
   const data = autoConf<{ projectName: string; }>(undefined, {
     cwd: path.resolve(__dirname, '../config-example/js-esm'),