chore(commitlint): updating commitlint configuration

Adjusting the commitlint configuration for the new commit strategy.

Every commit has to follow the structure of `$type($project/$projectScope): $subject`

e.g. We added a feature to Button component in Clarity Core.
The commit message will look like `feat(core/button): added a feature x.y.z`

Signed-off-by: Bogdan Bogdanov <[email protected]>

Author: bbogdanov

commitlint.config.js

@@ -1,60 +1,141 @@
-const scopes = [
-  'a11y',
-  'accordion',
-  'alert',
-  'badge',
-  'breadcrumb',
-  'build',
-  'button',
-  'card',
-  'checkbox',
-  'color',
-  'combobox',
-  'datagrid',
-  'datalist',
-  'date-picker',
-  'dropdown',
-  'form',
-  'form-group',
-  'grid',
-  'header',
-  'i18n',
-  'input',
-  'label',
-  'list',
-  'login',
-  'modal',
-  'navigation',
-  'pagination',
-  'password',
-  'progress-bar',
-  'radio',
-  'schematics',
-  'select',
-  'sidenav',
-  'signpost',
-  'spinner',
-  'stack-view',
-  'stepper',
-  'table',
-  'tabs',
-  'textarea',
-  'timeline',
-  'toggle',
-  'tooltip',
-  'tree-view',
-  'vertical-nav',
-  'wizard',
-  'icons',
-  'range',
-  'website',
-  'panel',
-];
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+
+const { resolve } = require('path');
+const commitLintConfig = require('@commitlint/config-conventional');
+
+const core = require('./scripts/commitlint/coreScopes');
+const angular = require('./scripts/commitlint/angularScopes');
+const website = require('./scripts/commitlint/websiteScopes');
+const packages = require('./scripts/commitlint/packagesScopes');
+const custom = require('./scripts/commitlint/customScopes');
+
+const coreScopes = core.getScopes(resolve(process.cwd(), './packages/core'));
+const angularScopes = angular.getScopes(resolve(process.cwd(), './packages/angular'));
+const websiteScopes = website.getScopes(resolve(process.cwd(), './apps/website'));
+const packagesScopes = packages.getScopes(resolve(process.cwd(), './packages'));
+const customScopes = custom.getScopes();
+
+const scopes = new Set([...customScopes, ...coreScopes, ...angularScopes, ...websiteScopes, ...packagesScopes]);
+
+// Merging what @commitlint/config-convensional has with our new two types of commit
+const types = ['a11y', 'release'].concat(commitLintConfig.rules['type-enum'][2]);
 
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'scope-enum': [2, 'always', scopes],
+    'scope-enum': [2, 'always', [...scopes]],
+    'type-enum': [2, 'always', types],
     'header-max-length': [2, 'always', 100],
   },
+  prompt: {
+    messages: {
+      skip: ':skip',
+      max: 'upper %d chars',
+      min: '%d chars at least',
+      emptyWarning: 'can not be empty',
+      upperLimitWarning: 'over limit',
+      lowerLimitWarning: 'below limit',
+    },
+    questions: {
+      type: {
+        description: "Select the type of change that you're committing:",
+        enum: {
+          a11y: {
+            description: 'Commit that provides Accessibility change',
+            title: 'Accessibility',
+            emoji: '♿️',
+          },
+          release: {
+            description: 'Commit that specifies a release',
+            title: 'Release',
+            emoji: '🏭',
+          },
+          feat: {
+            description: 'A new feature',
+            title: 'Features',
+            emoji: '✨',
+          },
+          fix: {
+            description: 'A bug fix',
+            title: 'Bug Fixes',
+            emoji: '🐞',
+          },
+          docs: {
+            description: 'Documentation only changes',
+            title: 'Documentation',
+            emoji: '📚',
+          },
+          style: {
+            description:
+              'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
+            title: 'Styles',
+            emoji: '💎',
+          },
+          refactor: {
+            description: 'A code change that neither fixes a bug nor adds a feature',
+            title: 'Code Refactoring',
+            emoji: '📦',
+          },
+          perf: {
+            description: 'A code change that improves performance',
+            title: 'Performance Improvements',
+            emoji: '🚀',
+          },
+          test: {
+            description: 'Adding missing tests or correcting existing tests',
+            title: 'Tests',
+            emoji: '🚨',
+          },
+          build: {
+            description:
+              'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
+            title: 'Builds',
+            emoji: '🛠',
+          },
+          ci: {
+            description:
+              'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
+            title: 'Continuous Integrations',
+            emoji: '🤖',
+          },
+          chore: {
+            description: "Other changes that don't modify src or test files",
+            title: 'Chores',
+            emoji: '🧹',
+          },
+          revert: {
+            description: 'Reverts a previous commit',
+            title: 'Reverts',
+            emoji: '🗑',
+          },
+        },
+      },
+      scope: {
+        description: 'What is the scope of this change (e.g. core/alert )',
+      },
+      body: {
+        description: 'Provide a GitHub issue or explanation what this change does if the commit message is not enough',
+      },
+      isBreaking: {
+        description: 'Are there any breaking changes?',
+      },
+      breakingBody: {
+        description: 'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself',
+      },
+      breaking: {
+        description: 'Describe the breaking changes',
+      },
+      isIssueAffected: {
+        description: 'Does this change affect any open issues?',
+      },
+      issuesBody: {
+        description:
+          'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself',
+      },
+      issues: {
+        description: 'Add issue references (e.g. "fix #123", "re #123".)',
+      },
+    },
+  },
 };

