Merge pull request #52 from conventional-changelog/master

[pull] master from conventional-changelog:master

Author: ammar-ahmed-butt

@commitlint/config-angular/index.test.js

@@ -64,7 +64,7 @@ test('a leading blank line after header', async () => {
 });
 
 test('an invalid scope', async () => {
-	const result = await lintMessage(`no: no is not not an invalid commit type`);
+	const result = await lintMessage(`no: no is not an invalid commit type`);
 
 	expect(result.valid).toBe(false);
 	expect(result.errors[0].message).toBe(

@commitlint/config-nx-scopes/readme.md

@@ -21,52 +21,64 @@ As an example, the following code demonstrates how to select only applications t
 In your .commitlintrc.js file:
 
 ```javascript
-const {
-  utils: {getProjects},
-} = require('@commitlint/config-nx-scopes');
-
-module.exports = {
-  rules: {
-    'scope-enum': async (ctx) => [
-      2,
-      'always',
-      [
-        ...(await getProjects(
-          ctx,
-          ({name, projectType}) =>
-            !name.includes('e2e') && projectType == 'application'
-        )),
+async function getConfig() {
+  const {
+    default: {
+      utils: {getProjects},
+    },
+  } = await import('@commitlint/config-nx-scopes');
+
+  return {
+    rules: {
+      'scope-enum': async (ctx) => [
+        2,
+        'always',
+        [
+          ...(await getProjects(
+            ctx,
+            ({name, projectType}) =>
+              !name.includes('e2e') && projectType == 'application'
+          )),
+        ],
       ],
-    ],
-  },
-  // . . .
-};
+    },
+    // . . .
+  };
+}
+
+module.exports = getConfig();
 ```
 
 Here is another example where projects tagged with 'stage:end-of-life' are not allowed to be used as the scope for a commit.
 
 In your .commitlintrc.js file:
 
 ```javascript
-const {
-  utils: {getProjects},
-} = require('@commitlint/config-nx-scopes');
-
-module.exports = {
-  rules: {
-    'scope-enum': async (ctx) => [
-      2,
-      'always',
-      [
-        ...(await getProjects(
-          ctx,
-          ({tags}) => !tags.includes('stage:end-of-life')
-        )),
+async function getConfig() {
+  const {
+    default: {
+      utils: {getProjects},
+    },
+  } = await import('@commitlint/config-nx-scopes');
+
+  return {
+    rules: {
+      'scope-enum': async (ctx) => [
+        2,
+        'always',
+        [
+          ...(await getProjects(
+            ctx,
+            ({tags}) => !tags.includes('stage:end-of-life')
+          )),
+        ],
       ],
-    ],
-  },
-  // . . .
-};
+    },
+    // . . .
+  };
+}
+
+module.exports = getConfig();
 ```
 
 ## Examples

@commitlint/format/src/format.test.ts

@@ -35,6 +35,29 @@ test('returns empty summary if verbose', () => {
 	expect(actual).toContain('0 problems, 0 warnings');
 });
 
+test('returns empty summary with full commit message if verbose', () => {
+	const actual = format(
+		{
+			results: [
+				{
+					errors: [],
+					warnings: [],
+					input:
+						'feat(cli): this is a valid header\n\nThis is a valid body\n\nSigned-off-by: tester',
+				},
+			],
+		},
+		{
+			verbose: true,
+			color: false,
+		}
+	);
+
+	expect(actual).toStrictEqual(
+		'⧗   input: feat(cli): this is a valid header\n\nThis is a valid body\n\nSigned-off-by: tester\n✔   found 0 problems, 0 warnings'
+	);
+});
+
 test('returns a correct summary of empty .errors and .warnings', () => {
 	const actualError = format({
 		results: [

@commitlint/format/src/format.ts

@@ -42,9 +42,8 @@ function formatInput(
 
 	const sign = '⧗';
 	const decoration = enabled ? chalk.gray(sign) : sign;
-	const commitText = errors.length > 0 ? input : input.split('\n')[0];
 
-	const decoratedInput = enabled ? chalk.bold(commitText) : commitText;
+	const decoratedInput = enabled ? chalk.bold(input) : input;
 	const hasProblems = errors.length > 0 || warnings.length > 0;
 
 	return options.verbose || hasProblems

Dockerfile.ci

@@ -6,6 +6,7 @@ RUN yarn install && \
     # Commit lint CLI packages
     npm pack @commitlint/cli && \
     npm pack @commitlint/config-validator && \
+    npm pack @commitlint/config-nx-scopes && \
     npm pack @commitlint/ensure && \
     npm pack @commitlint/execute-rule && \
     npm pack @commitlint/format && \

docs/guides/ci-setup.md

@@ -146,6 +146,8 @@ lint:commit:
     entrypoint: ['']
   stage: lint
   script:
+    # Uncomment the next line if you are extending the @commitlint/config-nx-scopes in your commitlint configuration
+    #- npm i -g nx@$(node -pe "require('./package.json').devDependencies.nx")
     - echo "${CI_COMMIT_MESSAGE}" | commitlint
 ```