fg-devkit 1.1.2 → 1.3.0

package/README.md

@@ -45,6 +45,31 @@ pnpm exec fgd typecheck
 pnpm exec fgd typecheck-watch
 ```
 
+To remove redundant tooling dependencies from a consuming repo:
+
+```bash
+pnpm exec fgd prune-consumer-deps
+pnpm install
+```
+
+To sync standard consumer scripts to `fgd` commands:
+
+```bash
+pnpm exec fgd sync-consumer-scripts
+```
+
+To migrate from Husky + lint-staged to Lefthook:
+
+```bash
+pnpm exec fgd setup-lefthook
+```
+
+Run full consumer setup in one command:
+
+```bash
+pnpm exec fgd full-consumer-setup
+```
+
 ## tsconfig in consuming repos
 
 Use `fgd sync-project-configs` (or `fgd sync-tooling-configs`) to write the local `tsconfig.json` template from `fg-devkit`.

package/configs/dependency-policy.vue-workspace.json

@@ -49,10 +49,8 @@
     "devDependencies": {
       "@chromatic-com/storybook": "5.0.1",
       "@eslint/js": "9.39.1",
-      "@intlify/eslint-plugin-vue-i18n": "4.3.0",
       "@intlify/unplugin-vue-i18n": "11.0.7",
       "@playwright/test": "1.59.1",
-      "@rushstack/eslint-patch": "1.16.1",
       "@storybook/addon-a11y": "10.1.10",
       "@storybook/addon-docs": "10.1.10",
       "@storybook/addon-vitest": "10.2.12",
@@ -62,45 +60,27 @@
       "@tsconfig/node22": "22.0.5",
       "@types/lodash-es": "4.17.12",
       "@types/node": "22.16.5",
-      "@typescript-eslint/eslint-plugin": "8.57.2",
-      "@typescript-eslint/parser": "8.57.2",
       "@vitest/browser": "3.2.4",
-      "@vitest/eslint-plugin": "1.6.14",
       "@vue/compiler-dom": "3.5.29",
-      "@vue/eslint-config-prettier": "10.2.0",
       "@vue/eslint-config-standard": "8.0.1",
-      "@vue/eslint-config-typescript": "14.7.0",
       "@vue/server-renderer": "3.5.29",
       "@vue/test-utils": "2.4.6",
-      "@vue/tsconfig": "0.8.1",
       "@vuepic/vue-datepicker": "6.0.3",
       "arg": "5.0.2",
       "babel-eslint": "10.1.0",
-      "commitizen": "4.3.1",
-      "eslint": "10.0.2",
-      "eslint-plugin-prettier": "5.5.5",
       "eslint-plugin-storybook": "10.1.10",
-      "eslint-plugin-vue": "10.8.0",
       "globals": "15.11.0",
-      "husky": "9.1.6",
       "jsdom": "26.1.0",
-      "jsonc-eslint-parser": "2.4.1",
-      "lint-staged": "16.4.0",
       "postcss": "8.5.6",
-      "prettier": "3.8.1",
       "sass": "1.97.3",
       "start-server-and-test": "2.1.3",
       "storybook": "10.2.12",
       "tsx": "4.21.0",
-      "typescript": "5.9.3",
       "vega": "6.2.0",
       "vite-plugin-dts": "4.5.4",
       "vite-plugin-vue-devtools": "8.0.7",
       "vitest": "3.2.4",
-      "vue-eslint-parser": "10.4.0",
-      "vue-tsc": "3.2.6",
-      "yaml": "2.8.3",
-      "yaml-eslint-parser": "1.3.1"
+      "yaml": "2.8.3"
     }
   },
   "managedAnywhere": {

package/configs/lefthook.yml

@@ -0,0 +1,4 @@
+pre-commit:
+  commands:
+    lint-check:
+      run: pnpm lint-check

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fg-devkit",
-  "version": "1.1.2",
+  "version": "1.3.0",
   "description": "Shared configs, scripts, and DX tooling for Vue / TypeScript frontend repos",
   "type": "module",
   "license": "UNLICENSED",
@@ -15,6 +15,7 @@
     "./tsconfig.app.sync.json": "./configs/tsconfig.app.sync.json",
     "./eslint.config.base.js": "./configs/eslint.config.base.js",
     "./prettier.config.js": "./configs/prettier.config.js",
+    "./lefthook.yml": "./configs/lefthook.yml",
     "./vscode-settings.json": "./configs/vscode-settings.json",
     "./dependency-policy.vue-workspace.json": "./configs/dependency-policy.vue-workspace.json",
     "./vuln-commit": "./scripts/vuln-commit.mjs",
@@ -24,6 +25,9 @@
     "./scripts/sync-vscode-settings.mjs": "./scripts/sync-vscode-settings.mjs",
     "./scripts/sync-tooling-configs.mjs": "./scripts/sync-tooling-configs.mjs",
     "./scripts/sync-project-configs.mjs": "./scripts/sync-project-configs.mjs",
+    "./scripts/sync-consumer-scripts.mjs": "./scripts/sync-consumer-scripts.mjs",
+    "./scripts/sync-consumer-lefthook.mjs": "./scripts/sync-consumer-lefthook.mjs",
+    "./scripts/prune-consumer-deps.mjs": "./scripts/prune-consumer-deps.mjs",
     "./scripts/check-dependency-policy.mjs": "./scripts/check-dependency-policy.mjs",
     "./scripts/sync-dependency-policy.mjs": "./scripts/sync-dependency-policy.mjs",
     "./scripts/resolve-dependency-policy-path.mjs": "./scripts/resolve-dependency-policy-path.mjs",
@@ -59,11 +63,13 @@
     "@typescript-eslint/parser": "8.58.2",
     "@vitest/eslint-plugin": "1.6.16",
     "@vue/eslint-config-prettier": "10.2.0",
+    "@vue/eslint-config-typescript": "14.7.0",
     "@vue/tsconfig": "0.9.1",
     "commitizen": "4.3.1",
     "eslint": "10.2.1",
     "eslint-plugin-prettier": "5.5.5",
     "eslint-plugin-vue": "10.8.0",
+    "lefthook": "2.1.6",
     "prettier": "3.8.3",
     "typescript": "5.9.3",
     "vue-eslint-parser": "10.4.0",

package/scripts/fg-devkit.mjs

@@ -8,6 +8,10 @@
  *   pnpm exec fg-devkit sync-project-configs   (VS Code + tooling sync; overwrites config files)
  *   pnpm exec fg-devkit sync-tooling-configs   (tooling sync only; overwrites config files)
  *   pnpm exec fg-devkit sync-vscode-settings
+ *   pnpm exec fg-devkit sync-consumer-scripts
+ *   pnpm exec fg-devkit setup-lefthook
+ *   pnpm exec fg-devkit prune-consumer-deps [--dry-run]
+ *   pnpm exec fg-devkit full-consumer-setup
  *   pnpm exec fg-devkit create-release [patch|minor|major]
  *   pnpm exec fg-devkit commit [cz-args...]   (Commitizen; uses fg-devkit bundled cz adapter)
  *   pnpm exec fg-devkit commit-vuln           (staged package.json version bumps → vuln() commit)
@@ -76,6 +80,79 @@ function runReleaseScript(args = []) {
   return r.status ?? 1
 }
 
+/** Run pnpm install in the consuming repo after setup steps. */
+function runPnpmInstall() {
+  const r = spawnSync('pnpm', ['install'], {
+    stdio: 'inherit',
+    cwd: process.cwd(),
+    env: process.env,
+  })
+  if (r.error) {
+    console.error('[fg-devkit]', r.error.message)
+    return 1
+  }
+  return r.status ?? 1
+}
+
+/** Run Lefthook from fg-devkit bundled dependency set. */
+function runBundledLefthook(args = []) {
+  let lefthookBin
+  try {
+    lefthookBin = require.resolve('lefthook/bin/index.js')
+  } catch {
+    console.error('[fg-devkit] Could not resolve bundled lefthook. Reinstall fg-devkit and retry.')
+    return 1
+  }
+
+  const r = spawnSync(process.execPath, [lefthookBin, ...args], {
+    stdio: 'inherit',
+    cwd: process.cwd(),
+    env: process.env,
+  })
+  if (r.error) {
+    console.error('[fg-devkit]', r.error.message)
+    return 1
+  }
+  return r.status ?? 1
+}
+
+/** Setup lefthook config and install git hooks in the consumer repository. */
+function runSetupLefthook() {
+  const syncCode = runNode('sync-consumer-lefthook.mjs')
+  if (syncCode !== 0) return syncCode
+  return runBundledLefthook(['install', '--reset-hooks-path'])
+}
+
+/**
+ * Full consumer setup flow:
+ * - Step 7: remove unnecessary deps
+ * - Sync required consumer scripts for fgd commands
+ * - Setup lefthook and migrate from husky/lint-staged
+ * - Step 3: sync project configs
+ * - Step 2: sync dependency policy
+ * - Then run pnpm install
+ */
+function runFullConsumerSetup() {
+  console.log('[fg-devkit] Running full consumer sync and setup')
+
+  const step7 = runNode('prune-consumer-deps.mjs')
+  if (step7 !== 0) return step7
+
+  const scriptsStep = runNode('sync-consumer-scripts.mjs')
+  if (scriptsStep !== 0) return scriptsStep
+
+  const hooksStep = runSetupLefthook()
+  if (hooksStep !== 0) return hooksStep
+
+  const step3 = runNode('sync-project-configs.mjs')
+  if (step3 !== 0) return step3
+
+  const step2 = runNode('sync-dependency-policy.mjs')
+  if (step2 !== 0) return step2
+
+  return runPnpmInstall()
+}
+
 /** Prompt release type in CLI before invoking release.sh to avoid a "stuck" terminal feeling. */
 async function promptReleaseType(rl) {
   console.log('\nSelect release type:')
@@ -219,6 +296,9 @@ const DIRECT_COMMANDS = {
   'sync-project-configs': 'sync-project-configs.mjs',
   'sync-tooling-configs': 'sync-tooling-configs.mjs',
   'sync-vscode-settings': 'sync-vscode-settings.mjs',
+  'sync-consumer-scripts': 'sync-consumer-scripts.mjs',
+  'setup-lefthook': 'setup-lefthook',
+  'prune-consumer-deps': 'prune-consumer-deps.mjs',
 }
 
 function printHelp() {
@@ -231,6 +311,10 @@ Commands:
   sync-project-configs            VS Code + tooling sync (overwrites config files)
   sync-tooling-configs            Tooling sync only (overwrites config files)
   sync-vscode-settings            Copy shared VS Code settings into .vscode/settings.json
+  sync-consumer-scripts           Enforce standard fgd scripts in consumer package.json
+  setup-lefthook                  Setup lefthook and migrate from husky/lint-staged
+  prune-consumer-deps [--dry-run] Remove consumer tooling deps bundled by fg-devkit
+  full-consumer-setup             Run: step 7 -> scripts -> lefthook -> step 3 -> step 2 -> pnpm install
   create-release [bump]         Version bump, git push, GitHub release (patch|minor|major; omit = prompt)
                                  (alias: createRelease)
   commit [args...]              Commitizen (git-cz) with fg-devkit bundled adapter
@@ -280,6 +364,21 @@ const MENU = [
     label: 'Commit vulnerability (Commitizen)',
     run: () => runCommitizen([], { FG_DEVKIT_CZ_DEFAULT_TYPE: 'vuln' }),
   },
+  {
+    key: '7',
+    label: 'Remove unnecessary deps in package.json',
+    run: () => runNode('prune-consumer-deps.mjs'),
+  },
+  {
+    key: '8',
+    label: 'Full consumer setup (7 -> scripts -> lefthook -> 3 -> 2 -> pnpm install)',
+    run: () => runFullConsumerSetup(),
+  },
+  {
+    key: '9',
+    label: 'Setup lefthook (migrate from husky/lint-staged)',
+    run: () => runSetupLefthook(),
+  },
 ]
 
 async function runInteractiveMenu() {
@@ -340,6 +439,14 @@ async function main() {
   }
 
   if (sub) {
+    if (sub === 'setup-lefthook') {
+      process.exitCode = runSetupLefthook()
+      return
+    }
+    if (sub === 'full-consumer-setup') {
+      process.exitCode = runFullConsumerSetup()
+      return
+    }
     if (sub === 'create-release' || sub === 'createRelease') {
       process.exitCode = runReleaseScript(rest)
       return

package/scripts/prune-consumer-deps.mjs

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+/**
+ * Removes tooling dependencies from a consuming repo that are now bundled by fg-devkit.
+ *
+ * By default this script edits package.json in the current working directory and removes
+ * known ESLint/Prettier/TypeScript/Commitizen packages from dependencies/devDependencies.
+ *
+ * Usage:
+ *   node node_modules/fg-devkit/scripts/prune-consumer-deps.mjs
+ *   pnpm exec fg-devkit prune-consumer-deps
+ *   pnpm exec fg-devkit prune-consumer-deps --dry-run
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+
+const BUNDLED_TOOLING_PACKAGES = new Set([
+  '@intlify/eslint-plugin-vue-i18n',
+  '@typescript-eslint/eslint-plugin',
+  '@typescript-eslint/parser',
+  '@vitest/eslint-plugin',
+  '@vue/eslint-config-prettier',
+  '@vue/eslint-config-typescript',
+  '@vue/tsconfig',
+  '@rushstack/eslint-patch',
+  'commitizen',
+  'eslint',
+  'eslint-plugin-prettier',
+  'eslint-plugin-vue',
+  'husky',
+  'jsonc-eslint-parser',
+  'lint-staged',
+  'lefthook',
+  'prettier',
+  'typescript',
+  'yaml-eslint-parser',
+  'vue-eslint-parser',
+  'vue-tsc',
+])
+
+function readPackageJson(packageJsonPath) {
+  if (!fs.existsSync(packageJsonPath)) {
+    console.error(`[prune-consumer-deps] No package.json found at ${packageJsonPath}`)
+    process.exit(1)
+  }
+  try {
+    return JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+  } catch (err) {
+    console.error(`[prune-consumer-deps] Failed to parse package.json: ${err.message}`)
+    process.exit(1)
+  }
+}
+
+function removeFromSection(pkg, sectionName, removed) {
+  const section = pkg[sectionName]
+  if (!section || typeof section !== 'object') {
+    return
+  }
+  for (const name of Object.keys(section)) {
+    if (BUNDLED_TOOLING_PACKAGES.has(name)) {
+      removed.push(`${sectionName}.${name}@${section[name]}`)
+      delete section[name]
+    }
+  }
+  if (Object.keys(section).length === 0) {
+    delete pkg[sectionName]
+  }
+}
+
+function main() {
+  const dryRun = process.argv.includes('--dry-run')
+  const projectRoot = process.cwd()
+  const packageJsonPath = path.join(projectRoot, 'package.json')
+  const pkg = readPackageJson(packageJsonPath)
+
+  const removed = []
+  removeFromSection(pkg, 'dependencies', removed)
+  removeFromSection(pkg, 'devDependencies', removed)
+
+  if (removed.length === 0) {
+    console.log('[prune-consumer-deps] No bundled tooling dependencies found to remove.')
+    return
+  }
+
+  console.log('[prune-consumer-deps] Removed entries:')
+  for (const line of removed) {
+    console.log(`  - ${line}`)
+  }
+
+  if (dryRun) {
+    console.log('\n[prune-consumer-deps] Dry run only; package.json was not modified.')
+    return
+  }
+
+  fs.writeFileSync(packageJsonPath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8')
+  console.log('\n[prune-consumer-deps] Updated package.json. Run pnpm install to refresh lockfile.')
+}
+
+main()

package/scripts/refresh-dependency-policy-from-repos.mjs

@@ -29,6 +29,7 @@ import { collectPinViolations } from './dependency-policy-pins.mjs'
 
 const scriptDir = path.dirname(fileURLToPath(import.meta.url))
 const fgDevkitRoot = path.resolve(scriptDir, '..')
+const fgDevkitPackageJsonPath = path.join(fgDevkitRoot, 'package.json')
 
 const projectsRoot = process.argv[2]
   ? path.resolve(process.cwd(), process.argv[2])
@@ -41,6 +42,15 @@ const policyPath = process.argv[3]
 /** Relative paths under projectsRoot whose package.json files are ignored (maintainer choice). */
 /** Relative path prefixes under projectsRoot to skip when scanning (add repo names as needed). */
 const SKIP_DIR_PREFIXES = []
+const EXTRA_TOOLING_EXCLUDES = new Set(['husky', 'lint-staged', '@rushstack/eslint-patch', 'jsonc-eslint-parser', 'yaml-eslint-parser'])
+const EXCLUDED_POLICY_PACKAGES = (() => {
+  try {
+    const pkg = JSON.parse(fs.readFileSync(fgDevkitPackageJsonPath, 'utf8'))
+    return new Set([...Object.keys(pkg.dependencies ?? {}), ...EXTRA_TOOLING_EXCLUDES])
+  } catch {
+    return EXTRA_TOOLING_EXCLUDES
+  }
+})()
 
 /** Recursively collect every package.json path under dir, skipping node_modules and .git. */
 function walk(dir, acc = []) {
@@ -147,6 +157,9 @@ const outAny = {}
 
 // Pick highest semver per package and assign to dependencies, devDependencies, or managedAnywhere.
 for (const [name, u] of usage) {
+  if (EXCLUDED_POLICY_PACKAGES.has(name)) {
+    continue
+  }
   if (u.partsList.length === 0) {
     continue
   }

package/scripts/sync-consumer-lefthook.mjs

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+/**
+ * Syncs Lefthook setup into a consuming repo:
+ * - writes lefthook.yml from fg-devkit template
+ * - removes legacy .husky directory (if present)
+ * - removes legacy lint-staged config block from package.json
+ * - removes legacy prepare hook scripts for husky/lefthook bootstrap
+ *
+ * Usage:
+ *   node node_modules/fg-devkit/scripts/sync-consumer-lefthook.mjs
+ *   pnpm exec fg-devkit setup-lefthook
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const projectRoot = process.cwd()
+const scriptDir = path.dirname(fileURLToPath(import.meta.url))
+const fgRoot = path.resolve(scriptDir, '..')
+
+const lefthookTemplate = path.join(fgRoot, 'configs', 'lefthook.yml')
+const lefthookTarget = path.join(projectRoot, 'lefthook.yml')
+const huskyDir = path.join(projectRoot, '.husky')
+const packageJsonPath = path.join(projectRoot, 'package.json')
+
+if (!fs.existsSync(lefthookTemplate)) {
+  console.error(`[sync-consumer-lefthook] Missing template: ${lefthookTemplate}`)
+  process.exit(1)
+}
+
+if (!fs.existsSync(packageJsonPath)) {
+  console.error(`[sync-consumer-lefthook] package.json not found at ${packageJsonPath}`)
+  process.exit(1)
+}
+
+let pkg
+try {
+  pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+} catch (err) {
+  console.error(`[sync-consumer-lefthook] Failed to parse package.json: ${err.message}`)
+  process.exit(1)
+}
+
+pkg.scripts = pkg.scripts && typeof pkg.scripts === 'object' ? pkg.scripts : {}
+if (
+  pkg.scripts.prepare &&
+  (pkg.scripts.prepare.includes('husky') || pkg.scripts.prepare.includes('setup-lefthook'))
+) {
+  delete pkg.scripts.prepare
+}
+
+if (pkg['lint-staged'] !== undefined) {
+  delete pkg['lint-staged']
+}
+
+try {
+  fs.copyFileSync(lefthookTemplate, lefthookTarget)
+  fs.writeFileSync(packageJsonPath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8')
+  if (fs.existsSync(huskyDir)) {
+    fs.rmSync(huskyDir, { recursive: true, force: true })
+  }
+  console.log('[sync-consumer-lefthook] Synced lefthook.yml and removed .husky/lint-staged legacy setup.')
+} catch (err) {
+  console.error(`[sync-consumer-lefthook] ${err.message}`)
+  process.exit(1)
+}

package/scripts/sync-consumer-scripts.mjs

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+/**
+ * Syncs standard fg-devkit npm scripts into a consuming repo package.json.
+ *
+ * This updates only known script keys and leaves all other scripts untouched.
+ *
+ * Usage:
+ *   node node_modules/fg-devkit/scripts/sync-consumer-scripts.mjs
+ *   pnpm exec fg-devkit sync-consumer-scripts
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+
+const REQUIRED_SCRIPTS = {
+  'lint:ts': 'pnpm exec fgd typecheck',
+  lint: 'pnpm exec fgd lint --fix .',
+  'lint-check': 'pnpm exec fgd lint .',
+  'sync:vscode:settings': 'pnpm exec fgd sync-vscode-settings',
+  'create:release': 'pnpm exec fgd create-release',
+}
+
+function main() {
+  const packageJsonPath = path.join(process.cwd(), 'package.json')
+  if (!fs.existsSync(packageJsonPath)) {
+    console.error(`[sync-consumer-scripts] package.json not found at ${packageJsonPath}`)
+    process.exit(1)
+  }
+
+  let pkg
+  try {
+    pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
+  } catch (err) {
+    console.error(`[sync-consumer-scripts] Failed to parse package.json: ${err.message}`)
+    process.exit(1)
+  }
+
+  pkg.scripts = pkg.scripts && typeof pkg.scripts === 'object' ? pkg.scripts : {}
+
+  const changed = []
+  for (const [name, value] of Object.entries(REQUIRED_SCRIPTS)) {
+    if (pkg.scripts[name] !== value) {
+      pkg.scripts[name] = value
+      changed.push(name)
+    }
+  }
+
+  fs.writeFileSync(packageJsonPath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8')
+
+  if (changed.length === 0) {
+    console.log('[sync-consumer-scripts] package.json scripts already up to date.')
+    return
+  }
+
+  console.log('[sync-consumer-scripts] Updated scripts:')
+  for (const name of changed) {
+    console.log(`  - ${name}`)
+  }
+}
+
+main()