create-packkit 2.0.3 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-packkit",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "Highly configurable scaffolder for modern npm packages and CLIs — pick your stack (TS/JS, bundler, tests, linter, CI, releases) from a CLI or a web configurator.",
   "type": "module",
   "bin": {

package/src/cli/args.js

@@ -48,6 +48,7 @@ export function parseCliArgs(argv) {
       minify: { type: 'boolean' },
       monorepo: { type: 'boolean' },
       storybook: { type: 'boolean' },
+      e2e: { type: 'boolean' },
       'pkg-checks': { type: 'boolean' },
       knip: { type: 'boolean' },
       jsr: { type: 'boolean' },
@@ -74,6 +75,7 @@ export function parseCliArgs(argv) {
   if (values.minify) overrides.minify = true;
   if (values.monorepo) overrides.monorepo = true;
   if (values.storybook) overrides.storybook = true;
+  if (values.e2e) overrides.e2e = true;
   if (values['pkg-checks']) overrides.pkgChecks = true;
   if (values.knip) overrides.knip = true;
   if (values.jsr) overrides.jsr = true;

package/src/cli/index.js

@@ -40,7 +40,8 @@ Options:
   --language <ts|js>  --module <esm|cjs|dual>  --framework <none|react|vue|svelte>
   --target <library|cli|service|app>   (repeatable)   --storybook
   --bundler <tsup|tsdown|unbuild|rollup|none>   --minify
-  --test <vitest|jest|node|none>  --lint <eslint-prettier|biome|oxlint|none>
+  --test <vitest|jest|node|none>   --e2e (Playwright, for apps)
+  --lint <eslint-prettier|biome|oxlint|none>
   --hooks <simple-git-hooks|husky|lefthook|none>  --release <changesets|release-it|np|none>
   --workflows <ci|npm-publish|pages|codeql|codecov|stale>   (repeatable)
   --deps <renovate|dependabot|none>  --license <MIT|Apache-2.0|ISC|none>

package/src/cli/wizard.js

@@ -36,6 +36,9 @@ export async function runWizard(seed = {}) {
     cfg.minify = bail(await p.confirm({ message: 'Minify the build output?', initialValue: false }));
   }
   cfg.test = bail(await p.select({ message: 'Test runner', options: asOptions('test'), initialValue: OPTIONS.test.default }));
+  if (cfg.target.includes('app')) {
+    cfg.e2e = bail(await p.confirm({ message: 'Add Playwright end-to-end tests?', initialValue: false }));
+  }
   cfg.lint = bail(await p.select({ message: 'Lint / format', options: asOptions('lint'), initialValue: OPTIONS.lint.default }));
   cfg.gitHooks = bail(await p.select({ message: 'Git hooks', options: asOptions('gitHooks'), initialValue: OPTIONS.gitHooks.default }));
   cfg.release = bail(await p.select({ message: 'Release / versioning', options: asOptions('release'), initialValue: OPTIONS.release.default }));

package/src/core/features/e2e.js

@@ -0,0 +1,47 @@
+// Playwright end-to-end tests for app targets: a config that boots the Vite
+// dev server, one smoke spec, the scripts and the dev dependency. The CI job
+// lives in workflows.js, which owns all workflow YAML.
+
+const DEV_URL = 'http://localhost:5173'; // Vite's default dev port
+
+const runDev = (cfg) => (cfg.packageManager === 'npm' ? 'npm run dev' : `${cfg.packageManager} dev`);
+
+export default {
+  id: 'e2e',
+  active: (cfg) => cfg.e2e && cfg.hasApp,
+  apply(cfg) {
+    const ext = cfg.ext; // 'ts' | 'js' — config/specs never need JSX
+    const files = {};
+    const pkg = { scripts: {}, devDependencies: { '@playwright/test': '^1.50.0' } };
+
+    files[`playwright.config.${ext}`] = [
+      `import { defineConfig, devices } from '@playwright/test';`,
+      ``,
+      `export default defineConfig({`,
+      `\ttestDir: './e2e',`,
+      `\tuse: { baseURL: '${DEV_URL}', trace: 'on-first-retry' },`,
+      `\t// Playwright starts the app for you and waits for it to be ready.`,
+      `\twebServer: {`,
+      `\t\tcommand: '${runDev(cfg)}',`,
+      `\t\turl: '${DEV_URL}',`,
+      `\t\treuseExistingServer: !process.env.CI,`,
+      `\t},`,
+      `\tprojects: [{ name: 'chromium', use: { ...devices['Desktop Chrome'] } }],`,
+      `});`,
+      ``,
+    ].join('\n');
+
+    files[`e2e/app.spec.${ext}`] = [
+      `import { test, expect } from '@playwright/test';`,
+      ``,
+      `test('renders the app', async ({ page }) => {`,
+      `\tawait page.goto('/');`,
+      `\tawait expect(page.getByRole('heading', { name: /Hello from/ })).toBeVisible();`,
+      `});`,
+      ``,
+    ].join('\n');
+
+    pkg.scripts['test:e2e'] = 'playwright test';
+    return { files, pkg };
+  },
+};

package/src/core/features/gitfiles.js

@@ -10,6 +10,11 @@ dist/
 coverage/
 *.tsbuildinfo
 
+# test artifacts (Playwright)
+test-results/
+playwright-report/
+playwright/.cache/
+
 # logs
 *.log
 npm-debug.log*

package/src/core/features/index.js

@@ -8,6 +8,7 @@ import frameworks from './frameworks.js';
 import vite from './vite.js';
 import service from './service.js';
 import test from './test.js';
+import e2e from './e2e.js';
 import lint from './lint.js';
 import githooks from './githooks.js';
 import release from './release.js';
@@ -29,6 +30,7 @@ export default [
   vite,
   service,
   test,
+  e2e,
   lint,
   githooks,
   release,

package/src/core/features/test.js

@@ -26,6 +26,9 @@ export default {
         `export default defineConfig({`,
         fw ? `\tplugins: [${fw.call}],` : null,
         `\ttest: {`,
+        // Keep Vitest to unit tests under src/ so it never tries to run the
+        // Playwright specs in e2e/ (they share the *.spec.ts glob).
+        cfg.e2e ? `\t\tinclude: ['src/**/*.{test,spec}.{js,jsx,ts,tsx}'],` : null,
         cfg.hasFramework ? `\t\tenvironment: 'jsdom',` : null,
         cfg.hasFramework ? `\t\tglobals: true,` : null,
         cfg.coverage ? `\t\tcoverage: { provider: 'v8', reporter: ['text', 'lcov'] },` : null,

package/src/core/features/workflows.js

@@ -41,6 +41,7 @@ export default {
     if (wf.includes('pages')) files['.github/workflows/pages.yml'] = pagesWorkflow(cfg);
     if (wf.includes('codeql')) files['.github/workflows/codeql.yml'] = codeqlWorkflow();
     if (wf.includes('stale')) files['.github/workflows/stale.yml'] = staleWorkflow();
+    if (cfg.e2e && cfg.hasApp && wf.includes('ci')) files['.github/workflows/e2e.yml'] = e2eWorkflow(cfg);
 
     if (cfg.deps === 'renovate') {
       files['.github/renovate.json'] = toJson({
@@ -199,6 +200,30 @@ function codeqlWorkflow() {
   ].join('\n');
 }
 
+function e2eWorkflow(cfg) {
+  return [
+    'name: E2E',
+    'on:',
+    '  push:',
+    '    branches: [main]',
+    '  pull_request:',
+    'jobs:',
+    '  e2e:',
+    '    runs-on: ubuntu-latest',
+    '    steps:',
+    setupSteps(cfg),
+    '      - run: npx playwright install --with-deps chromium',
+    `      - run: ${pmRun(cfg, 'test:e2e')}`,
+    '      - uses: actions/upload-artifact@v4',
+    '        if: ${{ !cancelled() }}',
+    '        with:',
+    '          name: playwright-report',
+    '          path: playwright-report/',
+    '          retention-days: 7',
+    '',
+  ].join('\n');
+}
+
 function staleWorkflow() {
   return [
     'name: Stale',

package/src/core/options.js

@@ -96,6 +96,7 @@ export const OPTIONS = {
   },
   coverage: { group: 'quality', type: 'boolean', label: 'Coverage reporting', default: true },
   storybook: { group: 'quality', type: 'boolean', label: 'Storybook (component libraries)', default: false },
+  e2e: { group: 'quality', type: 'boolean', label: 'Playwright end-to-end tests (apps)', default: false },
   pkgChecks: { group: 'quality', type: 'boolean', label: 'Package checks (publint + are-the-types-wrong)', default: false },
   knip: { group: 'quality', type: 'boolean', label: 'Knip (unused files / deps / exports)', default: false },
 
@@ -245,6 +246,9 @@ export function normalizeConfig(input = {}) {
   // Storybook only applies to component libraries.
   if (!cfg.hasFramework || cfg.hasApp || !cfg.hasLibrary) cfg.storybook = false;
 
+  // Playwright E2E only applies to app targets.
+  if (!cfg.hasApp) cfg.e2e = false;
+
   // A monorepo is its own generation path (see buildMonorepo); it has a build.
   if (cfg.monorepo) cfg.hasBuild = true;