@pixpilot/scaffoldfy-configs 0.24.1 → 0.25.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @pixpilot/scaffoldfy-configs
 
+## 0.25.0
+
+### Minor Changes
+
+- add README generation script and update README content
+- add scaffoldfy configuration and README template
+
 ## 0.24.1
 
 ### Patch Changes

package/README.md

@@ -12,41 +12,129 @@ npm install @pixpilot/scaffoldfy @pixpilot/scaffoldfy-configs
 
 This package provides the following scaffoldfy templates:
 
+<!-- scaffoldfy-templates:start -->
+
 ### license-file
 
-Generate a LICENSE file with common open-source licenses (MIT, Apache 2.0, GPL, BSD, etc.)
+Generate a LICENSE file with common open-source licenses
 
-### project-info
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/license-file/scaffoldfy.json
+```
+
+### monorepo-generate-packages-section
 
-Collect and manage project information prompts for consistent project setup
+Generates packages section in monorepo README by reading package.json files
 
-### turbo-workspace-package-generator
+Usage:
 
-Generate packages for pnpm + Turbo monorepos with customizable bundler options
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/monorepo-generate-packages-section/scaffoldfy.json
+```
 
 ### pixpilot-changesets-release
 
-Configure changesets for automated package publishing
+Pixpilot workspace package generator template for pnpm + Turbo monorepo. Provides project info prompts and config tasks.
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/pixpilot-changesets-release/scaffoldfy.json
+```
 
 ### pixpilot-copilot-instructions
 
-Generate GitHub Copilot instructions for your project
+GitHub Copilot instructions template for Pixpilot projects
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/pixpilot-copilot-instructions/scaffoldfy.json
+```
 
 ### pixpilot-info
 
-Project information and metadata management
+Project information prompts for pnpm-turbo-monorepo-template
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/pixpilot-info/scaffoldfy.json
+```
+
+### project-info
+
+Project information prompts for pnpm-turbo-monorepo-template
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/project-info/scaffoldfy.json
+```
 
 ### security-policy
 
-Generate security policy documentation
+Security policy template with configurable contact email
 
-### monorepo-generate-packages-section
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/security-policy/scaffoldfy.json
+```
+
+### turbo-workspace-package-generator
 
-Configure package generation for monorepo setups
+Pixpilot workspace package generator template for pnpm + Turbo monorepo. Provides project info prompts and config tasks.
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/turbo-workspace-package-generator/scaffoldfy.json
+```
 
 ### update-root-package-json
 
-Update root package.json with common configurations
+Update root package.json with repository information
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/update-root-package-json/scaffoldfy.json
+```
+
+### workspace-initializer
+
+Initial setup for a pnpm + Turbo monorepo template, including project info, license, and initial package generation.
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/workspace-initializer/scaffoldfy.json
+```
+
+### workspace-package-generator
+
+Generate a new package for a pnpm + Turbo monorepo workspace
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/workspace-package-generator/scaffoldfy.json
+```
+
+### workspace-package-generator/experiment
+
+Generate a new package for a pnpm + Turbo monorepo workspace
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy --config https://unpkg.com/@pixpilot/scaffoldfy-configs/workspace-package-generator/experiment/scaffoldfy.json
+```
+
+<!-- scaffoldfy-templates:end -->
 
 ## Usage
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/scaffoldfy-configs",
   "type": "module",
