feat: 🌟 add commitlint config

Author: vanntile

bin/createEdoApp.js

@@ -16,10 +16,11 @@ program
   .option('--silent', 'do not show command prompts', true)
   .option('--with-fetch', 'include node-fetch', true)
   .option('--with-docker', 'include Docker', true)
+  .option('--with-commitlint', 'include commitlint and standard-version', true)
   .action((d) => (directory = d))
   .parse()
 
-const { silent, withFetch, withDocker } = program.opts()
+const { silent, withFetch, withDocker, withCommitlint } = program.opts()
 
 // Run the app
-createEdoApp({ directory, silent, withFetch, withDocker })
+createEdoApp({ directory, silent, withFetch, withDocker, withCommitlint })

config.json

@@ -2,12 +2,14 @@
   "commands": {
     "gitInit": "git init",
     "gitAdd": "git add .",
+    "gitCommit": "git commit -m 'init: :tada: initial commit'",
     "createLocalEnv": "cp .env.example .env",
     "huskyCommands": [
       "npm set-script prepare 'husky install'",
-      "npm run prepare",
+      "npm run prepare --silent",
       "npx husky add .husky/pre-commit 'npx lint-staged'"
-    ]
+    ],
+    "huskyCommitlint": "npx husky add .husky/commit-msg 'npx commitlint --config .commitlintrc.cjs --edit'"
   },
   "dependencies": [
     "express",
@@ -29,7 +31,21 @@
     "husky"
   ],
   "extraDeps": {
-    "fetch": "node-fetch"
+    "fetch": [
+      "node-fetch"
+    ],
+    "commitlint": [
+      "standard-version",
+      "@commitlint/cli",
+      "@commitlint/config-conventional"
+    ]
+  },
+  "extraOptions": {
+    "commitlint": {
+      "scripts": {
+        "release": "standard-version --no-verify --sign"
+      }
+    }
   },
   "options": {
     "author": "",
@@ -53,6 +69,8 @@
     "base": "Added basic source and configuration files",
     "fetch": "Added node-fetch utils",
     "docker": "Added Docker files",
+    "commitlint": "Added commitlintrc",
+    "commitlint_hook": "Added husky commit message hook",
     "npm": "Initialized npm package and installed dependencies",
     "git": "Initialized git repository",
     "env": "Created local .env file",

index.js

@@ -21,17 +21,22 @@ const runCommand = (command) => {
 }
 const runCommands = (commandList) => runCommand(commandList.join(' && '))
 
-module.exports = async ({ directory, silent, withFetch, withDocker }) => {
+module.exports = async ({ directory, silent, withFetch, withDocker, withCommitlint }) => {
   const cd = `cd ${directory}`
 
+  console.log({ silent })
+
   const packageOptions = {
     ...config.options,
     prompt: !silent,
     directory,
     name: directory,
     description: `Project created with ${pkg.name}`,
-    dependencies: [...dependencies, ...(withFetch ? [config.extraDeps.fetch] : [])],
-    devDependencies,
+    dependencies: [...dependencies, ...(withFetch ? config.extraDeps.fetch : [])],
+    devDependencies: [...devDependencies, ...(withCommitlint ? config.extraDeps.commitlint : [])],
+    scripts: withCommitlint
+      ? config.options.scripts
+      : { ...config.options.scripts, ...config.extraOptions.commitlint.scripts },
   }
 
   logStep('start', chalk.cyan(directory))
@@ -49,6 +54,11 @@ module.exports = async ({ directory, silent, withFetch, withDocker }) => {
       await fs.copy(path.join(__dirname, 'templates/docker'), directory)
       logStep('docker')
     }
+
+    if (withCommitlint) {
+      await fs.copy(path.join(__dirname, 'templates/commitlint'), directory)
+      logStep('commitlint')
+    }
   } catch (err) {
     console.error(err)
     return
@@ -57,10 +67,9 @@ module.exports = async ({ directory, silent, withFetch, withDocker }) => {
   await createPackageJson(packageOptions)
   logStep('npm')
 
-  if (runCommands([cd, commands.gitInit])) logStep('git')
+  if (runCommands([cd, `${commands.gitInit} ${silent ? '--quiet' : ''}`])) logStep('git')
   if (runCommands([cd, commands.createLocalEnv])) logStep('env')
   if (runCommands([cd, ...commands.huskyCommands])) logStep('husky')
-
-  const initialCommitCommand = `git commit ${silent ? '--quiet' : ''} -m "init: :tada: initial commit"`
-  if (runCommands([cd, commands.gitAdd, initialCommitCommand])) logStep('commit')
+  if (withCommitlint && runCommands([cd, commands.huskyCommitlint])) logStep('commitlint_hook')
+  if (runCommands([cd, commands.gitAdd, `${commands.gitCommit} ${silent ? '--quiet' : ''}`])) logStep('commit')
 }

templates/commitlint/.commitlintrc.cjs

@@ -0,0 +1,39 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'scope-enum': [
+      2,
+      'always',
+      [
+        'style',
+        'lint',
+        'review',
+        'uiux',
+        'deps',
+        'build',
+        'release',
+        'flags',
+        'logs',
+        'db',
+        'security',
+        'perf',
+        'a11y',
+        'i18n',
+        'typos',
+        'literals',
+        'analytics',
+        'seo',
+        'linux',
+        'windows',
+        'osx',
+        'android',
+        'ios',
+      ],
+    ],
+    'type-enum': [
+      2,
+      'always',
+      ['wip', 'feat', 'fix', 'config', 'refactor', 'revert', 'chore', 'ci', 'assets', 'test', 'docs', 'init'],
+    ],
+  },
+}