Feature/restrict config (#3)

* [Feat::deps] link wizardoc to config package

* [Test::config] add test case for config generator

Author: Mistructure

.gitignore

@@ -3,4 +3,5 @@ node_modules
 packages/**/node_modules
 
 # dist
-dist
+dist
+packages/**/dist

package.json

@@ -12,6 +12,7 @@
   "devDependencies": {
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
+    "@types/jest": "^26.0.23",
     "jest": "^27.0.1",
     "jest-config": "^27.0.1",
     "lerna": "^4.0.0",

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

@@ -7,8 +7,6 @@
     "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/index.js

@@ -0,0 +1,34 @@
+import {
+  LexicalElement,
+  CommitType,
+  CONVERSION_MATCH_REGEX,
+} from "./constants";
+import { UserConfig } from "@commitlint/types";
+import { enumerateValues } from "./utils/enum";
+
+export const config: UserConfig = {
+  parserPreset: {
+    name: "",
+    path: "",
+    parserOpts: {
+      headerPattern: CONVERSION_MATCH_REGEX,
+      headerCorrespondence: [
+        LexicalElement.TYPE,
+        LexicalElement.SCOPE,
+        LexicalElement.SUBJECT,
+      ],
+    },
+  },
+  rules: {
+    // '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)],
+  },
+};

packages/commitlint-config-wizardoc/package.json

@@ -1,36 +1,3 @@
-import {
-  LexicalElement,
-  CommitType,
-  CONVERSION_MATCH_REGEX,
-} from "./constants";
-import { UserConfig } from "@commitlint/types";
-import { enumerateValues } from "./utils/enum";
-
-const config: UserConfig = {
-  parserPreset: {
-    name: "",
-    path: "",
-    parserOpts: {
-      headerPattern: CONVERSION_MATCH_REGEX,
-      headerCorrespondence: [
-        LexicalElement.TYPE,
-        LexicalElement.SCOPE,
-        LexicalElement.SUBJECT,
-      ],
-    },
-  },
-  rules: {
-    // '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)],
-  },
-};
+import { config } from "./config";
 
 export = config;

packages/commitlint-config-wizardoc/src/config.ts

@@ -0,0 +1,8 @@
+import { config } from "../config";
+
+describe("validate config structure", () => {
+  it("should return a correct config", () => {
+    expect(config).toHaveProperty("rules");
+    expect(config).toHaveProperty("parserPreset");
+  });
+});

packages/commitlint-config-wizardoc/src/index.ts

@@ -1,5 +1,3 @@
-const config = require('../commitlint-config-wizardoc/dist/index')
-
 module.exports = {
-  extends: ["./../commitlint-config-wizardoc/dist/index"]
+  extends: ["wizardoc"]
 }

packages/commitlint-config-wizardoc/src/types/index.test.ts

@@ -5,5 +5,8 @@
   "license": "MIT",
   "devDependencies": {
     "zx": "^1.12.0"
+  },
+  "dependencies": {
+    "commitlint-config-wizardoc": "^1.0.0"
   }
 }