fg-devkit 1.5.2 → 1.6.0

package/scripts/scaffold-vue.mjs

@@ -0,0 +1,183 @@
+#!/usr/bin/env node
+/**
+ * Copies fg-devkit/scaffold/vue into a new directory and replaces PLACEHOLDER_* tokens.
+ *
+ * Usage:
+ *   pnpm exec fg-devkit scaffold-vue <target-dir> [options]
+ *
+ * Options (all optional):
+ *   --name <string>              Human-readable app name (default: My App)
+ *   --slug <string>              package.json name / slug (default: my-app)
+ *   --docker-image <string>      Docker registry image without tag (default: myorg/my-app-ui)
+ *   --jenkins-library <string>   Jenkins shared library name (default: my-shared-library)
+ *   --jenkins-node-image <string> CI Docker image for Node (default: node:22-bookworm)
+ *   --jenkins-docker-label <string> Jenkins label for docker-build agents (default: docker)
+ *   --jenkins-registry-cred <string> Jenkins credentialsId for Docker registry (default: docker-registry)
+ *   --jenkins-poeditor-cred <string> Jenkins credentialsId for POEditor API key (default: poeditor_api_key)
+ *   --dev-branch <string>        Primary non-master dev branch name (default: develop)
+ *   --poeditor-project-id <string> POEditor numeric project id (default: 000000)
+ *   --env-dev-host <string>      window.location.host value for development (default: dev.app.local:5173)
+ *   --env-preprod-host <string>  host for preprod (default: preprod.app.example)
+ *   --env-prod-host <string>     host for production (default: app.example)
+ *   --copyright-holder <string>  Legal name in LICENSE (default: Your organization)
+ *   --copyright-year <string>    Year in LICENSE (default: current calendar year)
+ *   --force                      Allow a non-empty target (overwrites same paths as in the template)
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const scriptDir = path.dirname(fileURLToPath(import.meta.url))
+const fgDevkitRoot = path.resolve(scriptDir, '..')
+const scaffoldRoot = path.join(fgDevkitRoot, 'scaffold/vue')
+
+/** True if the directory does not exist, is empty, or only contains a fresh clone (.git). */
+function isEffectivelyEmptyForScaffold(dir) {
+  if (!fs.existsSync(dir)) return true
+  const names = fs.readdirSync(dir).filter((n) => n !== '.DS_Store')
+  if (names.length === 0) return true
+  if (names.length === 1 && names[0] === '.git') return true
+  return false
+}
+
+function parseArgs(argv) {
+  const positional = []
+  const flags = new Map()
+  for (let i = 0; i < argv.length; i += 1) {
+    const a = argv[i]
+    if (a.startsWith('--')) {
+      const key = a.slice(2)
+      const next = argv[i + 1]
+      if (next && !next.startsWith('--')) {
+        flags.set(key, next)
+        i += 1
+      } else {
+        flags.set(key, 'true')
+      }
+    } else {
+      positional.push(a)
+    }
+  }
+  return { positional, flags }
+}
+
+function shouldTreatAsBinary(relPath) {
+  return /\.(png|jpe?g|gif|webp|ico|woff2?|eot|ttf|zip|pdf)$/i.test(relPath)
+}
+
+function replacePlaceholders(content, map) {
+  let out = content
+  for (const [token, value] of Object.entries(map)) {
+    out = out.split(token).join(value)
+  }
+  return out
+}
+
+function walk(dir, callback) {
+  for (const name of fs.readdirSync(dir, { withFileTypes: true })) {
+    const p = path.join(dir, name.name)
+    if (name.isDirectory()) {
+      walk(p, callback)
+    } else {
+      callback(p)
+    }
+  }
+}
+
+function copyScaffold(targetDir, replacements) {
+  fs.mkdirSync(targetDir, { recursive: true })
+
+  const copyRecursive = (src, dest) => {
+    for (const name of fs.readdirSync(src, { withFileTypes: true })) {
+      const from = path.join(src, name.name)
+      const to = path.join(dest, name.name)
+      if (name.isDirectory()) {
+        fs.mkdirSync(to, { recursive: true })
+        copyRecursive(from, to)
+      } else {
+        const rel = path.relative(scaffoldRoot, from)
+        if (shouldTreatAsBinary(rel)) {
+          fs.copyFileSync(from, to)
+        } else {
+          const raw = fs.readFileSync(from, 'utf8')
+          fs.writeFileSync(to, replacePlaceholders(raw, replacements), 'utf8')
+        }
+      }
+    }
+  }
+
+  copyRecursive(scaffoldRoot, targetDir)
+
+  walk(targetDir, (filePath) => {
+    if (filePath.endsWith('.sh')) {
+      try {
+        fs.chmodSync(filePath, 0o755)
+      } catch {
+        /* ignore */
+      }
+    }
+  })
+}
+
+function main() {
+  const { positional, flags } = parseArgs(process.argv.slice(2))
+  const targetDirArg = positional[0]
+  if (!targetDirArg) {
+    console.error('[scaffold-vue] Missing target directory.')
+    console.error('Usage: pnpm exec fg-devkit scaffold-vue <target-dir> [--name …] [--slug …] …')
+    process.exit(1)
+  }
+
+  const targetDir = path.resolve(process.cwd(), targetDirArg)
+  const force = flags.get('force') === 'true'
+  if (!force && !isEffectivelyEmptyForScaffold(targetDir)) {
+    console.error('[scaffold-vue] Target directory is not empty:', targetDir)
+    console.error('[scaffold-vue] Use an empty directory, a clone with only .git, or pass --force (overwrites paths that exist in the template).')
+    process.exit(1)
+  }
+
+  if (!fs.existsSync(scaffoldRoot)) {
+    console.error('[scaffold-vue] Scaffold template missing:', scaffoldRoot)
+    process.exit(1)
+  }
+
+  const name = flags.get('name') ?? 'My App'
+  const slug = flags.get('slug') ?? 'my-app'
+  const dockerImage = flags.get('docker-image') ?? 'myorg/my-app-ui'
+  const jenkinsLibrary = flags.get('jenkins-library') ?? 'my-shared-library'
+  const jenkinsNodeImage = flags.get('jenkins-node-image') ?? 'node:22-bookworm'
+  const jenkinsDockerLabel = flags.get('jenkins-docker-label') ?? 'docker'
+  const jenkinsRegistryCred = flags.get('jenkins-registry-cred') ?? 'docker-registry'
+  const jenkinsPoeditorCred = flags.get('jenkins-poeditor-cred') ?? 'poeditor_api_key'
+  const devBranch = flags.get('dev-branch') ?? 'develop'
+  const poeditorProjectId = flags.get('poeditor-project-id') ?? '000000'
+  const envDevHost = flags.get('env-dev-host') ?? 'dev.app.local:5173'
+  const envPreprodHost = flags.get('env-preprod-host') ?? 'preprod.app.example'
+  const envProdHost = flags.get('env-prod-host') ?? 'app.example'
+  const copyrightHolder = flags.get('copyright-holder') ?? 'Your organization'
+  const copyrightYear = flags.get('copyright-year') ?? String(new Date().getFullYear())
+
+  const replacements = {
+    PLACEHOLDER_APP_NAME: name,
+    PLACEHOLDER_APP_SLUG: slug,
+    PLACEHOLDER_DOCKER_REGISTRY_IMAGE: dockerImage,
+    PLACEHOLDER_JENKINS_SHARED_LIBRARY: jenkinsLibrary,
+    PLACEHOLDER_JENKINS_NODE_IMAGE: jenkinsNodeImage,
+    PLACEHOLDER_JENKINS_DOCKER_BUILD_LABEL: jenkinsDockerLabel,
+    PLACEHOLDER_DOCKER_REGISTRY_CREDENTIAL_ID: jenkinsRegistryCred,
+    PLACEHOLDER_POEDITOR_CREDENTIAL_ID: jenkinsPoeditorCred,
+    PLACEHOLDER_PRIMARY_DEV_BRANCH: devBranch,
+    PLACEHOLDER_POEDITOR_PROJECT_ID: poeditorProjectId,
+    PLACEHOLDER_ENV_DEV_HOST: envDevHost,
+    PLACEHOLDER_ENV_PREPROD_HOST: envPreprodHost,
+    PLACEHOLDER_ENV_PROD_HOST: envProdHost,
+    PLACEHOLDER_COPYRIGHT_HOLDER: copyrightHolder,
+    PLACEHOLDER_COPYRIGHT_YEAR: copyrightYear,
+  }
+
+  copyScaffold(targetDir, replacements)
+  console.log('[scaffold-vue] Created project at', targetDir)
+}
+
+main()

