chore: add postinstall script

Author: chrisbbreuer

bin/cli.ts

@@ -15,11 +15,15 @@ cli
   .example('git log -1 --pretty=%B | gitlint')
   .option('--verbose', 'Enable verbose output', { default: defaultConfig.verbose })
   .option('--config <file>', 'Path to config file')
+  .option('--edit', 'Read commit message from a file (used by git hooks)')
   .action(async (files: string[], options) => {
     let commitMessage = ''
 
     // Get commit message from files passed as arguments
-    if (files.length > 0) {
+    if (options.edit && files.length > 0) {
+      commitMessage = readCommitMessageFromFile(files[0])
+    }
+    else if (files.length > 0) {
       commitMessage = readCommitMessageFromFile(files[0])
     }
     // Or from stdin if piped

build.ts

@@ -6,3 +6,10 @@ await Bun.build({
   plugins: [dts()],
   target: 'node',
 })
+
+await Bun.build({
+  entrypoints: ['bin/cli.ts'],
+  outdir: './dist/bin',
+  plugins: [dts()],
+  target: 'bun',
+})

bun.lock

@@ -2,6 +2,7 @@
 // @ts-nocheck
 // Generated by unplugin-vue-components
 // Read more: https://github.com/vuejs/core/pull/3399
+// biome-ignore lint: disable
 export {}
 
 /* prettier-ignore */

docs/.vitepress/components.d.ts

@@ -59,24 +59,29 @@
     "dev:docs": "bun --bun vitepress dev docs",
     "build:docs": "bun --bun vitepress build docs",
     "preview:docs": "bun --bun vitepress preview docs",
-    "typecheck": "bun --bun tsc --noEmit"
+    "typecheck": "bun --bun tsc --noEmit",
+    "postinstall": "bun run scripts/postinstall.ts"
   },
   "devDependencies": {
     "@stacksjs/docs": "^0.70.23",
     "@stacksjs/eslint-config": "^4.10.2-beta.3",
     "@types/bun": "^1.2.12",
     "bumpp": "^10.1.0",
+    "bun-git-hooks": "^0.2.13",
     "bun-plugin-dtsx": "^0.21.12",
     "bunfig": "^0.8.5",
     "changelogen": "^0.6.1",
-    "lint-staged": "^15.5.2",
-    "simple-git-hooks": "^2.13.0",
     "typescript": "^5.8.3"
   },
+  "git-hooks": {
+    "pre-commit": {
+      "staged-lint": {
+        "*.{js,ts,json,yaml,yml,md}": "bunx --bun eslint . --fix"
+      }
+    },
+    "commit-msg": "bunx gitlint"
+  },
   "overrides": {
     "unconfig": "0.3.10"
-  },
-  "lint-staged": {
-    "*.{js,ts}": "bunx --bun eslint . --fix"
   }
 }

package.json

@@ -0,0 +1,136 @@
+#!/usr/bin/env bun
+
+import { mkdir, readFile, symlink } from 'node:fs/promises'
+import { join } from 'node:path'
+import process from 'node:process'
+
+/**
+ * Reads the nearest package.json and returns the package name.
+ * @param rootDir Directory to start searching from (defaults to process.cwd())
+ */
+async function getPackageName(rootDir: string = process.cwd()): Promise<string | undefined> {
+  try {
+    const pkgPath = join(rootDir, 'package.json')
+    const pkgJson = await readFile(pkgPath, 'utf8')
+    const pkg = JSON.parse(pkgJson)
+    return pkg.name
+  }
+  catch (err) {
+    console.error(`[ERROR] Failed to get package name: ${err}`)
+    // Optionally, walk up directories if not found, or just return undefined
+    return undefined
+  }
+}
+
+async function getBinNames(rootDir: string = process.cwd()): Promise<string[] | undefined> {
+  try {
+    const pkgPath = join(rootDir, 'package.json')
+    const pkgJson = await readFile(pkgPath, 'utf8')
+    const pkg = JSON.parse(pkgJson)
+    if (!pkg.bin)
+      return undefined
+    if (typeof pkg.bin === 'string') {
+      // If bin is a string, the bin name is the package name
+      return [pkg.name]
+    }
+    if (typeof pkg.bin === 'object') {
+      // If bin is an object, the keys are the bin names
+      return Object.keys(pkg.bin)
+    }
+    return undefined
+  }
+  catch (err) {
+    console.error(`[ERROR] Failed to get bin names: ${err}`)
+    return undefined
+  }
+}
+
+/*
+* Transforms the <project>/node_modules/bun-git-hooks to <project>
+*/
+async function getProjectRootDirectoryFromNodeModules(projectPath: string): Promise<string | undefined> {
+  function _arraysAreEqual(a1: any[], a2: any[]) {
+    return JSON.stringify(a1) === JSON.stringify(a2)
+  }
+
+  const packageName = await getPackageName()
+  if (packageName === undefined) {
+    console.error('[ERROR] Failed to get package name')
+    return undefined
+  }
+
+  const binNames = await getBinNames()
+  if (binNames === undefined) {
+    console.error('[ERROR] Failed to get bin names')
+    return undefined
+  }
+
+  const projDir = projectPath.split(/[\\/]/) // <- would split both on '/' and '\'
+
+  const indexOfStoreDir = projDir.indexOf('.store')
+  if (indexOfStoreDir > -1) {
+    return projDir.slice(0, indexOfStoreDir - 1).join('/')
+  }
+
+  // Handle .bin case for any bin name
+  if (
+    projDir.length > 3
+    && projDir[projDir.length - 3] === 'node_modules'
+    && projDir[projDir.length - 2] === '.bin'
+    && binNames.includes(projDir[projDir.length - 1])
+  ) {
+    return projDir.slice(0, -3).join('/')
+  }
+
+  // Existing node_modules check
+  if (projDir.length > 2
+    && _arraysAreEqual(projDir.slice(-2), ['node_modules', packageName])) {
+    return projDir.slice(0, -2).join('/')
+  }
+
+  return undefined
+}
+
+/**
+ * Creates the pre-commit from command in config by default
+ */
+async function postinstall() {
+  let projectDirectory
+
+  /* When script is run after install, the process.cwd() would be like <project_folder>/node_modules/simple-git-hooks
+     Here we try to get the original project directory by going upwards by 2 levels
+     If we were not able to get new directory we assume, we are already in the project root */
+  const parsedProjectDirectory = await getProjectRootDirectoryFromNodeModules(process.cwd())
+  if (parsedProjectDirectory !== undefined) {
+    projectDirectory = parsedProjectDirectory
+  }
+  else {
+    projectDirectory = process.cwd()
+  }
+
+  // Link the binary
+  const binDir = join(projectDirectory, 'node_modules', '.bin')
+  await mkdir(binDir, { recursive: true })
+
+  const sourcePath = join(process.cwd(), 'dist', 'bin', 'cli.js')
+
+  const binNames = await getBinNames()
+  if (binNames === undefined) {
+    console.error('[ERROR] Failed to get bin names')
+    return undefined
+  }
+
+  for (const binName of binNames) {
+    const targetPath = join(binDir, binName)
+    try {
+      await symlink(sourcePath, targetPath, 'file')
+    }
+    catch (err) {
+      if ((err as NodeJS.ErrnoException).code !== 'EEXIST') {
+        console.error(`[ERROR] Failed to link binary: ${err}`)
+      }
+    }
+  }
+}
+
+postinstall()

scripts/postinstall.ts

@@ -8,7 +8,7 @@ export function parseCommitMessage(message: string): CommitParsedResult {
   const header = lines[0] || ''
 
   // Parse header to extract type, scope, and subject
-  const headerMatch = header.match(/^(?<type>\w+)(?:\((?<scope>[^)]+)\))?:(?<subject>.+)$/)
+  const headerMatch = header.replace(/['"]/g, '').match(/^(?<type>\w+)(?:\((?<scope>[^)]+)\))?: ?(?<subject>.+)$/)
 
   let type = null
   let scope = null

src/parser.ts

@@ -6,9 +6,11 @@ const conventionalCommits: LintRule = {
   description: 'Enforces conventional commit format',
   validate: (commitMsg: string) => {
     // Basic format: <type>[(scope)]: <description>
-    const pattern = /^(?:build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(?:\([a-z0-9-]+\))?: .+/i
+    const pattern = /^(?:build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(?:\([a-z0-9-]+\))?: .+$/i
 
-    if (!pattern.test(commitMsg.split('\n')[0])) {
+    const firstLine = commitMsg.split('\n')[0]
+
+    if (!pattern.test(firstLine.replace(/['"]/g, ''))) {
       return {
         valid: false,
         message: 'Commit message header does not follow conventional commit format: <type>[(scope)]: <description>',