baldart 4.51.0 → 4.52.0

package/src/utils/i18n-gate.js

@@ -0,0 +1,195 @@
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+/**
+ * i18n anti-hardcoded gate — BALDART-owned standalone ESLint config (since v4.52.0).
+ *
+ * The "no hardcoded user-facing strings" rule must be enforced DETERMINISTICALLY,
+ * regardless of the consumer's lint setup. The most-adopted rule
+ * (`eslint-plugin-i18next` `no-literal-string`) is framework-agnostic (it flags
+ * literal JSX text/attributes for next-intl / i18next / vue / any stack) BUT it is
+ * an ESLint plugin — a Biome-only toolchain (BALDART's default) does not run it,
+ * and wiring it into the user's own ESLint config is fragile.
+ *
+ * So BALDART writes a SEPARATE, self-contained config it owns and runs ESLint
+ * against it with an explicit `--config`. This never touches the user's main lint
+ * config, runs the i18n rule deterministically, and works on Biome projects (a
+ * dedicated ESLint invocation just for this gate).
+ *
+ * ESLint era matters: ESLint 9 uses FLAT config (`eslint.i18n.config.mjs`); ESLint
+ * 8 uses LEGACY rc config (`.eslintrc.i18n.json` + `--no-eslintrc`). We detect the
+ * consumer's installed/declared ESLint major and emit the matching pair so the
+ * gate command actually runs instead of erroring on every file. `mode: 'jsx-only'`
+ * is the default — it flags JSX text AND user-facing attributes (title /
+ * placeholder / alt / aria-label), matching the prose contract; non-JSX
+ * imperative strings (e.g. `toast("Saved")`) remain the code-reviewer backstop's
+ * domain. Verified against ESLint 9 + eslint-plugin-i18next: Bad.tsx (3 findings)
+ * fails, Good.tsx (t()) passes.
+ */
+const FLAT_CONFIG = 'eslint.i18n.config.mjs';
+const LEGACY_CONFIG = '.eslintrc.i18n.json';
+const MODE = 'jsx-only';
+
+const FLAT_COMMAND = `npx eslint --config ${FLAT_CONFIG} .`;
+const LEGACY_COMMAND = `npx eslint --no-eslintrc -c ${LEGACY_CONFIG} --ext .js,.jsx,.ts,.tsx .`;
+// Default advertised command (flat / ESLint 9). `resolveLintCommand` picks the
+// real one based on which config file is on disk.
+const LINT_COMMAND = FLAT_COMMAND;
+
+const FLAT_DEPS = ['eslint', 'eslint-plugin-i18next', 'typescript-eslint'];
+const LEGACY_DEPS = ['eslint', 'eslint-plugin-i18next', '@typescript-eslint/parser'];
+// Advertised set (flat). `setup` installs the era-correct one.
+const DEV_DEPS = FLAT_DEPS;
+
+const FLAT_BODY = `// BALDART-owned i18n anti-hardcoded gate (generated by \`baldart configure\` /
+// \`baldart doctor\`, since v4.52.0). STANDALONE — this file does NOT affect your
+// main ESLint setup. ESLint 9 flat config. Run via: ${FLAT_COMMAND}
+//
+// Fails when a user-facing string is hardcoded instead of routed through your i18n
+// translation function. \`mode: '${MODE}'\` flags JSX text AND user-facing
+// attributes (title/placeholder/alt/aria-label). Broaden to 'all' for non-JSX
+// strings too, or add to \`ignores\` / the rule allowlist — BALDART writes this file
+// only when absent and never overwrites your edits.
+import i18next from 'eslint-plugin-i18next';
+import tseslint from 'typescript-eslint';
+
+export default [
+  {
+    files: ['**/*.{js,jsx,ts,tsx,mjs,cjs}'],
+    ignores: [
+      '**/node_modules/**', '**/dist/**', '**/build/**', '**/.next/**',
+      '**/out/**', '**/coverage/**', '**/*.test.*', '**/*.spec.*',
+    ],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: { ecmaFeatures: { jsx: true }, sourceType: 'module' },
+    },
+    plugins: { i18next },
+    rules: {
+      'i18next/no-literal-string': ['error', { mode: '${MODE}' }],
+    },
+  },
+];
+`;
+
+const LEGACY_BODY = JSON.stringify({
+  root: true,
+  parser: '@typescript-eslint/parser',
+  parserOptions: { ecmaFeatures: { jsx: true }, sourceType: 'module' },
+  plugins: ['i18next'],
+  rules: { 'i18next/no-literal-string': ['error', { mode: MODE }] },
+  ignorePatterns: ['node_modules/', 'dist/', 'build/', '.next/', 'out/', 'coverage/', '*.test.*', '*.spec.*'],
+}, null, 2) + '\n';
+
+function hasPackageJson(cwd = process.cwd()) {
+  return fs.existsSync(path.join(cwd, 'package.json'));
+}
+
+function readPkgDeps(cwd = process.cwd()) {
+  try {
+    const pkg = JSON.parse(fs.readFileSync(path.join(cwd, 'package.json'), 'utf8'));
+    return { ...(pkg.dependencies || {}), ...(pkg.devDependencies || {}) };
+  } catch { return {}; }
+}
+
+/**
+ * Detect the consumer's ESLint major. Prefers the installed version, then the
+ * declared range, then null (absent → a fresh install gets ESLint 9 → flat).
+ */
+function eslintMajor(cwd = process.cwd()) {
+  try {
+    const p = JSON.parse(fs.readFileSync(path.join(cwd, 'node_modules', 'eslint', 'package.json'), 'utf8'));
+    const m = parseInt(String(p.version).split('.')[0], 10);
+    if (!Number.isNaN(m)) return m;
+  } catch { /* not installed */ }
+  const deps = readPkgDeps(cwd);
+  if (deps.eslint) {
+    const m = String(deps.eslint).match(/(\d+)/);
+    if (m) return parseInt(m[1], 10);
+  }
+  return null;
+}
+
+/** Legacy when an EXISTING ESLint 8 is detected; flat otherwise (incl. fresh). */
+function useLegacy(cwd = process.cwd()) {
+  return eslintMajor(cwd) === 8;
+}
+
+function configFilename(cwd = process.cwd()) {
+  return useLegacy(cwd) ? LEGACY_CONFIG : FLAT_CONFIG;
+}
+
+function depsFor(cwd = process.cwd()) {
+  return useLegacy(cwd) ? LEGACY_DEPS : FLAT_DEPS;
+}
+
+/** True when EITHER era's config file is on disk. */
+function isConfigPresent(cwd = process.cwd()) {
+  return fs.existsSync(path.join(cwd, FLAT_CONFIG)) || fs.existsSync(path.join(cwd, LEGACY_CONFIG));
+}
+
+/** Write the era-correct standalone config — only when absent. Never overwrites. */
+function writeConfig(cwd = process.cwd()) {
+  const legacy = useLegacy(cwd);
+  const file = legacy ? LEGACY_CONFIG : FLAT_CONFIG;
+  const p = path.join(cwd, file);
+  if (isConfigPresent(cwd)) return { status: 'exists', path: p, file };
+  fs.writeFileSync(p, legacy ? LEGACY_BODY : FLAT_BODY, 'utf8');
+  return { status: 'written', path: p, file };
+}
+
+/** True when every era-correct gate dependency is declared in package.json. */
+function depsInstalled(cwd = process.cwd()) {
+  const deps = readPkgDeps(cwd);
+  return depsFor(cwd).every((d) => d in deps);
+}
+
+/** Install the era-correct gate dev dependencies. Throws on failure. */
+function installDeps(cwd = process.cwd()) {
+  execSync(`npm install -D ${depsFor(cwd).join(' ')}`, { cwd, stdio: 'ignore' });
+}
+
+/**
+ * Full setup: install deps (if a package.json exists) + write the era-correct
+ * config. Returns a structured result; never throws (errors are reported).
+ */
+function setup(cwd = process.cwd()) {
+  const result = { installed: false, config: null, error: null, era: useLegacy(cwd) ? 'legacy' : 'flat' };
+  try {
+    if (hasPackageJson(cwd) && !depsInstalled(cwd)) {
+      installDeps(cwd);
+      result.installed = true;
+    }
+    result.config = writeConfig(cwd);
+  } catch (e) {
+    result.error = e.message;
+  }
+  return result;
+}
+
+/**
+ * Resolve the command a gate runner should execute. Order: explicit
+ * `i18n.lint_command` from config → the on-disk standalone config (flat or
+ * legacy) by convention → null (gate SKIPs, never a silent pass).
+ */
+function resolveLintCommand(cwd = process.cwd(), config = null) {
+  const explicit = config && config.i18n && config.i18n.lint_command;
+  if (explicit) return explicit;
+  if (fs.existsSync(path.join(cwd, FLAT_CONFIG))) return FLAT_COMMAND;
+  if (fs.existsSync(path.join(cwd, LEGACY_CONFIG))) return LEGACY_COMMAND;
+  return null;
+}
+
+/** The command configure should record for this project's ESLint era. */
+function commandForCwd(cwd = process.cwd()) {
+  return useLegacy(cwd) ? LEGACY_COMMAND : FLAT_COMMAND;
+}
+
+module.exports = {
+  FLAT_CONFIG, LEGACY_CONFIG, MODE, FLAT_COMMAND, LEGACY_COMMAND, LINT_COMMAND,
+  FLAT_DEPS, LEGACY_DEPS, DEV_DEPS,
+  hasPackageJson, eslintMajor, useLegacy, configFilename, depsFor,
+  isConfigPresent, writeConfig, depsInstalled, installDeps, setup,
+  resolveLintCommand, commandForCwd,
+};