chore(core): added commitlint

typedoc2md · Apr 28, 2024 · 6860888 · 6860888
1 parent ce8756a
commit 6860888
Show file tree

Hide file tree

Showing 5 changed files with 1,283 additions and 14 deletions.
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx commitlint --edit ${1}
diff --git a/README.md b/README.md
@@ -6,26 +6,26 @@ This project is a collection of packages designed for generate TypeScript API do
 
 Please visit the [undefined](undefined) for comprehensive documentation, including options and usage guides.
 
-## Packages
-
-| Package | Badges | 
-| :---| :---|
-[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown) | 
-[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | ![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc) | 
-[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme) | 
-[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter) | 
-[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme) | 
-[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | ![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme) | 
-[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-remark%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark) | 
+## Packages 1d
+
+| Package                                                                    | Badges                                                                                                                                                  |
+| :------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme)       | ![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-markdown)       |
+| [docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme)   | ![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/docusaurus-plugin-typedoc)   |
+| [typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme)   | ![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-github-wiki-theme)   |
+| [typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | ![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-frontmatter) |
+| [typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme)       | ![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-vitepress-theme)       |
+| [typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme)   | ![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-gitlab-wiki-theme)   |
+| [typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme)           | ![npm](https://img.shields.io/npm/v/typedoc-plugin-remark%2Fnext?&logo=npm) ![Downloads](https://img.shields.io/npm/dm/typedoc-plugin-remark)           |
 
 ## Examples
 
 Please see the [examples repository](https://github.com/tgreyuk/typedoc-plugin-markdown-examples).
 
-## Contributing
+## Contributing x
 
 If you would like to contribute towards this project please read the [contributing guide](./CONTRIBUTING.md).
 
 ## License
 
-Released under the [MIT License](./LICENSE).
+Released under the [MIT License](./LICENSE).
diff --git a/commitlint.config.cjs b/commitlint.config.cjs
@@ -0,0 +1,26 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+
+  rules: {
+    'type-enum': [2, 'always', ['chore', 'docs', 'feat', 'fix', 'test']],
+    'scope-empty': [2, 'never'],
+    'scope-enum': [
+      2,
+      'always',
+      [
+        'core',
+        'frontmatter',
+        'remark',
+        'docusaurus',
+        'vitepress',
+        'githubwiki',
+        'gitlabwiki',
+        'docs',
+        'refactor',
+        'quality',
+      ],
+    ],
+  },
+
+  ignores: [(commit) => commit.startsWith('Version Packages')],
+};