chore: added linting

Nico Ismaili · Nico Ismaili · commit 7ef2744562fb · 2025-06-02T11:44:13.000+02:00
/spend 5m
diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml
@@ -19,6 +19,12 @@ jobs:
       - name: Install dependencies (Cache hit will skip actual installation)
         run: |
           bun install --frozen-lockfile
+      - name: Lint code
+        run: |
+          bun run lint
+      - name: Run tests
+        run: |
+          bun test
       - name: Build package
         run: |
           bun run build
diff --git a/.lintstagedrc.yaml b/.lintstagedrc.yaml
@@ -0,0 +1,5 @@
+'*.{js,jsx,ts,tsx}':
+  - bun lint:fix
+
+'*.{json,md,yml,yaml}':
+  - bun lint:fix
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,23 +2,20 @@
 
 ## [1.2.1](https://github.com/nico-i/commitlint-plugin-spend/compare/v1.2.0...v1.2.1) (2025-06-02)
 
-
 ### Miscellaneous Chores
 
-* release 1.2.0 ([f0b158b](https://github.com/nico-i/commitlint-plugin-spend/commit/f0b158b6774a8e74a68b21fb631af3e98ef061f4))
-* release 1.2.1 ([d5206ab](https://github.com/nico-i/commitlint-plugin-spend/commit/d5206ab2b96a9006a720d140739414c896103ad7))
-* removed previous releases ([537f883](https://github.com/nico-i/commitlint-plugin-spend/commit/537f883aa0c8cf5e4a89761cd177fc8fbc0fd058))
+- release 1.2.0 ([f0b158b](https://github.com/nico-i/commitlint-plugin-spend/commit/f0b158b6774a8e74a68b21fb631af3e98ef061f4))
+- release 1.2.1 ([d5206ab](https://github.com/nico-i/commitlint-plugin-spend/commit/d5206ab2b96a9006a720d140739414c896103ad7))
+- removed previous releases ([537f883](https://github.com/nico-i/commitlint-plugin-spend/commit/537f883aa0c8cf5e4a89761cd177fc8fbc0fd058))
 
 ## [1.2.0](https://github.com/nico-i/commitlint-plugin-spend/compare/v1.0.0...v1.2.0) (2025-06-02)
 
-
 ### Miscellaneous Chores
 
-* release 1.2.0 ([f0b158b](https://github.com/nico-i/commitlint-plugin-spend/commit/f0b158b6774a8e74a68b21fb631af3e98ef061f4))
+- release 1.2.0 ([f0b158b](https://github.com/nico-i/commitlint-plugin-spend/commit/f0b158b6774a8e74a68b21fb631af3e98ef061f4))
 
 ## [1.0.0](https://github.com/nico-i/commitlint-plugin-spend/compare/v1.2.0...v1.0.0) (2025-06-01)
 
-
 ### Miscellaneous Chores
 
-* removed previous releases ([537f883](https://github.com/nico-i/commitlint-plugin-spend/commit/537f883aa0c8cf5e4a89761cd177fc8fbc0fd058))
+- removed previous releases ([537f883](https://github.com/nico-i/commitlint-plugin-spend/commit/537f883aa0c8cf5e4a89761cd177fc8fbc0fd058))
diff --git a/README.md b/README.md
@@ -80,24 +80,24 @@ feat: implement user authentication
 /spend
 ```
 
-*Error: Spend directive must contain at least one time value*
+_Error: Spend directive must contain at least one time value_
 
 ```text
 fix: resolve database connection timeout
 
 /spend 25h 70m
 ```
 
-*Error: The time value "25h" exceeds the maximum value for "h" (max value: 23)*
+_Error: The time value "25h" exceeds the maximum value for "h" (max value: 23)_
 
 ```text
 refactor: optimize API response handling
 
 /spend 30m 2h 1d
 ```
 
-*Error: Time values are not in the correct order. Time values must be ordered from largest to smallest unit*
+_Error: Time values are not in the correct order. Time values must be ordered from largest to smallest unit_
 
 ## License
 
-[MIT](./LICENSE)
+[MIT](./LICENSE)
diff --git a/bun.lock b/bun.lock
diff --git a/commitlint.config.ts b/commitlint.config.ts
@@ -1,10 +1,10 @@
-import { type UserConfig } from "@commitlint/types";
-import spendPlugin from "./index";
+import { type UserConfig } from '@commitlint/types';
+import spendPlugin from './index';
 
 export default {
-  extends: ["@commitlint/config-conventional"],
+  extends: [`@commitlint/config-conventional`],
   rules: {
-    spend: [2, "always"],
+    spend: [2, `always`],
   },
   plugins: [spendPlugin],
 } satisfies UserConfig;
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,9 @@
+import { defineConfig } from 'eslint/config';
+import config from '@nico-i/eslint-config';
+
+export default defineConfig([
+  ...config,
+  {
+    ignores: [`node_modules/`, `out/`, `coverage/`],
+  },
+]);
diff --git a/index.ts b/index.ts
@@ -1,5 +1,5 @@
-import type { Plugin } from "@commitlint/types";
-import { validateCommitMsg } from "./src/utils/validateCommitMsg/validateCommitMsg";
+import type { Plugin } from '@commitlint/types';
+import { validateCommitMsg } from './src/utils/validateCommitMsg/validateCommitMsg';
 
 export default {
   rules: {
diff --git a/package.json b/package.json
@@ -34,7 +34,9 @@
     "url": "https://github.com/nico-i/commitlint-plugin-spend/issues"
   },
   "scripts": {
-    "build": "bun test && bun build ./index.ts --outdir ./out",
+    "build": "bun build ./index.ts --outdir ./out --minify",
+    "lint": "eslint . --ext .ts && prettier . --check",
+    "lint:fix": "eslint . --ext .ts --fix && prettier . --write",
     "prepare": "husky || true"
   },
   "peerDependencies": {
@@ -45,8 +47,13 @@
     "@commitlint/config-conventional": "19.8.1",
     "@commitlint/core": "19.8.1",
     "@commitlint/types": "19.8.1",
+    "@nico-i/eslint-config": "2.7.0",
+    "@nico-i/prettier-config": "1.0.2",
     "@types/bun": "1.2.15",
     "@types/node": "22.15.29",
-    "husky": "9.1.7"
+    "eslint": "9.28.0",
+    "husky": "9.1.7",
+    "lint-staged": "16.1.0",
+    "prettier": "3.5.3"
   }
 }
diff --git a/prettier.config.js b/prettier.config.js
@@ -0,0 +1,5 @@
+import config from '@nico-i/prettier-config';
+
+export default {
+  ...config,
+};
diff --git a/src/types/SpendCommand/SpendCommand.test.ts b/src/types/SpendCommand/SpendCommand.test.ts
@@ -1,30 +1,25 @@
-import { describe, expect, test } from "bun:test";
-import {
-  spendingCommands,
-  spendCommandPattern,
-  isSpendCommand,
-  type SpendCommand,
-} from "./SpendCommand";
+import { describe, expect, test } from 'bun:test';
+import { isSpendCommand, type SpendCommand } from './SpendCommand';
 
 describe(isSpendCommand.name, () => {
-  test("should return true for valid spend commands", () => {
-    expect(isSpendCommand("/spend")).toBe(true);
-    expect(isSpendCommand("/spend_time")).toBe(true);
+  test(`should return true for valid spend commands`, () => {
+    expect(isSpendCommand(`/spend`)).toBe(true);
+    expect(isSpendCommand(`/spend_time`)).toBe(true);
   });
 
-  test("should return false for invalid commands", () => {
-    expect(isSpendCommand("/invalid")).toBe(false);
-    expect(isSpendCommand("spend")).toBe(false);
-    expect(isSpendCommand("/spend ")).toBe(false);
-    expect(isSpendCommand("")).toBe(false);
-    expect(isSpendCommand("/spend_time_extra")).toBe(false);
+  test(`should return false for invalid commands`, () => {
+    expect(isSpendCommand(`/invalid`)).toBe(false);
+    expect(isSpendCommand(`spend`)).toBe(false);
+    expect(isSpendCommand(`/spend `)).toBe(false);
+    expect(isSpendCommand(``)).toBe(false);
+    expect(isSpendCommand(`/spend_time_extra`)).toBe(false);
   });
 
-  test("should act as type guard", () => {
-    const value: string = "/spend";
+  test(`should act as type guard`, () => {
+    const value = `/spend`;
     if (isSpendCommand(value)) {
       const command: SpendCommand = value;
-      expect(command).toBe("/spend");
+      expect(command).toBe(`/spend`);
     }
   });
 });
diff --git a/src/types/SpendCommand/SpendCommand.ts b/src/types/SpendCommand/SpendCommand.ts
@@ -2,12 +2,12 @@
  * The GitLab spend commands.
  * @see https://docs.gitlab.com/ee/user/project/quick_actions.html#issues-merge-requests-and-epics
  */
-export const spendingCommands = ["/spend", "/spend_time"] as const;
+export const spendingCommands = [`/spend`, `/spend_time`] as const;
 
 export type SpendCommand = (typeof spendingCommands)[number];
 
 export const spendCommandPattern = new RegExp(
-  `^(${spendingCommands.join("|")})$`
+  `^(${spendingCommands.join(`|`)})$`,
 );
 
 export function isSpendCommand(value: string): value is SpendCommand {
diff --git a/src/types/TimeUnit/TimeUnit.test.ts b/src/types/TimeUnit/TimeUnit.test.ts
@@ -1,35 +1,35 @@
-import { describe, expect, test } from "bun:test";
-import { isTimeUnit, type TimeUnit } from "./TimeUnit";
+import { describe, expect, test } from 'bun:test';
+import { isTimeUnit, type TimeUnit } from './TimeUnit';
 
 describe(isTimeUnit.name, () => {
-  test("should return true for valid time units", () => {
-    expect(isTimeUnit("y")).toBe(true);
-    expect(isTimeUnit("mo")).toBe(true);
-    expect(isTimeUnit("w")).toBe(true);
-    expect(isTimeUnit("d")).toBe(true);
-    expect(isTimeUnit("h")).toBe(true);
-    expect(isTimeUnit("m")).toBe(true);
+  test(`should return true for valid time units`, () => {
+    expect(isTimeUnit(`y`)).toBe(true);
+    expect(isTimeUnit(`mo`)).toBe(true);
+    expect(isTimeUnit(`w`)).toBe(true);
+    expect(isTimeUnit(`d`)).toBe(true);
+    expect(isTimeUnit(`h`)).toBe(true);
+    expect(isTimeUnit(`m`)).toBe(true);
   });
 
-  test("should return false for invalid time units", () => {
-    expect(isTimeUnit("s")).toBe(false);
-    expect(isTimeUnit("min")).toBe(false);
-    expect(isTimeUnit("hour")).toBe(false);
-    expect(isTimeUnit("day")).toBe(false);
-    expect(isTimeUnit("week")).toBe(false);
-    expect(isTimeUnit("month")).toBe(false);
-    expect(isTimeUnit("year")).toBe(false);
-    expect(isTimeUnit("")).toBe(false);
-    expect(isTimeUnit("invalid")).toBe(false);
-    expect(isTimeUnit("Y")).toBe(false);
-    expect(isTimeUnit("MO")).toBe(false);
+  test(`should return false for invalid time units`, () => {
+    expect(isTimeUnit(`s`)).toBe(false);
+    expect(isTimeUnit(`min`)).toBe(false);
+    expect(isTimeUnit(`hour`)).toBe(false);
+    expect(isTimeUnit(`day`)).toBe(false);
+    expect(isTimeUnit(`week`)).toBe(false);
+    expect(isTimeUnit(`month`)).toBe(false);
+    expect(isTimeUnit(`year`)).toBe(false);
+    expect(isTimeUnit(``)).toBe(false);
+    expect(isTimeUnit(`invalid`)).toBe(false);
+    expect(isTimeUnit(`Y`)).toBe(false);
+    expect(isTimeUnit(`MO`)).toBe(false);
   });
 
-  test("should act as type guard", () => {
-    const value: string = "h";
+  test(`should act as type guard`, () => {
+    const value = `h`;
     if (isTimeUnit(value)) {
       const unit: TimeUnit = value;
-      expect(unit).toBe("h");
+      expect(unit).toBe(`h`);
     }
   });
 });
diff --git a/src/types/TimeUnit/TimeUnit.ts b/src/types/TimeUnit/TimeUnit.ts
@@ -2,7 +2,7 @@
  * The ordered time units based on the GitLab time unit pattern.
  * @see https://docs.gitlab.com/ee/user/project/time_tracking.html#available-time-units
  */
-export const orderedTimeUnits = ["y", "mo", "w", "d", "h", "m"] as const;
+export const orderedTimeUnits = [`y`, `mo`, `w`, `d`, `h`, `m`] as const;
 
 export type TimeUnit = (typeof orderedTimeUnits)[number];
 
diff --git a/src/types/TimeValue/TimeValue.ts b/src/types/TimeValue/TimeValue.ts
@@ -1,4 +1,4 @@
-import { orderedTimeUnits, type TimeUnit } from "../TimeUnit/TimeUnit";
+import { orderedTimeUnits, type TimeUnit } from '../TimeUnit/TimeUnit';
 
 /**
  * The maximum value for each time unit.
@@ -20,7 +20,7 @@ export type TimeValue = `${number}${TimeUnit}`;
  * Can optionally start with a negative sign for negative time values.
  */
 export const timeValuePattern = new RegExp(
-  `^(\\d{1,2})(${orderedTimeUnits.join("|")})$`
+  `^(\\d{1,2})(${orderedTimeUnits.join(`|`)})$`,
 );
 
 export function isTimeValue(value: string): value is TimeValue {
diff --git a/src/utils/validateCommitMsg/validateCommitMsg.test.ts b/src/utils/validateCommitMsg/validateCommitMsg.test.ts
diff --git a/src/utils/validateCommitMsg/validateCommitMsg.ts b/src/utils/validateCommitMsg/validateCommitMsg.ts
