@anolilab/commitlint-config 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +20 -0
- package/README.md +28 -1
- package/dist/index.d.mts +20 -0
- package/dist/postinstall.d.mts +2 -0
- package/dist/postinstall.js +8 -4
- package/dist/postinstall.js.map +1 -1
- package/dist/postinstall.mjs +8 -4
- package/dist/postinstall.mjs.map +1 -1
- package/package.json +8 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,23 @@
|
|
|
1
|
+
## @anolilab/commitlint-config [1.0.2](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/commitlint-config@1.0.1...@anolilab/commitlint-config@1.0.2) (2023-06-28)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* Update package dependencies versions ([7aec41d](https://github.com/anolilab/javascript-style-guide/commit/7aec41d753081b2cca2f1bb1f7daf1615c6568cb))
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### Dependencies
|
|
11
|
+
|
|
12
|
+
* **@anolilab/package-json-utils:** upgraded to 1.5.1
|
|
13
|
+
|
|
14
|
+
## @anolilab/commitlint-config [1.0.1](https://github.com/anolilab/javascript-style-guide/compare/@anolilab/commitlint-config@1.0.0...@anolilab/commitlint-config@1.0.1) (2023-06-23)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Bug Fixes
|
|
18
|
+
|
|
19
|
+
* fixed wrong package inside postinstall, added info how to use cz ([b74d369](https://github.com/anolilab/javascript-style-guide/commit/b74d36993dd26f59caec74c6e17e6ce96e5f45b7))
|
|
20
|
+
|
|
1
21
|
## @anolilab/commitlint-config 1.0.0 (2023-06-23)
|
|
2
22
|
|
|
3
23
|
|
package/README.md
CHANGED
|
@@ -129,7 +129,7 @@ pnpm add -D husky is-ci
|
|
|
129
129
|
To add a `commit-msg` hook to your project, run the following command:
|
|
130
130
|
|
|
131
131
|
```bash
|
|
132
|
-
|
|
132
|
+
npx husky add .husky/commit-msg 'pnpm commitlint --edit "${1}"'
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
And for `package.json`:
|
|
@@ -185,6 +185,33 @@ husky > commit-msg (node v10.1.0)
|
|
|
185
185
|
1 file changed, 1 insertion(+)
|
|
186
186
|
```
|
|
187
187
|
|
|
188
|
+
## Commitizen
|
|
189
|
+
|
|
190
|
+
When installing this package for the first time, the following shareable configuration `.czrc` is automatically added to your project folder:
|
|
191
|
+
|
|
192
|
+
> Note: If the script detects an existing `.czrc` file, it will not overwrite it.
|
|
193
|
+
|
|
194
|
+
> Note: It can happen that the postinstall script dont run, then you have to add the `.czrc` manually.
|
|
195
|
+
|
|
196
|
+
```json
|
|
197
|
+
{
|
|
198
|
+
"path": "cz-conventional-changelog"
|
|
199
|
+
}
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### Husky
|
|
203
|
+
|
|
204
|
+
To add a `prepare-commit-msg` hook to your project, run the following command:
|
|
205
|
+
|
|
206
|
+
```bash
|
|
207
|
+
npx husky add .husky/prepare-commit-msg 'exec < /dev/tty && npx cz --hook || true'
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
> Why `exec < /dev/tty?` By default, git hooks are not interactive.
|
|
211
|
+
> This command allows the user to use their terminal to interact with Commitizen during the hook.
|
|
212
|
+
|
|
213
|
+
Congratulations! Your repo is Commitizen friendly. Time to flaunt it!
|
|
214
|
+
|
|
188
215
|
## Supported Node.js Versions
|
|
189
216
|
|
|
190
217
|
Libraries in this ecosystem make the best effort to track
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
declare const config: {
|
|
2
|
+
extends: string[];
|
|
3
|
+
ignores: ((commitMessage: string) => boolean)[];
|
|
4
|
+
rules: {
|
|
5
|
+
"body-leading-blank": (string | number)[];
|
|
6
|
+
"body-max-line-length": (string | number)[];
|
|
7
|
+
"footer-leading-blank": (string | number)[];
|
|
8
|
+
"footer-max-line-length": (string | number)[];
|
|
9
|
+
"header-max-length": (string | number)[];
|
|
10
|
+
"scope-case": (string | number)[];
|
|
11
|
+
"subject-case": (string | number | string[])[];
|
|
12
|
+
"subject-empty": (string | number)[];
|
|
13
|
+
"subject-full-stop": (string | number)[];
|
|
14
|
+
"type-case": (string | number)[];
|
|
15
|
+
"type-empty": (string | number)[];
|
|
16
|
+
"type-enum": (string | number | string[])[];
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
export { config as default };
|
package/dist/postinstall.js
CHANGED
|
@@ -5,12 +5,16 @@ var fs = require('fs');
|
|
|
5
5
|
var path = require('path');
|
|
6
6
|
var util = require('util');
|
|
7
7
|
|
|
8
|
-
process.env.CI&&process.exit(0);var
|
|
9
|
-
`);var a=()=>{let o=path.join(packageJsonUtils.projectPath,"commitlint.config.js");return fs.existsSync(o)?(console.warn("\u26A0\uFE0F commitlint.config.js already exists;"),Promise.resolve()):
|
|
10
|
-
extends: ["@commitlint
|
|
8
|
+
process.env.CI&&process.exit(0);var r=util.promisify(fs.writeFile);console.log("Configuring @anolilab/commitlint-config",packageJsonUtils.projectPath,`
|
|
9
|
+
`);var a=()=>{let o=path.join(packageJsonUtils.projectPath,"commitlint.config.js");return fs.existsSync(o)?(console.warn("\u26A0\uFE0F commitlint.config.js already exists;"),Promise.resolve()):r(o,`${packageJsonUtils.packageIsTypeModule?"export default":"module.exports ="} {
|
|
10
|
+
extends: ["@anolilab/commitlint-config"],
|
|
11
|
+
rules: {
|
|
12
|
+
// overwrite rules here
|
|
13
|
+
// or extend rules
|
|
14
|
+
},
|
|
11
15
|
};
|
|
12
16
|
|
|
13
|
-
`,"utf-8")},m=()=>{let o=path.join(packageJsonUtils.projectPath,".czrc");return fs.existsSync(o)?(console.warn("\u26A0\uFE0F .czrc already exists;"),Promise.resolve()):
|
|
17
|
+
`,"utf-8")},m=()=>{let o=path.join(packageJsonUtils.projectPath,".czrc");return fs.existsSync(o)?(console.warn("\u26A0\uFE0F .czrc already exists;"),Promise.resolve()):r(o,`{
|
|
14
18
|
"path": "cz-conventional-changelog"
|
|
15
19
|
}
|
|
16
20
|
|
package/dist/postinstall.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/postinstall.ts"],"names":["packageIsTypeModule","projectPath","existsSync","writeFile","join","promisify","writeFileAsync","writeCommitLintConfig","commitlintPath","writeCzrc","filePath","error"],"mappings":"AAAA,OAAS,uBAAAA,EAAqB,eAAAC,MAAmB,+BACjD,OAAS,cAAAC,EAAY,aAAAC,MAAiB,KACtC,OAAS,QAAAC,MAAY,OACrB,OAAS,aAAAC,MAAiB,OAEtB,QAAQ,IAAI,IAEZ,QAAQ,KAAK,CAAC,EAGlB,IAAMC,EAAiBD,EAAUF,CAAS,EAE1C,QAAQ,IAAI,0CAA2CF,EAAa;AAAA,CAAI,EAKxE,IAAMM,EAAwB,IAAM,CAChC,IAAMC,EAAiBJ,EAAKH,EAAa,sBAAsB,EAE/D,OAAIC,EAAWM,CAAc,GACzB,QAAQ,KAAK,oDAA0C,EAEhD,QAAQ,QAAQ,
|
|
1
|
+
{"version":3,"sources":["../src/postinstall.ts"],"names":["packageIsTypeModule","projectPath","existsSync","writeFile","join","promisify","writeFileAsync","writeCommitLintConfig","commitlintPath","writeCzrc","filePath","error"],"mappings":"AAAA,OAAS,uBAAAA,EAAqB,eAAAC,MAAmB,+BACjD,OAAS,cAAAC,EAAY,aAAAC,MAAiB,KACtC,OAAS,QAAAC,MAAY,OACrB,OAAS,aAAAC,MAAiB,OAEtB,QAAQ,IAAI,IAEZ,QAAQ,KAAK,CAAC,EAGlB,IAAMC,EAAiBD,EAAUF,CAAS,EAE1C,QAAQ,IAAI,0CAA2CF,EAAa;AAAA,CAAI,EAKxE,IAAMM,EAAwB,IAAM,CAChC,IAAMC,EAAiBJ,EAAKH,EAAa,sBAAsB,EAE/D,OAAIC,EAAWM,CAAc,GACzB,QAAQ,KAAK,oDAA0C,EAEhD,QAAQ,QAAQ,GAapBF,EAAeE,EAVN,GAAGR,EAAsB,iBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUb,OAAO,CAC1D,EAKMS,EAAY,IAAM,CACpB,IAAMC,EAAWN,EAAKH,EAAa,OAAO,EAE1C,OAAIC,EAAWQ,CAAQ,GACnB,QAAQ,KAAK,qCAA2B,EAEjC,QAAQ,QAAQ,GASpBJ,EAAeI,EANN;AAAA;AAAA;AAAA;AAAA,EAMyB,OAAO,CACpD,GAGC,SAAY,CACT,GAAI,CACA,MAAMH,EAAsB,EAC5B,MAAME,EAAU,EAEhB,QAAQ,IAAI,4CAAqC,EAGjD,QAAQ,KAAK,CAAC,CAClB,OAASE,EAAP,CACE,QAAQ,IAAI,kCAA2B,EACvC,QAAQ,MAAMA,CAAK,EAGnB,QAAQ,KAAK,CAAC,CAClB,CACJ,GAAG","sourcesContent":["import { packageIsTypeModule, projectPath } from \"@anolilab/package-json-utils\";\nimport { existsSync, writeFile } from \"node:fs\";\nimport { join } from \"node:path\";\nimport { promisify } from \"node:util\";\n\nif (process.env[\"CI\"]) {\n // eslint-disable-next-line unicorn/no-process-exit\n process.exit(0);\n}\n\nconst writeFileAsync = promisify(writeFile);\n\nconsole.log(\"Configuring @anolilab/commitlint-config\", projectPath, \"\\n\");\n\n/**\n * Writes commitlint.config.js if it doesn't exist. Warns if it exists.\n */\nconst writeCommitLintConfig = () => {\n const commitlintPath = join(projectPath, \"commitlint.config.js\");\n\n if (existsSync(commitlintPath)) {\n console.warn(\"⚠️ commitlint.config.js already exists;\");\n\n return Promise.resolve();\n }\n\n const content = `${packageIsTypeModule ? \"export default\" : \"module.exports =\"} {\n extends: [\"@anolilab/commitlint-config\"],\n rules: {\n // overwrite rules here\n // or extend rules\n },\n};\n\n`;\n\n return writeFileAsync(commitlintPath, content, \"utf-8\");\n};\n\n/**\n * Writes .czrc if it doesn't exist. Warns if it exists.\n */\nconst writeCzrc = () => {\n const filePath = join(projectPath, \".czrc\");\n\n if (existsSync(filePath)) {\n console.warn(\"⚠️ .czrc already exists;\");\n\n return Promise.resolve();\n }\n\n const content = `{\n \"path\": \"cz-conventional-changelog\"\n}\n\n`;\n\n return writeFileAsync(filePath, content, \"utf-8\");\n};\n\n// eslint-disable-next-line unicorn/prefer-top-level-await\n(async () => {\n try {\n await writeCommitLintConfig();\n await writeCzrc();\n\n console.log(\"😎 Everything went well, have fun!\");\n\n // eslint-disable-next-line unicorn/no-process-exit\n process.exit(0);\n } catch (error) {\n console.log(\"😬 something went wrong:\");\n console.error(error);\n\n // eslint-disable-next-line unicorn/no-process-exit\n process.exit(1);\n }\n})();\n"]}
|
package/dist/postinstall.mjs
CHANGED
|
@@ -3,12 +3,16 @@ import { writeFile, existsSync } from 'fs';
|
|
|
3
3
|
import { join } from 'path';
|
|
4
4
|
import { promisify } from 'util';
|
|
5
5
|
|
|
6
|
-
process.env.CI&&process.exit(0);var
|
|
7
|
-
`);var a=()=>{let o=join(projectPath,"commitlint.config.js");return existsSync(o)?(console.warn("\u26A0\uFE0F commitlint.config.js already exists;"),Promise.resolve()):
|
|
8
|
-
extends: ["@commitlint
|
|
6
|
+
process.env.CI&&process.exit(0);var r=promisify(writeFile);console.log("Configuring @anolilab/commitlint-config",projectPath,`
|
|
7
|
+
`);var a=()=>{let o=join(projectPath,"commitlint.config.js");return existsSync(o)?(console.warn("\u26A0\uFE0F commitlint.config.js already exists;"),Promise.resolve()):r(o,`${packageIsTypeModule?"export default":"module.exports ="} {
|
|
8
|
+
extends: ["@anolilab/commitlint-config"],
|
|
9
|
+
rules: {
|
|
10
|
+
// overwrite rules here
|
|
11
|
+
// or extend rules
|
|
12
|
+
},
|
|
9
13
|
};
|
|
10
14
|
|
|
11
|
-
`,"utf-8")},m=()=>{let o=join(projectPath,".czrc");return existsSync(o)?(console.warn("\u26A0\uFE0F .czrc already exists;"),Promise.resolve()):
|
|
15
|
+
`,"utf-8")},m=()=>{let o=join(projectPath,".czrc");return existsSync(o)?(console.warn("\u26A0\uFE0F .czrc already exists;"),Promise.resolve()):r(o,`{
|
|
12
16
|
"path": "cz-conventional-changelog"
|
|
13
17
|
}
|
|
14
18
|
|
package/dist/postinstall.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/postinstall.ts"],"names":["packageIsTypeModule","projectPath","existsSync","writeFile","join","promisify","writeFileAsync","writeCommitLintConfig","commitlintPath","writeCzrc","filePath","error"],"mappings":"AAAA,OAAS,uBAAAA,EAAqB,eAAAC,MAAmB,+BACjD,OAAS,cAAAC,EAAY,aAAAC,MAAiB,KACtC,OAAS,QAAAC,MAAY,OACrB,OAAS,aAAAC,MAAiB,OAEtB,QAAQ,IAAI,IAEZ,QAAQ,KAAK,CAAC,EAGlB,IAAMC,EAAiBD,EAAUF,CAAS,EAE1C,QAAQ,IAAI,0CAA2CF,EAAa;AAAA,CAAI,EAKxE,IAAMM,EAAwB,IAAM,CAChC,IAAMC,EAAiBJ,EAAKH,EAAa,sBAAsB,EAE/D,OAAIC,EAAWM,CAAc,GACzB,QAAQ,KAAK,oDAA0C,EAEhD,QAAQ,QAAQ,
|
|
1
|
+
{"version":3,"sources":["../src/postinstall.ts"],"names":["packageIsTypeModule","projectPath","existsSync","writeFile","join","promisify","writeFileAsync","writeCommitLintConfig","commitlintPath","writeCzrc","filePath","error"],"mappings":"AAAA,OAAS,uBAAAA,EAAqB,eAAAC,MAAmB,+BACjD,OAAS,cAAAC,EAAY,aAAAC,MAAiB,KACtC,OAAS,QAAAC,MAAY,OACrB,OAAS,aAAAC,MAAiB,OAEtB,QAAQ,IAAI,IAEZ,QAAQ,KAAK,CAAC,EAGlB,IAAMC,EAAiBD,EAAUF,CAAS,EAE1C,QAAQ,IAAI,0CAA2CF,EAAa;AAAA,CAAI,EAKxE,IAAMM,EAAwB,IAAM,CAChC,IAAMC,EAAiBJ,EAAKH,EAAa,sBAAsB,EAE/D,OAAIC,EAAWM,CAAc,GACzB,QAAQ,KAAK,oDAA0C,EAEhD,QAAQ,QAAQ,GAapBF,EAAeE,EAVN,GAAGR,EAAsB,iBAAmB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUb,OAAO,CAC1D,EAKMS,EAAY,IAAM,CACpB,IAAMC,EAAWN,EAAKH,EAAa,OAAO,EAE1C,OAAIC,EAAWQ,CAAQ,GACnB,QAAQ,KAAK,qCAA2B,EAEjC,QAAQ,QAAQ,GASpBJ,EAAeI,EANN;AAAA;AAAA;AAAA;AAAA,EAMyB,OAAO,CACpD,GAGC,SAAY,CACT,GAAI,CACA,MAAMH,EAAsB,EAC5B,MAAME,EAAU,EAEhB,QAAQ,IAAI,4CAAqC,EAGjD,QAAQ,KAAK,CAAC,CAClB,OAASE,EAAP,CACE,QAAQ,IAAI,kCAA2B,EACvC,QAAQ,MAAMA,CAAK,EAGnB,QAAQ,KAAK,CAAC,CAClB,CACJ,GAAG","sourcesContent":["import { packageIsTypeModule, projectPath } from \"@anolilab/package-json-utils\";\nimport { existsSync, writeFile } from \"node:fs\";\nimport { join } from \"node:path\";\nimport { promisify } from \"node:util\";\n\nif (process.env[\"CI\"]) {\n // eslint-disable-next-line unicorn/no-process-exit\n process.exit(0);\n}\n\nconst writeFileAsync = promisify(writeFile);\n\nconsole.log(\"Configuring @anolilab/commitlint-config\", projectPath, \"\\n\");\n\n/**\n * Writes commitlint.config.js if it doesn't exist. Warns if it exists.\n */\nconst writeCommitLintConfig = () => {\n const commitlintPath = join(projectPath, \"commitlint.config.js\");\n\n if (existsSync(commitlintPath)) {\n console.warn(\"⚠️ commitlint.config.js already exists;\");\n\n return Promise.resolve();\n }\n\n const content = `${packageIsTypeModule ? \"export default\" : \"module.exports =\"} {\n extends: [\"@anolilab/commitlint-config\"],\n rules: {\n // overwrite rules here\n // or extend rules\n },\n};\n\n`;\n\n return writeFileAsync(commitlintPath, content, \"utf-8\");\n};\n\n/**\n * Writes .czrc if it doesn't exist. Warns if it exists.\n */\nconst writeCzrc = () => {\n const filePath = join(projectPath, \".czrc\");\n\n if (existsSync(filePath)) {\n console.warn(\"⚠️ .czrc already exists;\");\n\n return Promise.resolve();\n }\n\n const content = `{\n \"path\": \"cz-conventional-changelog\"\n}\n\n`;\n\n return writeFileAsync(filePath, content, \"utf-8\");\n};\n\n// eslint-disable-next-line unicorn/prefer-top-level-await\n(async () => {\n try {\n await writeCommitLintConfig();\n await writeCzrc();\n\n console.log(\"😎 Everything went well, have fun!\");\n\n // eslint-disable-next-line unicorn/no-process-exit\n process.exit(0);\n } catch (error) {\n console.log(\"😬 something went wrong:\");\n console.error(error);\n\n // eslint-disable-next-line unicorn/no-process-exit\n process.exit(1);\n }\n})();\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@anolilab/commitlint-config",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Anolilab´s shareable coding standard config for commitlint.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"anolilab",
|
|
@@ -52,15 +52,17 @@
|
|
|
52
52
|
"postinstall": "node ./skip.js || node ./dist/postinstall.js"
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
|
-
"@anolilab/package-json-utils": "1.5.
|
|
56
|
-
"@commitlint/config-conventional": "^17.6.
|
|
57
|
-
"@commitlint/core": "^17.6.
|
|
55
|
+
"@anolilab/package-json-utils": "1.5.1",
|
|
56
|
+
"@commitlint/config-conventional": "^17.6.6",
|
|
57
|
+
"@commitlint/core": "^17.6.6",
|
|
58
58
|
"commitizen": "^4.3.0",
|
|
59
|
-
"conventional-changelog-conventionalcommits": "^6.
|
|
59
|
+
"conventional-changelog-conventionalcommits": "^6.1.0",
|
|
60
60
|
"cz-conventional-changelog": "^3.3.0"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|
|
63
|
-
"@commitlint/cli": "^17.6.
|
|
63
|
+
"@commitlint/cli": "^17.6.6",
|
|
64
|
+
"tsup": "^7.1.0",
|
|
65
|
+
"vitest": "^0.32.2"
|
|
64
66
|
},
|
|
65
67
|
"peerDependencies": {
|
|
66
68
|
"@commitlint/cli": "^17.6.5"
|