Merge branch 'master' of https://github.com/conventional-changelog/commitlint

Author: curly210102

@commitlint/cli/src/cli.ts

@@ -292,7 +292,7 @@ function getEditValue(flags: CliFlags) {
 	if (flags.env) {
 		if (!(flags.env in process.env)) {
 			throw new Error(
-				`Recieved '${flags.env}' as value for -E | --env, but environment variable '${flags.env}' is not available globally`
+				`Received '${flags.env}' as value for -E | --env, but environment variable '${flags.env}' is not available globally`
 			);
 		}
 		return process.env[flags.env];

@commitlint/config-conventional/README.md

@@ -152,11 +152,6 @@ echo "fix: some message" # passes
 - **condition**: `footer` should have a leading blank line
 - **rule**: `always`
 - level: `warning`
-- **value**
-
-```
-100
-```
 
 ```sh
 echo "fix: some message
@@ -195,11 +190,6 @@ but still no line is too long" # passes
 - **condition**: `body` should have a leading blank line
 - **rule**: `always`
 - level: `warning`
-- **value**
-
-```js
-100;
-```
 
 ```sh
 echo "fix: some message

@commitlint/config-lerna-scopes/fixtures/modules/lerna.json

@@ -0,0 +1,5 @@
+{
+  "lerna": "4",
+  "version": "1.0.0",
+  "packages": ["packages/*"]
+}

@commitlint/config-lerna-scopes/fixtures/modules/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "basic",
+  "version": "1.0.0",
+  "devDependencies": {
+    "lerna": "^4.0.0"
+  }
+}

@commitlint/config-lerna-scopes/fixtures/modules/packages/a/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "a",
+  "version": "1.0.0"
+}

@commitlint/config-lerna-scopes/fixtures/modules/packages/module/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

@commitlint/config-lerna-scopes/index.js

@@ -49,6 +49,7 @@ function getPackages(context) {
 		.then((packages) => {
 			return packages
 				.map((pkg) => pkg.name)
+				.filter(Boolean)
 				.map((name) => (name.charAt(0) === '@' ? name.split('/')[1] : name));
 		});
 }

@commitlint/config-lerna-scopes/index.test.js

@@ -60,6 +60,14 @@ test('returns expected value for basic lerna repository', async () => {
 	expect(value).toEqual(['a', 'b']);
 });
 
+test('returns expected value for lerna repository containing modules', async () => {
+	const {'scope-enum': fn} = config.rules;
+	const cwd = await lerna.bootstrap('modules', __dirname);
+
+	const [, , value] = await fn({cwd});
+	expect(value).toEqual(['a']);
+});
+
 test('returns expected value for scoped lerna repository', async () => {
 	const {'scope-enum': fn} = config.rules;
 	const cwd = await lerna.bootstrap('scoped', __dirname);

@commitlint/config-lerna-scopes/package.json

@@ -35,7 +35,7 @@
     "globby": "^11.0.1",
     "import-from": "3.0.0",
     "resolve-pkg": "2.0.0",
-    "semver": "7.3.4"
+    "semver": "7.3.5"
   },
   "devDependencies": {
     "@commitlint/test": "^12.1.0",

@commitlint/is-ignored/package.json

@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@commitlint/types": "^12.0.1",
-    "semver": "7.3.4"
+    "semver": "7.3.5"
   },
   "gitHead": "70f7f4688b51774e7ac5e40e896cdaa3f132b2bc"
 }

README.md

