feat: implemented

.github/actions/init-npm/action.yaml

@@ -16,6 +16,3 @@ runs:
   - name: Install TS Project dependencies
     shell: bash
     run: npm ci
-  - name: build
-    shell: bash
-    run: npm run build

.github/workflows/pull-request.yaml

@@ -25,7 +25,7 @@ jobs:
         with:
           github_token: ${{ secrets.github_token }}
           # Enable linters
-          eslint: true
+          eslint: false
           prettier: true
           eslint_extensions: ts
 

README.md

@@ -1,5 +1,20 @@
-# ts-npm-package-boilerplate
+# commitlint-config
+Common commitlint configuration for MapColonies projects
 
-After cloning this template, please do the following:
-1. insert secrets to repo secrets for the github actions.
-2. replace every string "ts-npm-package-boilerplate" with your package name.
+## Installation
+To install the package run the following command:
+```bash
+npm install --save-dev @mapcolonies/commitlint-config
+```
+
+## Usage
+To use the package, create a `commitlint.config.js` file in the root of your project and add the following code:
+```javascript
+module.exports = {
+  extends: ['@mapcolonies/commitlint-config'],
+};
+```
+
+## Rules
+This package extends all the rules from the `@commitlint/config-conventional` package and adds the following rules:
+1. The allowed values for the type parameters (feat,fix,chore..) are as follow: `deps`, `helm`, `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test`

commitlint.config.js

@@ -1,6 +1,3 @@
 module.exports = {
-  extends: ['@commitlint/config-conventional'],
-  rules: {
-    'scope-enum': [2, 'always', ['deps', 'configurations']],
-  },
+  extends: ['./index.js'],
 };

index.js

@@ -0,0 +1,9 @@
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [2, 'always', ['deps', 'helm', 'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']],
+  },
+};