-  "version": "0.24.1",
+  "version": "0.25.0",
   "author": "PixPilot <m.doaie@hotmail.com>",
   "license": "MIT",
   "repository": {
@@ -23,10 +23,10 @@
   "devDependencies": {
     "@types/node": "^22.18.11",
     "eslint": "^9.38.0",
-    "@internal/tsdown-config": "0.1.0",
-    "@internal/prettier-config": "0.0.1",
     "@internal/vitest-config": "0.1.0",
     "@pixpilot/scaffoldfy": "0.49.0",
+    "@internal/tsdown-config": "0.1.0",
+    "@internal/prettier-config": "0.0.1",
     "@internal/eslint-config": "0.3.0"
   },
   "prettier": "@internal/prettier-config",
@@ -34,6 +34,7 @@
     "access": "public"
   },
   "scripts": {
+    "generate:readme": "node scripts/generate-readme.mjs",
     "test": "vitest --run --passWithNoTests",
     "test:watch": "vitest --watch",
     "test:ui": "vitest --ui",

package/scripts/generate-readme.mjs

@@ -0,0 +1,88 @@
+import { readdir, readFile, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const packageDirectory = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+const readmePath = path.join(packageDirectory, 'README.md');
+const packageUrl = 'https://unpkg.com/@pixpilot/scaffoldfy-configs';
+const startMarker = '<!-- scaffoldfy-templates:start -->';
+const endMarker = '<!-- scaffoldfy-templates:end -->';
+const ignoredDirectories = new Set(['.cache', '.turbo', 'node_modules']);
+
+async function findConfigPaths(directory) {
+  const entries = await readdir(directory, { withFileTypes: true });
+  const paths = await Promise.all(
+    entries.map((entry) => {
+      if (entry.isDirectory() && !ignoredDirectories.has(entry.name)) {
+        return findConfigPaths(path.join(directory, entry.name));
+      }
+      if (entry.isFile() && entry.name === 'scaffoldfy.json') {
+        return [path.join(directory, entry.name)];
+      }
+      return [];
+    }),
+  );
+
+  return paths.flat();
+}
+
+async function readTemplate(configPath) {
+  const relativeDirectory = path
+    .relative(packageDirectory, path.dirname(configPath))
+    .split(path.sep)
+    .join('/');
+  const relativeConfigPath = relativeDirectory
+    ? `${relativeDirectory}/scaffoldfy.json`
+    : 'scaffoldfy.json';
+  const config = JSON.parse(await readFile(configPath, 'utf8'));
+
+  if (typeof config.description !== 'string' || !config.description.trim()) {
+    throw new Error(`${relativeConfigPath} has no description`);
+  }
+
+  return {
+    configUrl: `${packageUrl}/${relativeConfigPath}`,
+    description: config.description.trim(),
+    name: relativeDirectory || config.name,
+  };
+}
+
+function compareTemplates(left, right) {
+  if (left.name === right.name) {
+    return 0;
+  }
+  return left.name < right.name ? -1 : 1;
+}
+
+async function generateReadme() {
+  const configPaths = await findConfigPaths(packageDirectory);
+  const templates = await Promise.all(configPaths.map(readTemplate));
+  templates.sort(compareTemplates);
+
+  const generatedSection = templates
+    .map(
+      ({ configUrl, description, name }) =>
+        `### ${name}\n\n${description}\n\nUsage:\n\n\`\`\`sh\nnpx @pixpilot/scaffoldfy --config ${configUrl}\n\`\`\``,
+    )
+    .join('\n\n');
+  const readme = await readFile(readmePath, 'utf8');
+  const startIndex = readme.indexOf(startMarker);
+  const endIndex = readme.indexOf(endMarker);
+
+  if (startIndex === -1 || endIndex === -1 || endIndex < startIndex) {
+    throw new Error('README.md is missing the template section markers');
+  }
+
+  const before = readme.slice(0, startIndex + startMarker.length);
+  const after = readme.slice(endIndex);
+  const generatedReadme = `${before}\n\n${generatedSection}\n\n${after}`;
+
+  if (generatedReadme !== readme) {
+    await writeFile(readmePath, generatedReadme);
+    console.log(`Updated README.md with ${templates.length} templates.`);
+  } else {
+    console.log(`README.md is current (${templates.length} templates).`);
+  }
+}
+
+await generateReadme();

package/workspace-initializer/scaffoldfy.json

@@ -0,0 +1,107 @@
+{
+  "$schema": "../node_modules/@pixpilot/scaffoldfy/schema/scaffoldfy.schema.json",
+  "extends": [
+    "../project-info/scaffoldfy.json",
+    "../pixpilot-info/scaffoldfy.json",
+    "../turbo-workspace-package-generator/scaffoldfy.json",
+    "../pixpilot-changesets-release/scaffoldfy.json",
+    "../license-file/scaffoldfy.json",
+    "../update-root-package-json/scaffoldfy.json",
+    "../security-policy/scaffoldfy.json",
+    "../pixpilot-copilot-instructions/scaffoldfy.json",
+    "../monorepo-generate-packages-section/scaffoldfy.json"
+  ],
+  "name": "pnpm-turbo-monorepo-template-setup",
+  "description": "Initial setup for a pnpm + Turbo monorepo template, including project info, license, and initial package generation.",
+  "prompts": [
+    {
+      "id": "keepExamplePackages",
+      "type": "confirm",
+      "message": "Keep example packages? (helpful for reference)",
+      "default": false
+    },
+    {
+      "id": "createFirstPackagePrompt",
+      "type": "confirm",
+      "message": "Create the first package now?",
+      "default": true
+    }
+  ],
+  "tasks": [
+    {
+      "id": "clean-readme",
+      "name": "Clean README",
+      "description": "Create a fresh README for the new project",
+      "type": "write",
+      "config": {
+        "file": "README.md",
+        "templateFile": "./templates/clean-readme.hbs"
+      }
+    },
+    {
+      "id": "update-contributing",
+      "name": "Update CONTRIBUTING.md",
+      "description": "Update contributing guidelines with project info",
+      "type": "replace-in-file",
+      "config": {
+        "file": "CONTRIBUTING.md",
+        "replacements": [
+          {
+            "find": "<projectName>",
+            "replace": "{{projectName}}"
+          }
+        ]
+      }
+    },
+    {
+      "id": "handle-example-packages",
+      "name": "Handle example packages",
+      "description": "Prompt user about keeping example packages and remove if not wanted",
+      "type": "delete",
+      "config": {
+        "condition": "!keepExamplePackages",
+        "paths": ["packages/example-package"]
+      }
+    },
+    {
+      "id": "remove-setup-script",
+      "name": "Remove setup script",
+      "description": "Remove the setup script from package.json after setup is complete",
+      "type": "regex-replace",
+      "config": {
+        "file": "package.json",
+        "pattern": "\\n\\s*\"setup\":\\s*\"npx @pixpilot/scaffoldfy --config \\./setup/scaffoldfy\\.json\",",
+        "flags": "",
+        "replacement": ""
+      }
+    },
+    {
+      "id": "delete-setup-tasks",
+      "name": "Delete setup tasks file",
+      "description": "Remove the setup-tasks.json file after setup is complete",
+      "type": "delete",
+      "config": {
+        "paths": ["setup"]
+      }
+    },
+    {
+      "id": "create-first-package",
+      "name": "Create first package",
+      "description": "Generate the first package in the monorepo using the package generator",
+      "type": "exec",
+      "config": {
+        "command": "pnpm run gen:package",
+        "condition": "createFirstPackagePrompt"
+      }
+    },
+    {
+      "id": "reinstall-dependencies",
+      "name": "Reinstall dependencies",
+      "description": "Reinstall dependencies after cleanup",
+      "type": "exec",
+      "config": {
+        "command": "pnpm install"
+      }
+    }
+  ]
+}

package/workspace-initializer/templates/clean-readme.hbs

@@ -0,0 +1,46 @@
+# {{projectName}}
+
+> A modern TypeScript monorepo managed with pnpm and TurboRepo.
+
+## 🚀 Getting Started
+
+### Development
+
+Build all packages:
+
+```sh
+pnpm build
+```
+
+Run tests:
+
+```sh
+pnpm test
+```
+
+Lint and format:
+
+```sh
+pnpm lint
+pnpm format
+```
+
+### Create a New Package
+
+Generate a new package in the monorepo:
+
+```sh
+pnpm run gen:package
+```
+
+## 📦 Packages
+
+<!-- List your packages here -->
+
+## 🚢 Releases
+
+This project uses [Changesets](https://github.com/changesets/changesets) for version management and publishing.
+
+## 📄 License
+
+[{{licenseType}}](LICENSE)