chore: Setup commit-lint config initially

Author: thomasv

.editorconfig

@@ -0,0 +1,11 @@
+# This file is for unifying the coding style for different editors and IDEs
+# editorconfig.org
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true

.gitignore

@@ -0,0 +1,18 @@
+# Node artifact files
+node_modules/
+
+# JetBrains IDE
+.idea/
+
+# Unit test reports
+coverage/
+test-reports/
+
+# Generated by MacOS
+.DS_Store
+
+# Generated by Windows
+Thumbs.db
+
+# Builds
+dist/

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 

README.md

@@ -0,0 +1,30 @@
+# HDNET commitlint-config
+
+This packages defines the strict implementation of the HDNET Commit Message Guidelines 
+from the HDNET Standard Recommendations 
+([HSR-3](https://wiki.hdnet.de/display/OPS/HSR-3%3A+Git+Commit-Messages)) as npm package
+using [commitlint](https://commitlint.js.org/) 
+through a [shareable config](https://commitlint.js.org/#/concepts-shareable-config). 
+
+## Getting started
+
+1. Make sure you setup node >= 14
+
+2. Install dependencies
+```bash
+$ npm i -D @commitlint/cli @hdnet/commitlint-config
+```
+
+3. Create commitlint config (i.e. `commitlint.config.js`) and extend from @hdnet/commitlint-config:
+```javascript
+module.exports = {
+    extends: '@hdnet',
+
+    parserPreset: {
+        parserOpts: {
+            // replace "PROJECT-" with your issue prefix
+            issuePrefixes: ['PROJECT-'],
+        },
+    },
+}
+```

commitlint.config.js

@@ -0,0 +1,13 @@
+const { rules } = require('./index.js')
+
+module.exports = {
+    extends: '@commitlint/config-conventional',
+
+    parserPreset: {
+        parserOpts: {
+            issuePrefixes: ['#'],
+        },
+    },
+
+    rules,
+}

index.js

@@ -0,0 +1,34 @@
+module.exports = {
+    /**
+     * The base are the conventional commit definitions
+     * @see https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/config-conventional/index.js
+     */
+    extends: ['@commitlint/config-conventional'],
+
+    /**
+     * Main documentation of HDNET's HSR-3 (Git Commit Messages)
+     */
+    helpUrl: 'https://wiki.hdnet.de/display/OPS/HSR-3%3A+Git+Commit-Messages',
+
+    /**
+     * Adapting rules for HSR-3
+     * @see https://commitlint.js.org/#/reference-rules
+     */
+    rules: {
+        // Warn when missing project key is missing, but do not enforce (there may be cases without existing key).
+        'references-empty': [1, 'never'],
+
+        // Scopes with multiple words should be separated consistently
+        'scope-case': [2, 'always', 'kebab-case'],
+
+        // Subjects are sentences and begin uppercase
+        'subject-case': [2, 'always', ['sentence-case']],
+
+        // Need of more types like: "dx"
+        'type-enum': [
+            2,
+            'always',
+            ['build', 'chore', 'ci', 'docs', 'dx', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test'],
+        ],
+    },
+}