1.0.0

Author: gabmontes

.eslintrc.json

@@ -0,0 +1,13 @@
+{
+  "extends": ["bloq", "prettier"],
+  "overrides": [
+    {
+      "extends": ["bloq/markdown"],
+      "files": ["*.md"]
+    }
+  ],
+  "parserOptions": {
+    "sourceType": "module"
+  },
+  "root": true
+}

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @gabmontes

.github/workflows/js-checks.yml

@@ -0,0 +1,21 @@
+name: JS Checks
+
+on:
+  pull_request:
+  push:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
+  cancel-in-progress: true
+
+jobs:
+  run-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+      - run: npm ci
+      - run: npm run format:check
+      - run: npm run lint

.github/workflows/npm-publish.yml

@@ -0,0 +1,19 @@
+name: NPM Publish
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish-to-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: .nvmrc
+      - run: npm ci
+      - uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+.eslintcache
+.vscode
+node_modules

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+lint-staged

.nvmrc

@@ -0,0 +1 @@
+20

README.md

@@ -0,0 +1,23 @@
+# commitlint-config-bloq
+
+Shareable [commitlint](https://commitlint.js.org/) config as we do at [Bloq](https://bloq.com).
+
+## Usage
+
+Install the config locally:
+
+```sh
+npm install --save-dev commitlint-config-bloq
+```
+
+Then, extend your own configuration:
+
+```json
+{
+  "extends": ["bloq"]
+}
+```
+
+## Inspiration
+
+The rules this package sets are based on [The seven rules of a great Git commit message](https://cbea.ms/git-commit/), a 2014 post by [Chris Beams](https://twitter.com/cbeams) worth reading even today.

commitlint.config.js

@@ -0,0 +1,3 @@
+import config from "./src/index.js";
+
+export default config;

lint-staged.config.js

@@ -0,0 +1,11 @@
+const lintFile = "eslint --cache --fix --quiet";
+const formatFile = "prettier --ignore-unknown --write";
+const sortPackageJson = "better-sort-package-json";
+
+const config = {
+  "*,!*.{js,md},!package.json": [formatFile],
+  "*.{js,md}": [lintFile, formatFile],
+  "package.json": [sortPackageJson, formatFile],
+};
+
+export default config;