@rtorcato/repo-tooling 4.6.0 → 4.7.0

package/dist/base/fixers.js

@@ -15,7 +15,7 @@ import path from 'node:path';
 import chalk from 'chalk';
 import fs from 'fs-extra';
 import { installAgentRules, installAiSetup } from '../cli/generators/agent-rules.js';
-import { addReadmeBanner, generateBrand, renderBrand, resolveBrandMeta, } from '../cli/generators/brand.js';
+import { addReadmeBanner, generateBrand, renderBrand, resolveBrandMeta, syncBrandToDocs, } from '../cli/generators/brand.js';
 import { generateCommunityHealth } from '../cli/generators/community-health.js';
 import { generateCommitlintConfig } from '../cli/generators/git.js';
 import { generateCodeowners, generateEditorConfig } from '../cli/generators/misc.js';
@@ -274,6 +274,7 @@ export const BASE_FIXERS = [
             const tagline = lock?.rules?.brand?.tagline;
             const filesWritten = await generateBrand(pkg, targetDir, tagline);
             filesWritten.push(...((await renderBrand(targetDir)) ?? []));
+            filesWritten.push(...(await syncBrandToDocs(targetDir)));
             const { name } = await resolveBrandMeta(pkg, targetDir, tagline);
             const readme = await addReadmeBanner(targetDir, name);
             if (readme && !filesWritten.includes(readme))

package/dist/cli/commands/doctor.js

@@ -2,7 +2,7 @@ import path from 'node:path';
 import chalk from 'chalk';
 import fs from 'fs-extra';
 import { renderGitHubWorkflow } from '../../base/ci.js';
-import { githubJobs, scriptsOf } from '../../languages/js/ci.js';
+import { githubJobs, hasBin, scriptsOf } from '../../languages/js/ci.js';
 import { inferProjectConfig } from '../../languages/js/fixers.js';
 import { checkNpmTrustedPublisher, checkPublishJob, findNpmPublishJob, NPM_OIDC_CHECK, } from '../../languages/js/npm-trust.js';
 import { PERL_GIT_HOOKS, runPerlChecks } from '../../languages/perl/checks.js';
@@ -391,7 +391,7 @@ export async function runDoctor(dir) {
         },
         // Same `scripts` gating the fixer applies, or the workflow doctor
         // compares against would reference steps the fixer never writes (#364).
-        presetWorkflow: renderGitHubWorkflow(githubJobs(inferProjectConfig(pkg), { scripts: scriptsOf(pkg) })),
+        presetWorkflow: renderGitHubWorkflow(githubJobs(inferProjectConfig(pkg), { scripts: scriptsOf(pkg), bin: hasBin(pkg) })),
         language,
         codeqlLanguages: languageModule.codeqlLanguages,
     })));

package/dist/cli/generators/brand.js

@@ -402,6 +402,29 @@ export async function renderBrand(targetDir) {
     }
     return written;
 }
+/** brand/ file → docs-site static/img file. The ico and card PNG exist only once rendered. */
+const DOCS_ASSETS = ['favicon.svg', 'favicon.ico', 'social-card.png'];
+/**
+ * Copy the brand favicon and social card into the docs site's `static/img`
+ * (#680). Copy-if-missing, and a no-op without `apps/docs`, so `fix brand` and
+ * `fix docs-site` reach the same tree in either order — each calls it.
+ */
+export async function syncBrandToDocs(targetDir) {
+    if (!(await fs.pathExists(path.join(targetDir, 'apps', 'docs'))))
+        return [];
+    const img = path.join('apps', 'docs', 'static', 'img');
+    const written = [];
+    for (const name of DOCS_ASSETS) {
+        const src = path.join(targetDir, 'brand', name);
+        const dest = path.join(targetDir, img, name);
+        if (!(await fs.pathExists(src)) || (await fs.pathExists(dest)))
+            continue;
+        await fs.ensureDir(path.dirname(dest));
+        await fs.copyFile(src, dest);
+        written.push(path.join(img, name));
+    }
+    return written;
+}
 export const BANNER_START = '<!-- js-tooling:banner:start -->';
 export const BANNER_END = '<!-- js-tooling:banner:end -->';
 /** The README `<picture>` banner, mobile variant under 640px, as a delimited block. */

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

@@ -6,6 +6,7 @@ import { coverageUploadWorkflow } from '../../base/checks.js';
 import { jsBadgeAudience } from '../../languages/js/checks.js';
 import { copyPreset, PRESETS } from '../utils/copy-preset.js';
 import { buildBadgeRow, parseRepository } from './badges.js';
+import { syncBrandToDocs } from './brand.js';
 import { DOCS_SITE_BUILDS, mergeAllowBuilds } from './pnpm-workspace.js';
 import { inferSubpathsFromExports } from './treeshake.js';
 /**
@@ -176,6 +177,7 @@ ${typedocPlugins}\t\t[
 \t],
 
 \tthemeConfig: {
+\t\timage: 'img/social-card.png',
 \t\tcolorMode: {
 \t\t\tdefaultMode: 'dark',
 \t\t\trespectPrefersColorScheme: true,
@@ -427,6 +429,10 @@ export async function generateDocsSite(pkg, targetDir, options = {}) {
         if (w)
             written.push(w);
     }
+    // static/img always exists (the config points at img/favicon.ico); the brand
+    // assets go in when brand/ has them (#680).
+    await fs.ensureDir(path.join(targetDir, DOCS_APP, 'static', 'img'));
+    written.push(...(await syncBrandToDocs(targetDir)));
     const ws = await ensureWorkspace(targetDir);
     if (ws)
         written.push(ws);

package/dist/cli/generators/github-actions.js

@@ -31,7 +31,7 @@ export const CI_WORKFLOW = '.github/workflows/ci.yml';
  * scripts itself as part of the same scaffold.
  * @returns the files actually written, relative to targetDir.
  */
