@rtorcato/repo-tooling 4.0.0 → 4.1.0

package/dist/base/fixers.js

@@ -257,8 +257,8 @@ export const BASE_FIXERS = [
         // image paths — hand-edited art is never clobbered.
         riskLevel: 'safe-merge',
         canFixDrift: true,
-        async run({ targetDir, pkg }) {
-            const filesWritten = await generateBrand(pkg, targetDir);
+        async run({ targetDir, pkg, lock }) {
+            const filesWritten = await generateBrand(pkg, targetDir, lock?.rules?.brand?.tagline);
             if (filesWritten.some((f) => f.endsWith('.svg'))) {
                 console.error(chalk.dim('   next: run `brand/render.sh` to render the PNGs (needs librsvg — `brew install librsvg`)'));
             }

package/dist/cli/commands/setup-presets.js

@@ -209,6 +209,7 @@ export const CONFIG_SCHEMA = {
         turborepo: { type: 'boolean' },
         nx: { type: 'boolean' },
         tailwind: { type: 'boolean' },
+        docsSite: { type: 'boolean' },
         bun: { type: 'boolean' },
     },
 };

package/dist/cli/generators/brand.js

@@ -6,8 +6,9 @@
  * PNG, so a banner can be recoloured, retitled or resized instead of being a
  * committed binary nobody can regenerate.
  *
- * Everything in the emitted SVGs is derived from the consuming repo — name and
- * tagline from its package.json, accent from its own docs theme or favicon —
+ * Everything in the emitted SVGs is derived from the consuming repo — name from
+ * its package.json, tagline from `rules.brand.tagline` in .repo-tooling.json or
+ * else the package.json description (#666), accent from its own docs theme or favicon —
  * and falls back to a neutral grey. Nothing about any particular org is baked
  * in; the templates are meant to be hand-edited afterwards.
  */
@@ -94,14 +95,29 @@ async function accentFromFavicon(targetDir) {
     }
     return null;
 }
-export async function resolveBrandMeta(pkg, targetDir) {
+/**
+ * The narrowest tagline budget any canvas uses (the mobile banner). A tagline
+ * that needs more than two lines of it crowds the layout and gets cut off.
+ */
+const TAGLINE_MAX_CHARS = 42;
+/** True when `tagline` fits in two lines on every canvas, without an ellipsis. */
+export function taglineFits(tagline) {
+    const words = tagline.split(/\s+/).filter(Boolean).join(' ');
+    return wrapText(tagline, TAGLINE_MAX_CHARS, 2).join(' ') === words;
+}
+/**
+ * `tagline` is `rules.brand.tagline` from .repo-tooling.json: a short line
+ * written for the banner. Without it the package.json description stands in,
+ * which is often a full sentence too long for the canvas (#666).
+ */
+export async function resolveBrandMeta(pkg, targetDir, tagline) {
     const pkgName = typeof pkg?.name === 'string' ? pkg.name : undefined;
     const name = pkgName?.split('/').pop() ?? path.basename(path.resolve(targetDir));
     const description = typeof pkg?.description === 'string' ? pkg.description : '';
     const accent = (await accentFromDocsTheme(targetDir)) ?? (await accentFromFavicon(targetDir)) ?? NEUTRAL_ACCENT;
     return {
         name,
-        tagline: description || 'Add a one-line tagline to package.json "description".',
+        tagline: tagline || description || 'Add a short tagline as rules.brand.tagline in .repo-tooling.json.',
         accent,
         install: pkgName && pkg?.private !== true ? pkgName : null,
     };
@@ -268,8 +284,8 @@ export async function repointReadmeBanners(targetDir) {
  * README still on the old root-level paths. Every file is written only when
  * absent, so `fix brand` is idempotent.
  */
-export async function generateBrand(pkg, targetDir) {
-    const meta = await resolveBrandMeta(pkg, targetDir);
+export async function generateBrand(pkg, targetDir, tagline) {
+    const meta = await resolveBrandMeta(pkg, targetDir, tagline);
     const written = [];
     const files = [
         ['brand/banner.svg', bannerSvg(meta)],
@@ -282,6 +298,10 @@ export async function generateBrand(pkg, targetDir) {
         if (w)
             written.push(w);
     }
+    // stderr, not stdout: `fix --json` owns stdout (#357).
+    if (written.some((f) => f.endsWith('.svg')) && !taglineFits(meta.tagline)) {
+        console.error('   warning: the tagline needs more than two lines and will be cut off on the mobile banner — set a shorter one as rules.brand.tagline in .repo-tooling.json');
+    }
     const readme = await repointReadmeBanners(targetDir);
     if (readme)
         written.push(readme);

package/dist/cli/generators/docs-site.js

@@ -3,6 +3,7 @@ import fs from 'fs-extra';
 import selfPackageJson from '../../../package.json' with { type: 'json' };
 import { copyPreset, PRESETS } from '../utils/copy-preset.js';
 import { buildBadgeRow, parseRepository } from './badges.js';
+import { DOCS_SITE_BUILDS, mergeAllowBuilds } from './pnpm-workspace.js';
 import { inferSubpathsFromExports } from './treeshake.js';
 /**
  * What a scaffolded docs site should depend on for *this* CLI — read from the
@@ -64,24 +65,25 @@ async function writeIfMissing(targetDir, rel, contents) {
     await fs.writeFile(file, contents);
     return rel;
 }
-/** Ensure `pnpm-workspace.yaml` lists `apps/*` (idempotent). */
+/**
+ * Ensure `pnpm-workspace.yaml` lists `apps/*` and approves the site's build
+ * scripts (idempotent).
+ */
 async function ensureWorkspace(targetDir) {
     const rel = 'pnpm-workspace.yaml';
     const file = path.join(targetDir, rel);
-    if (await fs.pathExists(file)) {
-        const body = await fs.readFile(file, 'utf8');
-        // Already a workspace covering apps/* (either `apps/*` or a broader glob).
-        if (/^\s*-\s*['"]?apps\/\*/m.test(body))
-            return null;
-        if (/^packages:/m.test(body)) {
-            const next = body.replace(/^packages:\n/m, "packages:\n  - 'apps/*'\n");
-            await fs.writeFile(file, next);
-            return rel;
-        }
-        await fs.writeFile(file, `packages:\n  - 'apps/*'\n\n${body}`);
-        return rel;
+    const body = (await fs.pathExists(file)) ? await fs.readFile(file, 'utf8') : '';
+    let next = body;
+    // Already a workspace covering apps/* (either `apps/*` or a broader glob).
+    if (!/^\s*-\s*['"]?apps\/\*/m.test(body)) {
+        next = /^packages:/m.test(body)
+            ? body.replace(/^packages:\n/m, "packages:\n  - 'apps/*'\n")
+            : `packages:\n  - 'apps/*'\n${body ? `\n${body}` : ''}`;
     }
-    await fs.writeFile(file, "packages:\n  - 'apps/*'\n");
+    next = mergeAllowBuilds(next, DOCS_SITE_BUILDS);
+    if (next === body)
+        return null;
+    await fs.writeFile(file, next);
     return rel;
 }
 /** The GitHub Pages base path Docusaurus serves under, e.g. `/repo-tooling/`. */
@@ -380,6 +382,16 @@ export default defineConfig({
 })
 `;
 }
+// routeBasePath is '/docs', so the site root has no page of its own and the
+// navbar logo links to a 404 on every page (#664). Redirect it to the docs.
+// Tabs/no semicolons to match the Biome preset the consuming repo is linted with.
+const HOME_PAGE = `import { Redirect } from '@docusaurus/router'
+import useBaseUrl from '@docusaurus/useBaseUrl'
+
+export default function Home() {
+\treturn <Redirect to={useBaseUrl('/docs')} />
+}
+`;
 const SMOKE_SPEC = `import { expect, test } from '@playwright/test'
 
 // Smoke test: assert the built site serves and its core UI renders. Deliberately
@@ -426,6 +438,7 @@ export async function generateDocsSite(pkg, targetDir, options = {}) {
         [`${DOCS_APP}/sidebars.ts`, SIDEBARS],
         [`${DOCS_APP}/tsconfig.json`, TSCONFIG],
         [`${DOCS_APP}/src/css/custom.css`, customCss(accent)],
+        [`${DOCS_APP}/src/pages/index.tsx`, HOME_PAGE],
         [`${DOCS_APP}/docs/intro.md`, introDoc(meta, badges)],
         [`${DOCS_APP}/playwright.config.ts`, playwrightConfig(meta)],
         [`${DOCS_APP}/tests/smoke.spec.ts`, SMOKE_SPEC],

package/dist/cli/generators/pnpm-workspace.js

@@ -156,6 +156,32 @@ function insertUnder(yaml, key, item) {
     lines.splice(at + 1, 0, item);
     return lines.join('\n');
 }
+/**
+ * The build-script decisions a Docusaurus site needs under pnpm 11 (#663): it
+ * pulls in all four, and an undecided one fails the install. core-js's
+ * postinstall is only a banner, so it is declined; esbuild and sharp compile.
+ */
+export const DOCS_SITE_BUILDS = {
+    'core-js': false,
+    'core-js-pure': false,
+    esbuild: true,
+    sharp: true,
+};
+/**
+ * Merge `builds` into the `allowBuilds:` map, adding only the packages that
+ * carry no decision yet — an existing value, whichever way it went, stays.
+ */
+export function mergeAllowBuilds(yaml, builds) {
+    const entries = Object.entries(builds)
+        .filter(([name]) => !approved(yaml, name))
+        .map(([name, allow]) => `  ${asKey(name)}: ${allow}`)
+        .join('\n');
+    if (!entries)
+        return yaml;
+    if (section(yaml, 'allowBuilds'))
+        return insertUnder(yaml, 'allowBuilds', entries);
+    return `${yaml.replace(/\n*$/, '\n')}\nallowBuilds:\n${entries}\n`;
+}
 /** Merge every missing managed setting into `yaml` and return the new contents. */
 export function upsertPnpmSettings(yaml, needsEsbuild, glob) {
     let next = yaml;

package/dist/cli/utils/lockfile.js

@@ -160,6 +160,17 @@ export function lockfileSchema() {
                         additionalProperties: { type: 'string', minLength: 1 },
                         description: 'Declared exceptions: doctor check name → the reason this repo deliberately deviates. The reason is mandatory and non-empty — doctor shows the check as `declared` with it (never hidden) and stops failing the run for it. An entry naming a check doctor does not run is itself reported as drift.',
                     },
+                    brand: {
+                        type: 'object',
+                        additionalProperties: false,
+                        description: 'Inputs to `fix brand`, which scaffolds the banner and social-card SVGs.',
+                        properties: {
+                            tagline: {
+                                type: 'string',
+                                description: 'Short line for the banners and social card, used in place of the package.json description. Keep it to two lines of about 42 characters; `fix brand` warns when it is longer.',
+                            },
+                        },
+                    },
                 },
             },
         },

package/dist/languages/js/ci.js

@@ -78,6 +78,13 @@ export function scriptsOf(pkg) {
 function hasScript(opts, script) {
     return !opts.scripts || script in opts.scripts;
 }
+/**
+ * A bundler, or a known `build` script — a plain-`tsc` repo records `bundler:
+ * 'none'` (#661) but still has a build to run.
+ */
+function buildsSomething(config, opts) {
+    return config.bundler !== 'none' || (opts.scripts !== undefined && 'build' in opts.scripts);
+}
 /** Emit a step only when the script it runs exists (or we can't know yet). */
 function stepFor(opts, script, step) {
     return hasScript(opts, script) ? step : null;
@@ -95,7 +102,7 @@ function jobSteps(steps) {
 export function githubJobs(config, opts = {}) {
     const hasTypeScript = config.typescript.enabled;
     const hasTests = config.testing.framework !== 'none';
-    const hasBuild = config.bundler !== 'none';
+    const hasBuild = buildsSomething(config, opts);
     const isLibrary = config.projectType === 'library';
     const hasCoverage = usesCoverage(config);
     const jobs = [DEPENDENCIES_JOB];
@@ -230,7 +237,7 @@ export function gitlabSpec(config, opts = {}) {
     const hasTypeScript = config.typescript.enabled;
     const hasTests = config.testing.framework !== 'none';
     const hasLint = config.linting.tool !== 'none';
-    const hasBuild = config.bundler !== 'none';
+    const hasBuild = buildsSomething(config, opts);
     const test = gitlabTest(config);
     const jobs = [
         ...(hasLint && hasScript(opts, lintScript(config))

package/dist/languages/js/fixers.js

@@ -79,8 +79,33 @@ import { LOCKFILE_NAME, writeLockfile } from '../../cli/utils/lockfile.js';
 // The fixer contract moved to src/base/fixers.ts when Swift became the second
 // module (#286) — import it from there.
 import { FixerAbort } from '../../base/fixers.js';
+// The bundlers ProjectConfig can record, in the order a repo carrying more than
+// one is attributed to (a vite app that also pulls in esbuild is a vite app).
+const BUNDLERS = ['tsup', 'vite', 'rolldown', 'rollup', 'esbuild'];
+const BUNDLER_CONFIGS = {
+    tsup: [
+        'tsup.config.ts',
+        'tsup.config.mts',
+        'tsup.config.js',
+        'tsup.config.mjs',
+        'tsup.config.json',
+    ],
+    vite: ['vite.config.ts', 'vite.config.mts', 'vite.config.js', 'vite.config.mjs'],
+    rolldown: ['rolldown.config.ts', 'rolldown.config.mjs', 'rolldown.config.js'],
+    rollup: ['rollup.config.ts', 'rollup.config.mjs', 'rollup.config.js'],
+    esbuild: ['build.mjs'],
+};
+/**
+ * The bundler the repo actually uses, from its deps or (given `dir`) its config
+ * file — `none` when there is neither. Never a preset default: a plain-`tsc`
+ * repo used to be recorded as tsup (#661).
+ */
+function detectBundler(deps, dir) {
+    return (BUNDLERS.find((b) => b in deps ||
+        (dir !== undefined && BUNDLER_CONFIGS[b].some((f) => fs.existsSync(path.join(dir, f))))) ?? 'none');
+}
 /** Exported so doctor can render the preset ci.yml it compares against (#349). */
-export function inferProjectConfig(pkg) {
+export function inferProjectConfig(pkg, dir) {
     const deps = {
         ...(pkg?.dependencies ?? {}),
         ...(pkg?.devDependencies ?? {}),
@@ -92,6 +117,7 @@ export function inferProjectConfig(pkg) {
         projectType = 'react-app';
     return {
         projectName: pkg?.name ?? 'project',
+        language: 'js',
         projectType,
         typescript: {
             enabled: true,
@@ -109,7 +135,7 @@ export function inferProjectConfig(pkg) {
         commitLint: true,
         semanticRelease: pkg?.private !== true,
         securityAutomation: true,
-        bundler: 'tsup',
+        bundler: detectBundler(deps, dir),
     };
 }
 export async function readPackageJson(dir) {
@@ -879,7 +905,9 @@ export const FIXERS = [
                 console.error(chalk.yellow('   no package.json found — skipping'));
                 return { filesWritten: [] };
             }
-            const config = lock ? lock.record.config : inferProjectConfig(pkg);
+            const config = lock
+                ? lock.record.config
+                : inferProjectConfig(pkg, targetDir);
             // Recorded hashes win: they capture the pristine content at copy time,
             // which a byte-match against today's shipped asset can only approximate.
             const assets = { ...(await identifiablePresetHashes(targetDir)), ...lock?.record.assets };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rtorcato/repo-tooling",
-	"version": "4.0.0",
+	"version": "4.1.0",
 	"description": "One CLI to scaffold, audit and fix your repo's whole toolchain — linting, tests, commits, releases & CI.",
 	"type": "module",
 	"keywords": [