Feature/restrict config (#1)

* [Chore] ignore dist folder

* [Feat::config] add some rules & regex to restrict commit message

Author: Mistructure

.gitignore

@@ -1,3 +1,6 @@
 # deps
 node_modules
-packages/**/node_modules
+packages/**/node_modules
+
+# dist
+dist

package.json

@@ -24,4 +24,4 @@
     "commitlint-wizardoc-e2e-tests"
   ],
   "dependencies": {}
-}
+}

packages/commitlint-config-wizardoc/dist/index.d.ts

@@ -1,11 +1,3 @@
-import { LexicalElement } from "./typings";
-declare const config: {
-    parserOpts: {
-        headerPattern: RegExp;
-        headerCorrespondence: LexicalElement[];
-    };
-    rules: {
-        "body-leading-blank": (string | number)[];
-    };
-};
+import { UserConfig } from "@commitlint/types";
+declare const config: UserConfig;
 export = config;

packages/commitlint-config-wizardoc/dist/index.js

@@ -1,16 +1,30 @@
 "use strict";
-const typings_1 = require("./typings");
+const constants_1 = require("./constants");
+const enum_1 = require("./utils/enum");
 const config = {
-    parserOpts: {
-        headerPattern: /^\[(\w*)::(\w*)\]\s(.*)$/,
-        headerCorrespondence: [
-            typings_1.LexicalElement.TYPE,
-            typings_1.LexicalElement.SCOPE,
-            typings_1.LexicalElement.SUBJECT,
-        ],
+    parserPreset: {
+        name: "",
+        path: "",
+        parserOpts: {
+            headerPattern: constants_1.CONVERSION_MATCH_REGEX,
+            headerCorrespondence: [
+                constants_1.LexicalElement.TYPE,
+                constants_1.LexicalElement.SCOPE,
+                constants_1.LexicalElement.SUBJECT,
+            ],
+        },
     },
     rules: {
-        "body-leading-blank": [1, "always"],
+        // 'subject-exclamation-mark': [2, 'never'],
+        "footer-leading-blank": [1, "always"],
+        "header-max-length": [2, "always", 72],
+        // 'scope-case': [2, 'always', 'lower-case'],
+        "subject-case": [2, "never", ["upper-case"]],
+        // 'subject-empty': [2, 'never'],
+        "subject-full-stop": [2, "never", "."],
+        "type-empty": [2, "never"],
+        "scope-empty": [1, "never"],
+        "type-enum": [2, "always", enum_1.enumerateValues(constants_1.CommitType)],
     },
 };
 module.exports = config;

packages/commitlint-config-wizardoc/dist/typings.d.ts

@@ -5,5 +5,11 @@
   "license": "MIT",
   "scripts": {
     "compile": "tsc"
-  }
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^12.1.4",
+    "@commitlint/parse": "^12.1.4",
+    "@commitlint/types": "^12.1.4"
+  },
+  "dependencies": {}
 }

packages/commitlint-config-wizardoc/dist/typings.js

@@ -0,0 +1,22 @@
+export enum LexicalElement {
+  SUBJECT = "subject",
+  TYPE = "type",
+  SCOPE = "scope",
+  TICKET = "ticket",
+}
+
+export enum CommitType {
+  FEAT = "Feat",
+  INIT = "Init",
+  REMOVE = "Remove",
+  DELETE = "Delete",
+  MOVE = "Move",
+  NEW = "New",
+  ADD = "Add",
+  PATCH = "Patch",
+  FIX = "Fix",
+  TEST = "Test",
+  STUB = "Stub",
+}
+
+export const CONVERSION_MATCH_REGEX = /^\[(\w+?)(?:\:\:(\w*))?\]\s(.*)$/;

packages/commitlint-config-wizardoc/package.json

@@ -1,16 +1,35 @@
-import { LexicalElement } from "./typings";
+import {
+  LexicalElement,
+  CommitType,
+  CONVERSION_MATCH_REGEX,
+} from "./constants";
+import { UserConfig } from "@commitlint/types";
+import { enumerateValues } from "./utils/enum";
 
-const config = {
-  parserOpts: {
-    headerPattern: /^\[(\w*)::(\w*)\]\s(.*)$/,
-    headerCorrespondence: [
-      LexicalElement.TYPE,
-      LexicalElement.SCOPE,
-      LexicalElement.SUBJECT,
-    ],
+const config: UserConfig = {
+  parserPreset: {
+    name: "",
+    path: "",
+    parserOpts: {
+      headerPattern: CONVERSION_MATCH_REGEX,
+      headerCorrespondence: [
+        LexicalElement.TYPE,
+        LexicalElement.SCOPE,
+        LexicalElement.SUBJECT,
+      ],
+    },
   },
   rules: {
-    "body-leading-blank": [1, "always"],
+    // 'subject-exclamation-mark': [2, 'never'],
+    "footer-leading-blank": [1, "always"],
+    "header-max-length": [2, "always", 72],
+    // 'scope-case': [2, 'always', 'lower-case'],
+    "subject-case": [2, "never", ["upper-case"] as any],
+    // 'subject-empty': [2, 'never'],
+    "subject-full-stop": [2, "never", "."],
+    "type-empty": [2, "never"],
+    "scope-empty": [1, "never"],
+    "type-enum": [2, "always", enumerateValues(CommitType)],
   },
 };