feat: support to and from arguments for commitlint

Author: apaleslimghost

package-lock.json

@@ -11,7 +11,8 @@
   "license": "ISC",
   "dependencies": {
     "@dotcom-tool-kit/base": "^1.3.0",
-    "@dotcom-tool-kit/logger": "^4.2.2"
+    "@dotcom-tool-kit/logger": "^4.2.2",
+    "zod": "^3.25.76"
   },
   "repository": {
     "type": "git",

plugins/commitlint/package.json

@@ -25,4 +25,12 @@ By default the plugin will run on the `git:commitmsg` command. There are no furt
 ### `Commitlint`
 
 Lint commit messages.
+#### Task options
+
+| Property | Description                                                                                                                                     | Type     |
+| :------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | :------- |
+| `from`   | The start of the commit range to lint. If neither `from` or `to` are specified, Commitlint will lint the commit message currently being edited. | `string` |
+| `to`     | The end of the commit range to lint.                                                                                                            | `string` |
+
+_All properties are optional._
 <!-- end autogenerated docs -->

plugins/commitlint/readme.md

@@ -1,14 +1,43 @@
 import { fork } from 'child_process'
-import { hookFork, waitOnExit } from '@dotcom-tool-kit/logger'
+import { hookFork, waitOnExit, styles as s } from '@dotcom-tool-kit/logger'
 import { Task, TaskRunContext } from '@dotcom-tool-kit/base'
+import { z } from 'zod'
 
 const commitlintCLIPath = require.resolve('.bin/commitlint')
 
-export default class Commitlint extends Task {
-  static description = 'Lint commit messages.'
+const CommitlintSchema = z
+  .object({
+    from: z
+      .string()
+      .optional()
+      .describe(
+        'The start of the commit range to lint. If neither `from` or `to` are specified, Commitlint will lint the commit message currently being edited.'
+      ),
+    to: z.string().optional().describe('The end of the commit range to lint.')
+  })
+  .describe('Lint commit messages.')
 
+export { CommitlintSchema as schema }
+
+export default class Commitlint extends Task<{ task: typeof CommitlintSchema }> {
   async run({ cwd }: TaskRunContext): Promise<void> {
-    const child = fork(commitlintCLIPath, ['--edit'], { silent: true, cwd })
+    const args: string[] = []
+
+    if (this.options.from) {
+      args.push('--from', this.options.from)
+    }
+
+    if (this.options.to) {
+      args.push('--to', this.options.to)
+    }
+
+    if (args.length === 0) {
+      args.push('--edit')
+    }
+
+    this.logger.info(`running ${s.command(`commitlint ${args.join(' ')}`)}`)
+
+    const child = fork(commitlintCLIPath, args, { silent: true, cwd })
     hookFork(this.logger, 'commitlint', child)
     return waitOnExit('commitlint', child)
   }