package/scripts/sync-scaffold-vue-deps.mjs

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+/**
+ * Aligns scaffold/vue/package.json dependency versions with dependency-policy.vue-workspace.json.
+ * Also pins scaffold devDependency `fg-devkit` to the fg-devkit package version at publish time.
+ *
+ * Invoked automatically after refresh-dependency-policy-from-repos.mjs writes the policy, and
+ * can be run manually: node …/sync-scaffold-vue-deps.mjs [policy-file]
+ */
+
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { resolveDependencyPolicyPath } from './resolve-dependency-policy-path.mjs'
+
+/**
+ * @param {{ fgDevkitRoot: string, policyPath: string }} options
+ */
+export function syncScaffoldVueDepsFromPolicy(options) {
+  const { fgDevkitRoot, policyPath } = options
+  const policy = JSON.parse(fs.readFileSync(policyPath, 'utf8'))
+  const scaffoldPkgPath = path.join(fgDevkitRoot, 'scaffold/vue/package.json')
+  if (!fs.existsSync(scaffoldPkgPath)) {
+    console.warn('[sync-scaffold-vue-deps] No scaffold package at', scaffoldPkgPath)
+    return
+  }
+  const pkg = JSON.parse(fs.readFileSync(scaffoldPkgPath, 'utf8'))
+
+  const resolveVersion = (name) =>
+    policy.managedDependencies?.dependencies?.[name] ??
+    policy.managedDependencies?.devDependencies?.[name] ??
+    policy.managedAnywhere?.[name]
+
+  const fgDevkitPkgPath = path.join(fgDevkitRoot, 'package.json')
+  const fgDevkitPkg = JSON.parse(fs.readFileSync(fgDevkitPkgPath, 'utf8'))
+  const fgDevkitVersion = fgDevkitPkg.version
+
+  const applySection = (section) => {
+    const deps = pkg[section]
+    if (!deps) return
+    for (const name of Object.keys(deps)) {
+      if (name === 'fg-devkit' && section === 'devDependencies') {
+        deps[name] = fgDevkitVersion
+        continue
+      }
+      const v = resolveVersion(name)
+      if (v !== undefined) {
+        deps[name] = v
+      }
+    }
+  }
+
+  applySection('dependencies')
+  applySection('devDependencies')
+
+  fs.writeFileSync(scaffoldPkgPath, `${JSON.stringify(pkg, null, 2)}\n`)
+  console.log('[sync-scaffold-vue-deps] Updated', scaffoldPkgPath)
+}
+
+const scriptDir = path.dirname(fileURLToPath(import.meta.url))
+const fgDevkitRoot = path.resolve(scriptDir, '..')
+const invokedPath = path.resolve(process.argv[1] ?? '')
+const selfPath = path.resolve(fileURLToPath(import.meta.url))
+
+if (invokedPath === selfPath) {
+  const policyPath = resolveDependencyPolicyPath(scriptDir, process.cwd(), process.argv)
+  syncScaffoldVueDepsFromPolicy({ fgDevkitRoot, policyPath })
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "noEmit": true,
+    "skipLibCheck": true,
+    "allowJs": true,
+    "checkJs": false,
+    "moduleResolution": "bundler",
+    "target": "ES2022",
+    "module": "ES2022"
+  },
+  "exclude": ["node_modules", "scaffold"]
+}