feat: initial commit

/spend 2h

Author: nico-i

.gitignore

@@ -0,0 +1,144 @@
+# Created by https://www.toptal.com/developers/gitignore/api/node
+# Edit at https://www.toptal.com/developers/gitignore?templates=node
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+# End of https://www.toptal.com/developers/gitignore/api/node

.npmignore

@@ -0,0 +1,2 @@
+commitlint.config.js
+node_modules

README.md

@@ -0,0 +1,53 @@
+# commitlint-plugin-spend
+
+[Commitlint](https://commitlint.js.org/) plugin to enforce the use of [spend directives](https://docs.gitlab.com/ee/user/project/quick_actions.html#issues-merge-requests-and-epics) in commit messages.
+
+## Available rules
+
+### spend
+
+- **condition**: `body` ends with a valid [spend directive](https://docs.gitlab.com/ee/user/project/quick_actions.html#issues-merge-requests-and-epics)
+- **rule**: `always`
+
+## Usage
+
+1. Install the plugin:
+
+```bash
+npm i -D commitlint-plugin-spend
+```
+
+```bash
+yarn add -D commitlint-plugin-spend
+```
+
+```bash
+pnpm add -D commitlint-plugin-spend
+```
+
+```bash
+bun add -d commitlint-plugin-spend
+```
+
+2. Add the plugin to your `commitlint` configuration:
+
+```json
+{
+  "extends": ["@commitlint/config-conventional"],
+  "plugins": ["commitlint-plugin-spend"]
+}
+```
+
+3. Configure the `spend` rule in your `commitlint` configuration:
+
+```json
+{
+  "rules": {
+    "spend": [2, "always"]
+  }
+}
+```
+
+## License
+
+[MIT](./LICENSE)

commitlint.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+  plugins: ["commitlint-plugin-spend"],
+  rules: {
+    spend: [2, "always"],
+  },
+};

index.js

@@ -0,0 +1,58 @@
+import { validateTimeUnit } from "./src/types/TimeUnit";
+
+/**
+ * The GitLab spend directives.
+ * @see https://docs.gitlab.com/ee/user/project/quick_actions.html#issues-merge-requests-and-epics
+ */
+const spendDirectives = ["/spend", "/spend_time"];
+
+module.exports = {
+  rules: {
+    spend: (ctx, applicable) => {
+      if (applicable === "never") {
+        return [false, 'the "spend" rule does not support "never"'];
+      }
+
+      const { body } = ctx;
+
+      if (!body) {
+        // Require a body
+        return [false, "Commit message body must contain a spend directive"];
+      }
+
+      const lines = body.split("\n");
+
+      const spendLines = lines.filter((line) =>
+        spendDirectives.some((directive) => line.startsWith(directive))
+      );
+
+      if (spendLines.length === 0) {
+        return [
+          false,
+          "Commit message body must contain a line starting with a spend directive",
+        ];
+      }
+
+      for (const line of spendLines) {
+        const lineSplit = line.split(" ");
+
+        if (lineSplit.length < 2) {
+          return [
+            false,
+            "Spend directive must be provided with at least one time value",
+          ];
+        }
+
+        const timeValues = lineSplit.slice(1);
+
+        const [isValid, msg] = validateTimeUnit(timeValues);
+
+        if (!isValid) {
+          return [false, msg];
+        }
+      }
+
+      return [true, undefined];
+    },
+  },
+};

index.test.js

@@ -0,0 +1,56 @@
+import { describe, expect, test } from "vitest";
+import { rules } from "./index.js";
+
+describe("commitlint-plugin-spend", () => {
+  const { spend } = rules;
+  const alwaysApplicable = "always";
+
+  test("should return false if the applicable value is 'never'", () => {
+    const ctx = { body: "body" };
+    const applicable = "never";
+    const [isValid, error] = spend(ctx, applicable);
+    expect(isValid).toBe(false);
+    expect(error).toBe('the "spend" rule does not support "never"');
+  });
+
+  test("should return false if the body is empty", () => {
+    const ctx = { body: "" };
+    const [isValid, error] = spend(ctx, alwaysApplicable);
+    expect(isValid).toBe(false);
+    expect(error).toBe("Commit message body must contain a spend directive");
+  });
+
+  test("should return false if the body does not contain a spend directive", () => {
+    const ctx = { body: "body" };
+    const [isValid, error] = spend(ctx, alwaysApplicable);
+    expect(isValid).toBe(false);
+    expect(error).toBe(
+      "Commit message body must contain a line starting with a spend directive"
+    );
+  });
+
+  test("should return false if the spend directive does not contain a time value", () => {
+    const ctx = { body: "/spend" };
+    const [isValid, error] = spend(ctx, alwaysApplicable);
+    expect(isValid).toBe(false);
+    expect(error).toBe(
+      "Spend directive must be provided with at least one time value"
+    );
+  });
+
+  test("should support alternative spend directive", () => {
+    const ctx = { body: "/spend_time" };
+    const [isValid, error] = spend(ctx, alwaysApplicable);
+    expect(isValid).toBe(false);
+    expect(error).toBe(
+      "Spend directive must be provided with at least one time value"
+    );
+  });
+
+  test("should return true for valid time values", () => {
+    const ctx = { body: "/spend 2d 3h 30m" };
+    const [isValid, error] = spend(ctx, alwaysApplicable);
+    expect(error).toBeUndefined();
+    expect(isValid).toBe(true);
+  });
+});

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "commitlint-plugin-spend",
+  "version": "1.0.1",
+  "description": "A commitlint plugin that requires the GitLab /spend or /spend_time directive in commit messages",
+  "main": "index.js",
+  "keywords": [
+    "commitlint",
+    "commitlintplugin",
+    "git",
+    "lab",
+    "commit",
+    "spend",
+    "message",
+    "time",
+    "tracking"
+  ],
+  "author": "Nico Ismaili",
+  "license": "MIT",
+  "homepage": "https://github.com/nico-i/commitlint-plugin-spend",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nico-i/commitlint-plugin-spend.git"
+  },
+  "scripts": {
+    "test": "vitest"
+  },
+  "peerDependencies": {
+    "@commitlint/lint": ">=7.6.0"
+  },
+  "devDependencies": {
+    "@commitlint/core": "^18.6.0",
+    "@types/node": "^20.11.16",
+    "commitlint-plugin-spend": "link:",
+    "vitest": "^1.2.2"
+  }
+}