@pixpilot/scaffoldfy-configs 0.40.4 → 0.42.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @pixpilot/scaffoldfy-configs
 
+## 0.42.0
+
+### Minor Changes
+
+- add `--set <key=value>` option for preset prompt answers
+- 0319f19: workspace-initializer: create multiple packages at once from a comma separated list of names
+
+## 0.41.0
+
+### Minor Changes
+
+- add CodeQL workflow for private repositories
+
 ## 0.40.4
 
 ### Patch Changes

package/README.md

@@ -14,6 +14,16 @@ This package provides the following scaffoldfy templates:
 
 <!-- scaffoldfy-templates:start -->
 
+### codeql-private-repo
+
+Replaces the CodeQL workflow with the pixpilot/codeql-scanner action for private repositories
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/codeql-private-repo/scaffoldfy.json
+```
+
 ### license-file
 
 Generate a LICENSE file with common open-source licenses

package/codeql-private-repo/codeql-analysis.yml

@@ -0,0 +1,39 @@
+name: CodeQL Analyser
+
+permissions:
+  security-events: write
+  actions: read
+  contents: read
+  issues: write # Required for pixpilot/codeql-scanner@main
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    branches:
+      - main
+      - master
+  schedule:
+    #        ┌───────────── minute (0 - 59)
+    #        │  ┌───────────── hour (0 - 23)
+    #        │  │ ┌───────────── day of the month (1 - 31)
+    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #        │  │ │ │ │
+    #        *  * * * *
+    - cron: '30 1 * * 0' # Every Sunday at 01:30 UTC
+
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run CodeQL Scanner
+        uses: pixpilot/codeql-scanner@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config-file: .github/codeql/codeql-config.yml

package/codeql-private-repo/scaffoldfy.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "../node_modules/@pixpilot/scaffoldfy/schema/scaffoldfy.schema.json",
+  "name": "codeql-private-repo",
+  "description": "Replaces the CodeQL workflow with the pixpilot/codeql-scanner action for private repositories",
+  "prompts": [
+    {
+      "id": "isPrivateRepo",
+      "type": "confirm",
+      "message": "Is this a private repository?",
+      "default": {
+        "type": "exec",
+        "value": "node -e \"try{process.stdout.write(require('child_process').execSync('gh repo view --json isPrivate -q .isPrivate',{stdio:['ignore','pipe','ignore']}).toString().trim())}catch{process.stdout.write('false')}\""
+      }
+    }
+  ],
+  "tasks": [
+    {
+      "id": "codeql-private-repo-workflow",
+      "name": "Replace CodeQL workflow for private repo",
+      "description": "Overwrites the CodeQL workflow to use pixpilot/codeql-scanner",
+      "enabled": {
+        "type": "condition",
+        "value": "isPrivateRepo === true"
+      },
+      "type": "write",
+      "config": {
+        "templateFile": "codeql-analysis.yml",
+        "file": ".github/workflows/codeql-analysis.yml"
+      }
+    }
+  ]
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/scaffoldfy-configs",
   "type": "module",
-  "version": "0.40.4",
+  "version": "0.42.0",
   "author": "PixPilot <m.doaie@hotmail.com>",
   "license": "MIT",
   "repository": {
@@ -29,11 +29,11 @@
   "devDependencies": {
     "@types/node": "^22.18.11",
     "eslint": "^9.38.0",
-    "@internal/vitest-config": "0.1.0",
+    "@internal/tsdown-config": "0.1.0",
     "@internal/eslint-config": "0.3.0",
+    "@internal/vitest-config": "0.1.0",
     "@internal/prettier-config": "0.0.1",
-    "@pixpilot/scaffoldfy": "0.55.1",
-    "@internal/tsdown-config": "0.1.0"
+    "@pixpilot/scaffoldfy": "0.56.0"
   },
   "prettier": "@internal/prettier-config",
   "publishConfig": {

package/test/create-packages.test.ts

@@ -0,0 +1,101 @@
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import process from 'node:process';
+import { afterEach, describe, expect, it } from 'vitest';
+
+const SCRIPT_PATH = path.join(
+  __dirname,
+  '..',
+  'workspace-initializer',
+  'scripts',
+  'create-packages.cjs',
+);
+const temporaryDirectories: string[] = [];
+
+afterEach(() => {
+  for (const directory of temporaryDirectories.splice(0)) {
+    fs.rmSync(directory, { force: true, recursive: true });
+  }
+});
+
+/**
+ * Put a fake `pnpm` on PATH that appends its arguments to a log file
+ */
+function createFakePnpm(): { binDirectory: string; logPath: string } {
+  const testDirectory = fs.mkdtempSync(path.join(os.tmpdir(), 'create-packages-'));
+  temporaryDirectories.push(testDirectory);
+
+  const binDirectory = path.join(testDirectory, 'bin');
+  const logPath = path.join(testDirectory, 'calls.log');
+  const fakePnpmScript = path.join(binDirectory, 'fake-pnpm.cjs');
+  fs.mkdirSync(binDirectory, { recursive: true });
+  fs.writeFileSync(
+    fakePnpmScript,
+    `require('node:fs').appendFileSync(${JSON.stringify(logPath)}, process.argv.slice(2).join(' ') + '\\n');`,
+  );
+
+  if (process.platform === 'win32') {
+    fs.writeFileSync(
+      path.join(binDirectory, 'pnpm.cmd'),
+      `@"${process.execPath}" "${fakePnpmScript}" %*\r\n`,
+    );
+  } else {
+    const pnpmPath = path.join(binDirectory, 'pnpm');
+    fs.writeFileSync(
+      pnpmPath,
+      `#!/bin/sh\n"${process.execPath}" "${fakePnpmScript}" "$@"\n`,
+    );
+    fs.chmodSync(pnpmPath, 0o755);
+  }
+
+  return { binDirectory, logPath };
+}
+
+function runScript(packageNames: string, binDirectory: string) {
+  const pathKey =
+    Object.keys(process.env).find((key) => key.toUpperCase() === 'PATH') ?? 'PATH';
+  return spawnSync(process.execPath, [SCRIPT_PATH], {
+    encoding: 'utf8',
+    env: {
+      ...process.env,
+      [pathKey]: `${binDirectory}${path.delimiter}${process.env[pathKey] ?? ''}`,
+      PACKAGE_NAMES: packageNames,
+    },
+  });
+}
+
+describe('workspace-initializer create-packages script', () => {
+  it('runs the package generator once per comma separated name', () => {
+    const { binDirectory, logPath } = createFakePnpm();
+
+    const result = runScript(' pkg-a, pkg-b ,,@scope/pkg-c ', binDirectory);
+
+    expect(result.status).toBe(0);
+    expect(fs.readFileSync(logPath, 'utf8').trim().split(/\r?\n/u)).toEqual([
+      'run gen:package --set packageBaseName=pkg-a',
+      'run gen:package --set packageBaseName=pkg-b',
+      'run gen:package --set packageBaseName=@scope/pkg-c',
+    ]);
+  });
+
+  it('skips when no names are given', () => {
+    const { binDirectory, logPath } = createFakePnpm();
+
+    const result = runScript(' , ', binDirectory);
+
+    expect(result.status).toBe(0);
+    expect(fs.existsSync(logPath)).toBe(false);
+  });
+
+  it('rejects names with shell characters', () => {
+    const { binDirectory, logPath } = createFakePnpm();
+
+    const result = runScript('pkg-a, bad;rm -rf', binDirectory);
+
+    expect(result.status).toBe(1);
+    expect(result.stderr).toContain('Invalid package name(s): bad;rm -rf');
+    expect(fs.existsSync(logPath)).toBe(false);
+  });
+});