-export async function generateGitHubActions(config, targetDir, { overwrite = false, scripts } = {}) {
+export async function generateGitHubActions(config, targetDir, { overwrite = false, scripts, bin, } = {}) {
     const workflowsDir = path.join(targetDir, '.github', 'workflows');
     await fs.ensureDir(workflowsDir);
     // This is the JS path specifically. Swift (#287) renders its own workflow
@@ -40,7 +40,7 @@ export async function generateGitHubActions(config, targetDir, { overwrite = fal
     // shared entry point would mean inventing a fake config to pass in. Both
     // paths meet at renderGitHubWorkflow() in src/base/ci.ts, which is the seam
     // that actually matters.
-    const workflow = renderGitHubWorkflow(githubJobs(config, { scripts }));
+    const workflow = renderGitHubWorkflow(githubJobs(config, { scripts, bin }));
     const ciPath = path.join(workflowsDir, 'ci.yml');
     const existing = (await fs.pathExists(ciPath)) ? await fs.readFile(ciPath, 'utf-8') : null;
     const filesWritten = [];

package/dist/languages/js/ci.js

@@ -73,6 +73,10 @@ const DEPENDENCIES_JOB = {
       - name: 📦 Install dependencies
         run: pnpm install --frozen-lockfile`,
 };
+/** `JobOptions.bin` for a real repo. */
+export function hasBin(pkg) {
+    return Boolean(pkg?.bin);
+}
 /**
  * `JobOptions.scripts` for a real repo. A package.json with no `scripts` block
  * yields `{}` — "this repo has no scripts", which gates every step off —
@@ -160,6 +164,21 @@ export function githubJobs(config, opts = {}) {
         const publint = config.publint
             ? '\n      - name: 🔍 Validate package with publint\n        run: pnpm exec publint --strict\n'
             : '';
+        // npm's own `bin[…] invalid and removed` warning and a bin pnpm never
+        // links both hide until the tarball is installed somewhere else (#693).
+        const packSmoke = opts.bin
+            ? `
+      - name: 📦 Smoke-test the packed tarball
+        run: |
+          set -e
+          BIN=$(node -p "const p=require('./package.json');typeof p.bin==='string'?p.name.split('/').pop():Object.keys(p.bin)[0]")
+          TARBALL="$PWD/$(npm pack --silent | tail -n1)"
+          tar -tzf "$TARBALL" | grep -q . || { echo "::error::npm pack produced an empty tarball"; exit 1; }
+          SMOKE=$(mktemp -d)
+          cd "$SMOKE" && npm init -y >/dev/null && npm install "$TARBALL"
+          ./node_modules/.bin/"$BIN" --version
+`
+            : '';
         jobs.push({
             id: 'build',
             needs: ['dependencies'],
@@ -167,7 +186,7 @@ export function githubJobs(config, opts = {}) {
 
       - name: 🏗️ Build project
         run: pnpm build
-${attw}${publint}
+${attw}${publint}${packSmoke}
       - name: 📦 Upload build artifacts
         uses: actions/upload-artifact@v7
         with:

package/dist/languages/js/fixers.js

@@ -9,7 +9,7 @@ import { generateGitLabCI } from '../../cli/generators/gitlab-ci.js';
 import { GH_WORKFLOWS, generateGhWorkflow } from '../../cli/generators/github-workflows.js';
 import { BIOME_CONFIG, generateBiomeConfig, generateESLintConfig, generatePrettierConfig, } from '../../cli/generators/linting.js';
 import { alignNodeVersion, ensureEnginesNode, ensurePackageManager, generateKnipConfig, generateNvmrc, generateSizeLimitConfig, generateVscodeExtensions, } from '../../cli/generators/misc.js';
-import { scriptsOf } from './ci.js';
+import { hasBin, scriptsOf } from './ci.js';
 import { NPM_OIDC_CHECK, NPM_TRUST_FIXER } from './npm-trust.js';
 import { usesPnpm } from './checks.js';
 import { SIZE_LIMIT_SCRIPTS, SIZE_LIMIT_VERSION, composeVerifyScriptFromPkg, ensureScripts, } from '../../cli/generators/package-json.js';
@@ -451,6 +451,7 @@ export const FIXERS = [
                 overwrite: result.check === 'GitHub Actions',
                 // Only reference scripts this repo actually has (#364).
                 scripts: scriptsOf(pkg),
+                bin: hasBin(pkg),
             });
             // `pnpm/action-setup` is emitted without a `version:` input, so without
             // this every job dies at setup with "No pnpm version is specified".

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rtorcato/repo-tooling",
-	"version": "4.6.0",
+	"version": "4.7.0",
 	"description": "One CLI to scaffold, audit and fix your repo's whole toolchain — linting, tests, commits, releases & CI.",
 	"type": "module",
 	"keywords": [
@@ -248,7 +248,7 @@
 		"@next/eslint-plugin-next": "^16.3.2",
 		"@playwright/test": "^1.62.1",
 		"@rollup/plugin-typescript": "^12.3.0",
-		"@rtorcato/repo-ai": "^3.1.1",
+		"@rtorcato/repo-ai": "^3.1.2",
 		"@semantic-release/commit-analyzer": "^13.0.1",
 		"@semantic-release/exec": "^7.1.0",
 		"@semantic-release/github": "^12.0.9",