fix: added commitlint [macata #31] (#32)

Author: DazedNConfused-

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Java CI
+name: Java Build & Test
 
 on: [push]
 

.github/workflows/codeql.yml

@@ -1,3 +1,5 @@
+name: CodeQL Analysis
+
 on:
   push:
     branches: [ master, develop ]

.github/workflows/commitlint.yml

@@ -0,0 +1,23 @@
+name: Run Commitlint on PR's commits
+
+on:
+  pull_request:
+
+jobs:
+  run-commitlint-on-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+
+      - name: Install Commitlint
+        run: npm install --save-dev @commitlint/{cli,config-conventional}
+
+      - name: Validate all commits from PR using Commitlint
+        run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

.github/workflows/prnamelint.yml

@@ -0,0 +1,25 @@
+name: Run Commitlint on PR's title
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+
+
+jobs:
+  run-commitlint-on-pr:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+
+      - name: Install Commitlint
+        run: npm install --save-dev @commitlint/{cli,config-conventional}
+
+      - name: Validate PR title using Commitlint
+        run: echo ${{ github.event.pull_request.title }} | npx commitlint

.gitignore

@@ -43,4 +43,10 @@ backups
 .macatalauncher
 trashed
 userdir
-mods
+mods
+
+### Husky / CommitLint ###
+node_modules
+package-lock.json
+package.json
+yarn.lock

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

README.md

@@ -29,6 +29,16 @@ MaCata requires Java 11 to run.
 
 Just put the `macatalauncher.jar` in some folder of your choice and double click!
 
+## Build
+
+Just run `mvn package` and a `macatalauncher-x.x.x.jar` binary will be built in the `target` directory.
+
+## Development
+
+Before making changes to the codebase, installing `husky` is encouraged: https://typicode.github.io/husky/get-started.html
+
+While not mandatory, if commits are not properly formatted, they may get rejected by GitHub's `commitlint` action.
+
 ## Features
 
 ### Current
@@ -55,10 +65,6 @@ Just put the `macatalauncher.jar` in some folder of your choice and double click
   - I want to focus mainly on macOS since there are already some excellent launchers for Windows and Linux already.
     - Having said that, given the current launcher architecture, I would like to think it wouldn't be terribly hard to support Linux and/or Windows. Just a couple of changes to the [launcher class](src/main/java/com/dazednconfused/catalauncher/launcher/CDDALauncherManager.java) maybe? PRs welcome!
 
-## Build
-
-Just run `mvn package` and a `macatalauncher-x.x.x.jar` binary will be built in the `target` directory.
-
 ## FAQ
 
 ### Why Yet Another Launcher?

commitlint.config.js

@@ -0,0 +1,27 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    parserPreset: {
+        parserOpts: {
+            headerPattern: /^(\w+)(?:\((\w+)\))?: (.*) \[macata #(\d+)\]$/,
+            headerCorrespondence: ['type', 'scope', 'subject', 'issue'],
+        },
+    },
+    rules: {
+        'type-enum': [2, 'always', [
+            'build',
+            'chore',
+            'ci',
+            'docs',
+            'feat',
+            'fix',
+            'perf',
+            'refactor',
+            'revert',
+            'style',
+            'test',
+            'wip'
+        ] ],
+        'header-max-length': [2, 'always', 100],
+        'references-empty': [2, 'never']
+    },
+};