all examples are copied by default

Author: sbaechler

README.md

@@ -7,6 +7,7 @@ By default it generates a clean starter workspace with:
 - a minimal React Router prototype shell
 - shared `api`, `ui`, `msw`, and `mocks` packages
 - Turborepo, TypeScript, ESLint, Prettier, and Antora wiring
+- every example template copied into `examples/<name>/`
 
 The scaffold no longer ships a demo application in the base workspace.
 
@@ -16,14 +17,20 @@ The scaffold no longer ships a demo application in the base workspace.
 npm create tinker-stack@latest
 ```
 
-To include an independent example template:
+To generate the base workspace without any example folders:
+
+```bash
+npm create tinker-stack@latest -- --no-examples
+```
+
+To generate only specific example templates:
 
 ```bash
 npm create tinker-stack@latest -- --example react-router
 ```
 
-The selected examples are copied into `examples/<name>/` inside the generated project. They are
-self-contained and can be deleted without affecting the main workspace.
+By default, all available examples are copied into `examples/<name>/` inside the generated project.
+They are self-contained and can be deleted without affecting the main workspace.
 
 ## Example templates
 

create/index.js

@@ -17,6 +17,7 @@ function parseCliArgs(argv = process.argv.slice(2)) {
     debug: undefined,
     install: undefined,
     examples: [],
+    noExamples: false,
     withExample: false
   };
   const positionals = [];
@@ -48,6 +49,11 @@ function parseCliArgs(argv = process.argv.slice(2)) {
       continue;
     }
 
+    if (arg === '--no-examples') {
+      options.noExamples = true;
+      continue;
+    }
+
     if (arg === '--cwd') {
       const value = argv[i + 1];
       if (value && !value.startsWith('-')) {
@@ -129,16 +135,19 @@ function normalizeOptions(input = {}) {
       ? path.resolve(resolvedCwd, targetDir)
       : undefined;
 
-  const examples = [
+  const explicitExamples = [
     ...normalizeExampleNames(opts.examples),
     ...normalizeExampleNames(opts.example),
     ...normalizeExampleNames(cli.examples)
   ];
 
   if (opts.withExample === true || cli.withExample) {
-    examples.push(DEFAULT_EXAMPLE);
+    explicitExamples.push(DEFAULT_EXAMPLE);
   }
 
+  const noExamples = Boolean(opts.noExamples ?? cli.noExamples);
+  const hasExplicitExamples = explicitExamples.length > 0;
+  const examples = hasExplicitExamples ? explicitExamples : noExamples ? [] : getDefaultExamples();
   const normalizedExamples = [...new Set(examples)];
 
   return {
@@ -149,10 +158,23 @@ function normalizeOptions(input = {}) {
     cwd: resolvedCwd,
     templateDir, // always use the built-in template
     exampleTemplatesDir,
+    noExamples,
     examples: normalizedExamples
   };
 }
 
+function getDefaultExamples() {
+  try {
+    return fs
+      .readdirSync(exampleTemplatesDir, { withFileTypes: true })
+      .filter(entry => entry.isDirectory())
+      .map(entry => entry.name)
+      .sort();
+  } catch {
+    return [];
+  }
+}
+
 async function main(...args) {
   const opts = normalizeOptions(args[0]);
 

tests/generator.test.mjs

@@ -22,11 +22,12 @@ async function runCommand(cmd, args, options = {}) {
 
 describe('create-tinker-stack generator', () => {
   test(
-    'scaffolds project and passes build checks',
+    'scaffolds project with all examples by default and passes build checks',
     async () => {
       const tempRoot = await mkdtemp(path.join(os.tmpdir(), 'tinker-stack-'));
       const appFolder = 'demo-app';
       const projectDir = path.join(tempRoot, appFolder);
+      const exampleDir = path.join(projectDir, 'examples', 'react-router');
 
       try {
         await runCommand('node', [CLI_ENTRY, appFolder], {
@@ -46,6 +47,10 @@ describe('create-tinker-stack generator', () => {
 
         const readme = await readFile(path.join(projectDir, 'README.md'), 'utf8');
         expect(readme).toContain('Demo Title');
+        const examplePackageJson = JSON.parse(
+          await readFile(path.join(exampleDir, 'package.json'), 'utf8')
+        );
+        expect(examplePackageJson.scripts).toHaveProperty('build');
 
         await runCommand('npm', ['install'], { cwd: projectDir });
         await runCommand('npm', ['run', 'typecheck'], { cwd: projectDir });
@@ -101,6 +106,36 @@ describe('create-tinker-stack generator', () => {
     5 * 60 * 1000
   );
 
+  test(
+    'skips copying example templates when --no-examples is passed',
+    async () => {
+      const tempRoot = await mkdtemp(path.join(os.tmpdir(), 'tinker-stack-'));
+      const appFolder = 'demo-app';
+      const projectDir = path.join(tempRoot, appFolder);
+
+      try {
+        await runCommand('node', [CLI_ENTRY, '--no-examples', appFolder], {
+          env: {
+            ...process.env,
+            CI: '1',
+            SKIP_SETUP: '1',
+            SKIP_FORMAT: '1'
+          },
+          cwd: tempRoot
+        });
+
+        const packageJson = JSON.parse(await readFile(path.join(projectDir, 'package.json'), 'utf8'));
+        expect(packageJson.name).toBe('demo-title');
+        await expect(readFile(path.join(projectDir, 'examples', 'react-router', 'package.json'), 'utf8'))
+          .rejects
+          .toMatchObject({ code: 'ENOENT' });
+      } finally {
+        await rm(tempRoot, { recursive: true, force: true });
+      }
+    },
+    5 * 60 * 1000
+  );
+
   test(
     'scaffolds into the current working directory when no target is provided',
     async () => {