package/workspace-initializer/scaffoldfy.json

@@ -7,6 +7,7 @@
     "../license-file/scaffoldfy.json",
     "../update-root-package-json/scaffoldfy.json",
     "../security-policy/scaffoldfy.json",
+    "../codeql-private-repo/scaffoldfy.json",
     "../monorepo-generate-packages-section/scaffoldfy.json"
   ],
   "name": "pnpm-turbo-monorepo-template-setup",
@@ -21,8 +22,18 @@
     {
       "id": "createFirstPackagePrompt",
       "type": "confirm",
-      "message": "Create the first package now?",
+      "message": "Create packages now?",
       "default": false
+    },
+    {
+      "id": "packageNames",
+      "type": "input",
+      "message": "Enter package names (comma separated, e.g. my-package, my-other-package)",
+      "required": true,
+      "enabled": {
+        "type": "condition",
+        "value": "createFirstPackagePrompt === true"
+      }
     }
   ],
   "tasks": [
@@ -87,12 +98,19 @@
     },
     {
       "id": "create-first-package",
-      "name": "Create first package",
-      "description": "Generate the first package in the monorepo using the package generator",
-      "type": "exec",
+      "name": "Create packages",
+      "description": "Generate each requested package in the monorepo using the package generator",
+      "type": "exec-file",
+      "enabled": {
+        "type": "condition",
+        "value": "createFirstPackagePrompt === true"
+      },
       "config": {
-        "command": "pnpm run gen:package",
-        "condition": "createFirstPackagePrompt"
+        "file": "./scripts/create-packages.cjs",
+        "runtime": "node",
+        "parameters": {
+          "PACKAGE_NAMES": "{{packageNames}}"
+        }
       }
     },
     {

package/workspace-initializer/scripts/create-packages.cjs

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+/* eslint-disable node/prefer-global/process */
+/**
+ * Runs the workspace package generator once per package name, pre-filling
+ * the package name prompt so only the remaining prompts are asked.
+ *
+ * Usage:
+ *   PACKAGE_NAMES="pkg-a, pkg-b" node create-packages.cjs
+ */
+
+'use strict';
+
+const { spawnSync } = require('node:child_process');
+
+const SAFE_NAME = /^[\w.@/-]+$/u;
+
+const names = (process.env.PACKAGE_NAMES || '')
+  .split(',')
+  .map((name) => name.trim())
+  .filter(Boolean);
+
+if (names.length === 0) {
+  console.log('No package names provided, skipping package creation.');
+  process.exit(0);
+}
+
+const invalid = names.filter((name) => !SAFE_NAME.test(name));
+if (invalid.length > 0) {
+  console.error(`Invalid package name(s): ${invalid.join(', ')}`);
+  process.exit(1);
+}
+
+for (const [index, name] of names.entries()) {
+  console.log(`\nCreating package ${index + 1}/${names.length}: ${name}\n`);
+
+  const result = spawnSync(
+    'pnpm',
+    ['run', 'gen:package', '--set', `packageBaseName=${name}`],
+    { stdio: 'inherit', shell: true },
+  );
+
+  if (result.status !== 0) {
+    console.error(`Failed to create package: ${name}`);
+    process.exit(result.status ?? 1);
+  }
+}