package.json

@@ -32,6 +32,7 @@
     ]
   },
   "scripts": {
+    "commit": "git-cz",
     "ng": "ng",
     "clean:modules": "del ./**/node_modules",
     "clean": "del ./dist && yarn run schematics:clean",
@@ -106,8 +107,10 @@
     "eslint-rule:test": "yarn --cwd packages/eslint-plugin-clarity-adoption test"
   },
   "devDependencies": {
-    "@commitlint/cli": "8.0.0",
-    "@commitlint/config-conventional": "8.0.0",
+    "@commitlint/cli": "^13.0.0",
+    "@commitlint/config-conventional": "^13.0.0",
+    "@commitlint/prompt": "^13.0.0",
+    "commitizen": "^4.2.4",
     "@types/node": "^12.11.1",
     "@typescript-eslint/eslint-plugin": "2.27.0",
     "@typescript-eslint/parser": "2.27.0",
@@ -146,6 +149,11 @@
     "ts-node": "8.2.0",
     "typescript": "3.7.5"
   },
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/prompt"
+    }
+  },
   "engines": {
     "node": ">=14 <15",
     "yarn": ">=1.22.4 <2",

scripts/commitlint/angularScopes.js

@@ -0,0 +1,56 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+
+const components = [
+  'accordion',
+  'alert',
+  'badge',
+  'breadcrumb',
+  'button',
+  'card',
+  'checkbox',
+  'combobox',
+  'datagrid',
+  'datalist',
+  'date-picker',
+  'dropdown',
+  'form-group',
+  'form',
+  'grid',
+  'header',
+  'i18n',
+  'icon',
+  'input',
+  'label',
+  'list',
+  'login',
+  'modal',
+  'navigation',
+  'pagination',
+  'panel',
+  'password',
+  'progress-bar',
+  'radio',
+  'range',
+  'select',
+  'sidenav',
+  'signpost',
+  'spinner',
+  'stack-view',
+  'stepper',
+  'table',
+  'tabs',
+  'textarea',
+  'timeline',
+  'toggle',
+  'tooltip',
+  'tree-view',
+  'vertical-nav',
+  'wizard',
+];
+
+module.exports = {
+  components,
+  getScopes: () => {
+    return components.map(c => `angular/${c}`).concat(['angular']);
+  },
+};

scripts/commitlint/common.js

@@ -0,0 +1,40 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+const { readdirSync } = require('fs');
+
+/**
+ * Searches for scopes based on predicate
+ *
+ * @param {String} path of folder
+ * @param {Function} predicate that will verify the folder is a scope one
+ * @param {Boolean} topLevel continues with next direct child directory if the predicate is met
+ *
+ * @returns {Array<string>} all scope names
+ */
+const findScopes = (path, predicate, topLevel) => {
+  let scopes = [];
+
+  const dir = readdirSync(path, { withFileTypes: true });
+
+  dir
+    .filter(x => x.isDirectory())
+    .filter(x => x.name !== 'node_modules')
+    .forEach(element => {
+      const elementPath = `${path}/${element.name}`;
+
+      if (predicate(elementPath)) {
+        scopes.push(element.name);
+      }
+
+      if (topLevel) {
+        return;
+      }
+
+      scopes = scopes.concat(findScopes(elementPath, predicate));
+    });
+
+  return scopes;
+};
+
+module.exports = {
+  findScopes,
+};

scripts/commitlint/coreScopes.js

@@ -0,0 +1,29 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+const { readdirSync } = require('fs');
+const { findScopes } = require('./common');
+
+const isScopeDirectory = directory => {
+  const dir = readdirSync(directory, { withFileTypes: true });
+
+  const isScope = dir.find(el => el.isFile() && el.name.includes('.element.ts'));
+
+  if (isScope) {
+    return true;
+  }
+
+  return false;
+};
+
+module.exports = {
+  getScopes: coreProjectPath => {
+    const elements = findScopes(`${coreProjectPath}/src`, isScopeDirectory);
+
+    const core = elements.map(x => `core/${x}`);
+    const react = elements.map(x => `react/${x}`);
+
+    const design = findScopes(`${coreProjectPath}/src/styles`, () => true).map(x => `core/${x}`);
+
+    return new Set([...core, ...react, ...design, 'core', 'react']);
+  },
+};

scripts/commitlint/customScopes.js

@@ -0,0 +1,42 @@
+/* eslint-disable @typescript-eslint/explicit-function-return-type */
+const { readFileSync } = require('fs');
+const { resolve } = require('path');
+
+const getJsonData = path => {
+  const json = readFileSync(path, 'utf8');
+
+  try {
+    return JSON.parse(json);
+  } catch {
+    throw new Error(`${path} has invalid syntax`);
+  }
+};
+
+const generateCommitLintScopes = projects => {
+  let _scopes = [];
+
+  Object.entries(projects).forEach(([project, scopes]) => {
+    const projectScopes = scopes.map(scope => `${project}/${scope}`);
+    _scopes = _scopes.concat([project, ...projectScopes]);
+  });
+
+  return _scopes;
+};
+
+const getScopes = path => {
+  if (!path) {
+    path = resolve(process.cwd(), './scripts/commitlint/customScopes.json');
+  }
+
+  const scopes = getJsonData(path);
+
+  if (scopes) {
+    return new Set(generateCommitLintScopes(scopes));
+  }
+
+  return new Set([]);
+};
+
+module.exports = {
+  getScopes,
+};