From f6564d27af38cabfb69b1f43d03d8e1c670a4ea1 Mon Sep 17 00:00:00 2001 From: Himanshu Mehta Date: Sat, 9 Oct 2021 12:17:39 +0530 Subject: [PATCH 1/3] feat(load): add support for `*.cjs` files --- @commitlint/load/src/utils/load-config.ts | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/@commitlint/load/src/utils/load-config.ts b/@commitlint/load/src/utils/load-config.ts index ee5759aaa3..1663e38f17 100644 --- a/@commitlint/load/src/utils/load-config.ts +++ b/@commitlint/load/src/utils/load-config.ts @@ -15,15 +15,22 @@ export async function loadConfig( const moduleName = 'commitlint'; const explorer = cosmiconfig(moduleName, { searchPlaces: [ + // since cosmiconfig overrides default searchPlaces if any new search place is added (For e.g. `*.ts` files), + // we need to manually merge default searchPlaces + // available at https://github.com/davidtheclark/cosmiconfig#searchplaces 'package.json', `.${moduleName}rc`, `.${moduleName}rc.json`, `.${moduleName}rc.yaml`, `.${moduleName}rc.yml`, - `.${moduleName}rc.ts`, `.${moduleName}rc.js`, - `${moduleName}.config.ts`, + `.${moduleName}rc.cjs`, `${moduleName}.config.js`, + `${moduleName}.config.cjs`, + + // files supported by TypescriptLoader + `.${moduleName}rc.ts`, + `${moduleName}.config.ts`, ], loaders: { '.ts': TypeScriptLoader, From e7e0313326f53ae852c8b9329fd8872966826e96 Mon Sep 17 00:00:00 2001 From: Himanshu Mehta Date: Sat, 9 Oct 2021 12:20:55 +0530 Subject: [PATCH 2/3] chore(load): improve comment in searchPlaces --- @commitlint/load/src/utils/load-config.ts | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/@commitlint/load/src/utils/load-config.ts b/@commitlint/load/src/utils/load-config.ts index 1663e38f17..5fb34d6f66 100644 --- a/@commitlint/load/src/utils/load-config.ts +++ b/@commitlint/load/src/utils/load-config.ts @@ -15,9 +15,8 @@ export async function loadConfig( const moduleName = 'commitlint'; const explorer = cosmiconfig(moduleName, { searchPlaces: [ - // since cosmiconfig overrides default searchPlaces if any new search place is added (For e.g. `*.ts` files), - // we need to manually merge default searchPlaces - // available at https://github.com/davidtheclark/cosmiconfig#searchplaces + // cosmiconfig overrides default searchPlaces if any new search place is added (For e.g. `*.ts` files), + // we need to manually merge default searchPlaces from https://github.com/davidtheclark/cosmiconfig#searchplaces 'package.json', `.${moduleName}rc`, `.${moduleName}rc.json`, From 088341e4482c1dced8f5d97ecf9b97e2e1fa9cfd Mon Sep 17 00:00:00 2001 From: Himanshu Mehta Date: Sat, 9 Oct 2021 12:33:00 +0530 Subject: [PATCH 3/3] docs: update supported configs list in README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a89951949..90f33fadae 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,18 @@ Check the [husky documentation](https://typicode.github.io/husky/#/?id=manual) o ## Config -- Configuration is picked up from `commitlint.config.js`, `.commitlintrc.js`, `.commitlintrc`, `.commitlintrc.json`, `.commitlintrc.yml` file or a `commitlint` field in `package.json` +- Configuration is picked up from: + - `.commitlintrc` + - `.commitlintrc.json` + - `.commitlintrc.yaml` + - `.commitlintrc.yml` + - `.commitlintrc.js` + - `.commitlintrc.cjs` + - `.commitlintrc.ts` + - `commitlint.config.js` + - `commitlint.config.cjs` + - `commitlint.config.ts` + - `commitlint` field in `package.json` - Packages: [cli](./@commitlint/cli), [core](./@commitlint/core) - See [Rules](./docs/reference-rules.md) for a complete list of possible rules - An example configuration can be found at [@commitlint/config-conventional](./@commitlint/config-conventional/index.js)