@@ -112,16 +112,6 @@ npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
 yarn husky add .husky/commit-msg "yarn commitlint --edit $1"
 ```
 
-If the file `.husky/commit-msg` already exists, you can edit the file and put this:
-
-```sh
-# .husky/commit-msg
-# ...
-npx --no-install commitlint --edit $1
-# or
-yarn commitlint --edit $1
-```
-
 **Detailed Setup instructions**
 
 - [Local setup](https://conventional-changelog.github.io/commitlint/#/guides-local-setup) - Lint messages on commit with husky

docs/guides-ci-setup.md

@@ -2,7 +2,7 @@
 
 Enforce commit conventions with confidence by linting on your CI servers with `commitlint`.
 
-This guide assumes you have a already configured `commitlint` for local usage.
+This guide assumes you have already configured `commitlint` for local usage.
 
 Follow the [Getting Started](./?id=getting-started) for basic installation and configuration instructions.
 

docs/guides-local-setup.md

@@ -33,19 +33,9 @@ npx husky install
 yarn husky install
 
 # Add hook
-npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"
+npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
 # or
-yarn husky add .husky/commit-msg "yarn commitlint --edit $1"
-```
-
-If the file `.husky/commit-msg` already exists, you can edit the file and put this:
-
-```sh
-# .husky/commit-msg
-# ...
-npx --no-install commitlint --edit $1
-# or
-yarn commitlint --edit $1
+yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'
 ```
 
 ## Test

docs/guides-upgrade.md

@@ -90,7 +90,7 @@ module.exports = {
 }
 ```
 
-Refer to the [Rules Referece](reference-rules.md) for a list of all avaiable configuration options.
+Refer to the [Rules Reference](reference-rules.md) for a list of all available configuration options.
 
 There is also the [#commitlint](https://node-tooling.slack.com/messages/C7M8XJ4RL/) channel on the DevTools Slack workspace. Join us there and we'll do our best to help you with your migration.
 
@@ -165,7 +165,7 @@ echo 'module.exports = {extends: ["@commitlint/config-conventional"]};';
 
 ### Breaking changes
 
-#### Output on succesful commit will be ommited
+#### Output on successful commit will be omitted
 
 - You can use the `--verbose` flag to get positive output
 

docs/reference-rules.md

@@ -402,78 +402,3 @@ Infinity
 ```
 'Signed-off-by:'
 ```
-
-### Deprecated rules
-
-#### body-tense `deprecated`
-
-- **condition**: `body` is verbalized in tense present in `value`
-- **rule**: `always`
-- **value**
-
-```
-['present-imperative']
-```
-
-- **possible values**
-
-```
-[
-  'past-tense', // did
-  'present-imperative', // do
-  'present-participle', // doing
-  'present-third-person' // does
-]
-```
-
-#### footer-tense `deprecated`
-
-- **condition**: `footer` is verbalized in tense present in `value`
-- **rule**: `always`
-- **value**
-
-```
-['present-imperative']
-```
-
-- **possible values**
-
-```
-[
-  'past-tense', // did
-  'present-imperative', // do
-  'present-participle', // doing
-  'present-third-person' // does
-]
-```
-
-#### lang `deprecated`
-
-- **condition**: `subject` is of language `value`
-- **rule**: `always`
-- **value**
-
-```
-eng
-```
-
-#### subject-tense `deprecated`
-
-- **condition**: `subject` is verbalized in tense present in `value`
-- **rule**: `always`
-- **value**
-
-```
-['present-imperative']
-```
-
-- **possible values**
-
-```
-[
-  'past-tense', // did
-  'present-imperative', // do
-  'present-participle', // doing
-  'present-third-person' // does
-]
-```

package.json

@@ -86,8 +86,8 @@
     "@babel/core": "^7.12.10",
     "@babel/preset-env": "^7.12.11",
     "@lerna/project": "4.0.0",
-    "@types/jest": "26.0.20",
-    "@types/node": "12.20.5",
+    "@types/jest": "26.0.21",
+    "@types/node": "12.20.6",
     "@typescript-eslint/eslint-plugin": "^4.1.0",
     "@typescript-eslint/parser": "^4.1.0",
     "docsify-cli": "^4.4.0",
@@ -100,7 +100,7 @@
     "lerna": "^4.0.0",
     "lint-staged": "10.5.4",
     "prettier": "^2.0.5",
-    "ts-jest": "26.5.3",
+    "ts-jest": "26.5.4",
     "typescript": "4.2.3"
   },
   "resolutions": {