@theholocron/commitlint-config 1.10.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @theholocron/commitlint-config
+
+## 1.10.0
+
+### Minor Changes
+
+- [`16a5369`](https://github.com/theholocron/configs/commit/16a536930746ee06d1eb882181da7b4834359395) Thanks [@iamnewton](https://github.com/iamnewton)! - Testing out publishing
+
+## 0.1.0
+
+### Minor Changes
+
+- [`897b640`](https://github.com/theholocron/configs/commit/897b6402a117e0b1dea3ca7d2cda5acc42ff729d) Thanks [@iamnewton](https://github.com/iamnewton)! - Add CommitLint configuration

package/README.md

@@ -0,0 +1,149 @@
+# CommitLint Config
+
+A [CommitLint configuration](https://commitlint.js.org/#/reference-configuration) for writing well-formatted and consistent Git commits. 
+
+## Installation
+
+```bash
+npm install --save-dev @theholocron/commitlint-config
+```
+
+## Usage
+
+In your project `package.json` add the following:
+
+```json
+{
+  "commitlint": {
+    "extends": "@theholocron"
+  }
+}
+```
+
+## How We Write Commits
+
+### Problems
+
+The following rules are considered problems for `@theholocron/commitlint-config` and will yield a non-zero exit code when not met.
+
+Consult [docs/rules](https://conventional-changelog.github.io/commitlint/#/reference-rules) for a list of available rules.
+
+#### type-enum
+
+- **condition**: `type` is found in value
+- **rule**: `always`
+- **value**
+
+  ```js
+  [
+    'build',
+    'ci',
+    'chore',
+    'docs',
+    'feat',
+    'fix',
+    'perf',
+    'refactor',
+    'revert',
+    'style',
+    'test'
+  ]
+  ```
+
+```sh
+echo "foo: some message" # fails
+echo "fix: some message" # passes
+```
+
+#### type-case
+
+- **description**: `type` is in case `value`
+- **rule**: `always`
+- **value**
+
+  ```js
+    'lowerCase'
+  ```
+
+```sh
+echo "FIX: some message" # fails
+echo "fix: some message" # passes
+```
+
+#### type-empty
+
+- **condition**: `type` is empty
+- **rule**: `never`
+
+```sh
+echo ": some message" # fails
+echo "fix: some message" # passes
+```
+
+#### scope-case
+
+- **condition**: `scope` is in case `value`
+- **rule**: `always`
+
+```js
+  'lowerCase'
+```
+
+```sh
+echo "fix(SCOPE): some message" # fails
+echo "fix(scope): some message" # passes
+```
+
+#### subject-case
+
+- **condition**: `subject` is in one of the cases `['sentence-case', 'start-case', 'pascal-case', 'upper-case']`
+- **rule**: `never`
+
+```sh
+echo "fix(SCOPE): Some message" # fails
+echo "fix(SCOPE): Some Message" # fails
+echo "fix(SCOPE): SomeMessage" # fails
+echo "fix(SCOPE): SOMEMESSAGE" # fails
+echo "fix(scope): some message" # passes
+echo "fix(scope): some Message" # passes
+```
+
+#### subject-empty
+
+- **condition**: `subject` is empty
+- **rule**: `never`
+
+```sh
+echo "fix:" # fails
+echo "fix: some message" # passes
+```
+
+#### subject-full-stop
+
+- **condition**: `subject` ends with `value`
+- **rule**: `never`
+- **value**
+
+```js
+  '.'
+```
+
+```sh
+echo "fix: some message." # fails
+echo "fix: some message" # passes
+```
+
+#### header-max-length
+
+- **condition**: `header` has `value` or less characters
+- **rule**: `always`
+- **value**
+
+```js
+  72
+```
+
+```sh
+echo "fix: some message that is way too long and breaks the line max-length by several characters" # fails
+echo "fix: some message" # passes
+```

package/commitlint.config.js

@@ -0,0 +1,6 @@
+/**
+ * @type {import('@commitlint/types').UserConfig}
+ */
+export default {
+	extends: ["@commitlint/config-conventional"],
+};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@theholocron/commitlint-config",
+  "homepage": "https://github.com/theholocron/configs/tree/main/packages/commitlint-config#readme",
+  "description": "A CommitLint configuration for writing well-formatted and consistent Git commits.",
+  "author": "Newton Koumantzelis",
+  "version": "1.10.0",
+  "main": "commitlint.config.js",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theholocron/configs.git"
+  },
+  "bugs": "https://github.com/theholocron/configs/issues",
+  "releases": "https://github.com/theholocron/configs/releases",
+  "wiki": "https://github.com/theholocron/configs/wiki",
+  "license": "GPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0"
+  }
+}