fg-devkit 1.1.0 → 1.2.0

package/README.md

@@ -45,6 +45,13 @@ 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
+```
+
 ## 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/tsconfig.base.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
-  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "extends": "./tsconfig.vue-dom.json",
   "compilerOptions": {
     "target": "ES2022",
     "lib": ["ES2022", "DOM", "DOM.Iterable"],
@@ -16,10 +16,7 @@
     "allowSyntheticDefaultImports": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "preserveSymlinks": false,
-    "paths": {
-      "@/*": ["./src/*"]
-    }
+    "preserveSymlinks": false
   },
   "vueCompilerOptions": {
     "strictTemplates": true,

package/configs/tsconfig.vue-base.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "noEmit": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "moduleDetection": "force",
+    "jsx": "preserve",
+    "jsxImportSource": "vue",
+    "noImplicitThis": true,
+    "strict": true,
+    "verbatimModuleSyntax": true,
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "libReplacement": false,
+    "skipLibCheck": true
+  }
+}

package/configs/tsconfig.vue-dom.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.vue-base.json",
+  "compilerOptions": {
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "types": []
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fg-devkit",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Shared configs, scripts, and DX tooling for Vue / TypeScript frontend repos",
   "type": "module",
   "license": "UNLICENSED",
@@ -24,6 +24,7 @@
     "./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/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",
@@ -48,12 +49,18 @@
     "typescript",
     "vue"
   ],
+  "config": {
+    "commitizen": {
+      "path": "./scripts/cz/cz-adapter.cjs"
+    }
+  },
   "dependencies": {
     "@intlify/eslint-plugin-vue-i18n": "4.3.0",
     "@typescript-eslint/eslint-plugin": "8.58.2",
     "@typescript-eslint/parser": "8.58.2",
     "@vitest/eslint-plugin": "1.6.16",
     "@vue/eslint-config-prettier": "10.2.0",
+    "@vue/tsconfig": "0.9.1",
     "commitizen": "4.3.1",
     "eslint": "10.2.1",
     "eslint-plugin-prettier": "5.5.5",

package/scripts/cz/cz-adapter.cjs

@@ -4,6 +4,7 @@
  */
 module.exports = {
   prompter(cz, commit) {
+    const defaultType = process.env.FG_DEVKIT_CZ_DEFAULT_TYPE;
     const types = [
       { value: "feat", name: "feat(scope): Added" },
       { value: "fix", name: "fix(scope): Fixed" },
@@ -22,6 +23,7 @@ module.exports = {
         name: "change_type",
         message: "Select the type of change you are committing",
         choices: types,
+        default: defaultType && types.some((t) => t.value === defaultType) ? defaultType : undefined,
       },
       {
         type: "input",

package/scripts/fg-devkit.mjs

@@ -8,8 +8,9 @@
  *   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 prune-consumer-deps [--dry-run]
  *   pnpm exec fg-devkit create-release [patch|minor|major]
- *   pnpm exec fg-devkit commit [cz-args...]   (Commitizen; uses package.json config.commitizen.path)
+ *   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)
  *   pnpm exec fg-devkit lint [eslint-args...]     (run ESLint with fg-devkit bundled packages)
  *   pnpm exec fg-devkit lint-fix [eslint-args...] (same as lint plus --fix)
@@ -102,21 +103,40 @@ async function promptReleaseType(rl) {
 
 /**
  * Run Commitizen from fg-devkit's bundled dependency set.
- * Uses the consuming repo's config.commitizen.path when present.
+ * Always forces fg-devkit's bundled cz adapter so it stays interactive.
  */
-function runCommitizen(args = []) {
-  let gitCzBin
+function runCommitizen(args = [], extraEnv = {}) {
+  let bootstrapBin
+  let commitizenPkgDir
+  const adapterPath = path.join(scriptDir, 'cz', 'cz-adapter.cjs')
   try {
-    gitCzBin = require.resolve('commitizen/bin/git-cz')
+    bootstrapBin = require.resolve('commitizen/dist/cli/git-cz.js')
+    commitizenPkgDir = path.dirname(require.resolve('commitizen/package.json'))
   } catch {
     console.error('[fg-devkit] Could not resolve bundled commitizen. Reinstall fg-devkit and retry.')
     return 1
   }
 
-  const r = spawnSync(process.execPath, [gitCzBin, ...args], {
+  const launcher = `
+const { bootstrap } = require(${JSON.stringify(bootstrapBin)});
+const argv = ['node', 'git-cz', ...JSON.parse(process.env.FG_DEVKIT_CZ_ARGS || '[]')];
+bootstrap(
+  {
+    cliPath: ${JSON.stringify(commitizenPkgDir)},
+    config: { path: ${JSON.stringify(adapterPath)} },
+  },
+  argv
+);
+`
+
+  const r = spawnSync(process.execPath, ['-e', launcher], {
     stdio: 'inherit',
     cwd: process.cwd(),
-    env: process.env,
+    env: {
+      ...process.env,
+      FG_DEVKIT_CZ_ARGS: JSON.stringify(args),
+      ...extraEnv,
+    },
   })
   if (r.error) {
     console.error('[fg-devkit]', r.error.message)
@@ -200,6 +220,7 @@ const DIRECT_COMMANDS = {
   'sync-project-configs': 'sync-project-configs.mjs',
   'sync-tooling-configs': 'sync-tooling-configs.mjs',
   'sync-vscode-settings': 'sync-vscode-settings.mjs',
+  'prune-consumer-deps': 'prune-consumer-deps.mjs',
 }
 
 function printHelp() {
@@ -212,9 +233,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
+  prune-consumer-deps [--dry-run] Remove consumer tooling deps bundled by fg-devkit
   create-release [bump]         Version bump, git push, GitHub release (patch|minor|major; omit = prompt)
                                  (alias: createRelease)
-  commit [args...]              Commitizen (git-cz); uses config.commitizen.path in package.json
+  commit [args...]              Commitizen (git-cz) with fg-devkit bundled adapter
   commit-vuln                   Commit staged dependency bumps as vuln() (alias: vuln-commit)
   lint [eslint-args...]         Run ESLint using fg-devkit bundled ESLint stack
   lint-fix [eslint-args...]     Run ESLint with --fix using fg-devkit bundled ESLint stack
@@ -259,7 +281,12 @@ const MENU = [
   {
     key: '6',
     label: 'Commit vulnerability (Commitizen)',
-    run: () => runNode('vuln-commit.mjs'),
+    run: () => runCommitizen([], { FG_DEVKIT_CZ_DEFAULT_TYPE: 'vuln' }),
+  },
+  {
+    key: '7',
+    label: 'Remove deps unnecessary deps in package.json',
+    run: () => runNode('prune-consumer-deps.mjs'),
   },
 ]
 
@@ -287,27 +314,29 @@ async function runInteractiveMenu() {
     return 1
   }
 
-  let exitCode = 0
-  try {
-    let out
-    if (item.key === '4') {
-      const bumpType = await promptReleaseType(rl)
-      if (!bumpType) {
-        return 0
-      }
-      out = runReleaseScript([bumpType])
-    } else {
-      out = item.run()
-    }
-    if (typeof out === 'object' && out !== null && typeof out.then === 'function') {
-      exitCode = await out
-    } else if (typeof out === 'number') {
-      exitCode = out
+  let out
+  if (item.key === '4') {
+    const bumpType = await promptReleaseType(rl)
+    if (!bumpType) {
+      rl.close()
+      return 0
     }
-  } finally {
+    // Close menu readline before spawning interactive child processes.
+    rl.close()
+    out = runReleaseScript([bumpType])
+  } else {
+    // Close menu readline before spawning interactive child processes.
     rl.close()
+    out = item.run()
+  }
+
+  if (typeof out === 'object' && out !== null && typeof out.then === 'function') {
+    return await out
+  }
+  if (typeof out === 'number') {
+    return out
   }
-  return exitCode
+  return 0
 }
 
 async function main() {

package/scripts/prune-consumer-deps.mjs

@@ -0,0 +1,92 @@
+#!/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/tsconfig',
+  'commitizen',
+  'eslint',
+  'eslint-plugin-prettier',
+  'eslint-plugin-vue',
+  'prettier',
+  'typescript',
+  '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()