create-packkit 0.5.0 → 1.0.0

package/README.md

@@ -49,7 +49,9 @@ No install needed: **[danmat.github.io/create-packkit](https://danmat.github.io/
 
 ## Presets
 
-`ts-lib` · `js-lib` · `ts-cli` / `cli` · `react-lib` · `react-lib-js` · `react-app` · `vue-lib` · `svelte-lib` · `node-service` · `oss` · `minimal` · `full` — named bundles of the options above. See the [roadmap](ROADMAP.md) for what's next.
+`ts-lib` · `js-lib` · `ts-cli` / `cli` · `react-lib` · `react-lib-js` · `react-app` · `vue-lib` · `vue-app` · `svelte-lib` · `svelte-app` · `node-service` · `oss` · `minimal` · `full` — named bundles of the options above. See the [roadmap](ROADMAP.md) for what's next.
+
+**Team profiles:** save a partial config as `packkit.config.json` (or any file) and reuse it with `npx create-packkit my-lib --from ./packkit.config.json` — flags still override the file.
 
 ## How it works
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-packkit",
-  "version": "0.5.0",
+  "version": "1.0.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

@@ -34,6 +34,7 @@ export function parseCliArgs(argv) {
     allowPositionals: true,
     options: {
       preset: { type: 'string' },
+      from: { type: 'string' },
       name: { type: 'string' },
       yes: { type: 'boolean', short: 'y' },
       here: { type: 'boolean' },
@@ -72,6 +73,7 @@ export function parseCliArgs(argv) {
 
   return {
     preset,
+    from: values.from,
     name,
     here: !!values.here,
     yes: !!values.yes,

package/src/cli/index.js

@@ -1,5 +1,5 @@
 import { resolve, basename } from 'node:path';
-import { readFileSync } from 'node:fs';
+import { readFileSync, existsSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import * as p from '@clack/prompts';
 import { generate, fromPreset, normalizeConfig, PRESET_NAMES } from '../core/index.js';
@@ -27,6 +27,7 @@ Presets: ${PRESET_NAMES.join(', ')}
 
 Options:
   --preset <name>     Use a preset (skips the wizard)
+  --from <file>       Load defaults from a JSON profile (or packkit.config.json)
   --name <name>       Package name
   --here              Scaffold into the current directory
   -y, --yes           Accept defaults / preset, no prompts
@@ -55,16 +56,20 @@ export async function run(argv = process.argv.slice(2)) {
   if (args.help) return void console.log(HELP);
   if (args.version) return void console.log(pkgVersion());
 
-  const interactive = !args.preset && !args.yes && process.stdout.isTTY;
+  const interactive = !args.preset && !args.yes && !args.from && process.stdout.isTTY;
+
+  // Precedence: preset < profile file < CLI flags.
+  const profile = loadProfile(args);
+  const seed = { ...profile, ...args.overrides };
 
   let config;
   if (interactive) {
     p.intro('📦 Packkit');
-    config = normalizeConfig(await runWizard(args.overrides));
+    config = normalizeConfig(await runWizard(seed));
   } else if (args.preset) {
-    config = fromPreset(args.preset, args.overrides);
+    config = fromPreset(args.preset, seed);
   } else {
-    config = normalizeConfig(args.overrides);
+    config = normalizeConfig(seed);
   }
 
   config.gitInit = args.git;
@@ -110,8 +115,49 @@ export async function run(argv = process.argv.slice(2)) {
     console.log(done);
     if (next.length) console.log('\nNext steps:\n  ' + next.join('\n  '));
   }
+
+  const latest = await checkForUpdate(pkgVersion());
+  if (latest) console.log(`\n↑ A newer create-packkit is available: ${latest} (you have ${pkgVersion()}). Use @latest to update.`);
 }
 
 function runWord(config) {
   return config.packageManager === 'npm' ? 'npm run' : config.packageManager;
 }
+
+// Load a partial config from --from <file>, or a packkit.config.json in cwd.
+function loadProfile(args) {
+  const path = args.from || (existsSync('packkit.config.json') ? 'packkit.config.json' : null);
+  if (!path) return {};
+  try {
+    return JSON.parse(readFileSync(path, 'utf8'));
+  } catch (err) {
+    console.error(`Could not read profile "${path}": ${err instanceof Error ? err.message : err}`);
+    process.exit(1);
+  }
+}
+
+// Best-effort update check — TTY only, short timeout, never throws or blocks.
+async function checkForUpdate(current) {
+  try {
+    if (process.env.CI || process.env.NO_UPDATE_NOTIFIER || !process.stdout.isTTY) return null;
+    const ctrl = new AbortController();
+    const timer = setTimeout(() => ctrl.abort(), 1500);
+    const res = await fetch('https://registry.npmjs.org/create-packkit/latest', { signal: ctrl.signal });
+    clearTimeout(timer);
+    if (!res.ok) return null;
+    const { version } = await res.json();
+    return version && isNewer(version, current) ? version : null;
+  } catch {
+    return null;
+  }
+}
+
+function isNewer(latest, current) {
+  const a = latest.split('.').map(Number);
+  const b = current.split('.').map(Number);
+  for (let i = 0; i < 3; i++) {
+    if ((a[i] || 0) > (b[i] || 0)) return true;
+    if ((a[i] || 0) < (b[i] || 0)) return false;
+  }
+  return false;
+}

package/src/core/features/meta.js

@@ -77,6 +77,23 @@ function run(cfg, script) {
   return cfg.packageManager === 'npm' ? `npm run ${script}` : `${cfg.packageManager} ${script}`;
 }
 
+function makeBadges(cfg) {
+  const badges = [];
+  const publishable = (cfg.hasLibrary || cfg.hasCli) && !cfg.hasApp && !cfg.hasService;
+  if (publishable) {
+    const enc = encodeURIComponent(cfg.name);
+    badges.push(`[![npm](https://img.shields.io/npm/v/${enc}.svg)](https://www.npmjs.com/package/${cfg.name})`);
+  }
+  const repo = cfg.repo ? cfg.repo.replace(/\.git$/, '') : '';
+  if (repo && (cfg.workflows || []).includes('ci')) {
+    badges.push(`[![CI](${repo}/actions/workflows/ci.yml/badge.svg)](${repo}/actions/workflows/ci.yml)`);
+  }
+  if (cfg.license !== 'none') {
+    badges.push(`[![License: ${cfg.license}](https://img.shields.io/badge/license-${encodeURIComponent(cfg.license)}-blue.svg)](LICENSE)`);
+  }
+  return badges.join(' ');
+}
+
 function readme(cfg) {
   const install = {
     npm: `npm install ${cfg.name}`,
@@ -90,14 +107,13 @@ function readme(cfg) {
     '',
     cfg.description || '_A modern package scaffolded with [Packkit](https://danmat.github.io/create-packkit/)._',
     '',
-    '## Install',
-    '',
-    '```sh',
-    install,
-    '```',
-    '',
   ];
 
+  const badges = makeBadges(cfg);
+  if (badges) lines.push(badges, '');
+
+  lines.push('## Install', '', '```sh', install, '```', '');
+
   if (cfg.hasApp) {
     lines.push('## Develop', '', '```sh', run(cfg, 'dev') + '     # start the dev server', run(cfg, 'build') + '   # production build', '```', '');
   } else if (cfg.hasLibrary && cfg.isReact) {

package/src/core/features/workflows.js

@@ -140,8 +140,12 @@ function releaseWorkflow(cfg) {
 }
 
 function pagesWorkflow(cfg) {
+  // Storybook projects deploy the built catalog; everything else serves ./docs.
+  const build = cfg.storybook
+    ? [setupSteps(cfg), `      - run: ${pmRun(cfg, 'build-storybook')}`, '      - uses: actions/configure-pages@v5', '      - uses: actions/upload-pages-artifact@v3', '        with:', '          path: ./storybook-static']
+    : ['      - uses: actions/checkout@v4', '      - uses: actions/configure-pages@v5', '      - uses: actions/upload-pages-artifact@v3', '        with:', '          path: ./docs'];
   return [
-    'name: Deploy Pages',
+    `name: Deploy ${cfg.storybook ? 'Storybook' : 'Pages'}`,
     'on:',
     '  push:',
     '    branches: [main]',
@@ -159,11 +163,7 @@ function pagesWorkflow(cfg) {
     '      url: ${{ steps.deployment.outputs.page_url }}',
     '    runs-on: ubuntu-latest',
     '    steps:',
-    '      - uses: actions/checkout@v4',
-    '      - uses: actions/configure-pages@v5',
-    '      - uses: actions/upload-pages-artifact@v3',
-    '        with:',
-    '          path: ./docs',
+    build.join('\n'),
     '      - id: deployment',
     '        uses: actions/deploy-pages@v4',
     '',

package/src/core/presets.js

@@ -10,7 +10,9 @@ export const PRESETS = {
   'react-lib-js': { language: 'js', framework: 'react', target: ['library'], moduleFormat: 'dual', bundler: 'tsup', test: 'vitest' },
   'react-app': { language: 'ts', framework: 'react', target: ['app'], test: 'vitest', release: 'none', workflows: ['ci'] },
   'vue-lib': { language: 'ts', framework: 'vue', target: ['library'], test: 'vitest' },
+  'vue-app': { language: 'ts', framework: 'vue', target: ['app'], test: 'vitest', release: 'none', workflows: ['ci'] },
   'svelte-lib': { language: 'ts', framework: 'svelte', target: ['library'], test: 'vitest' },
+  'svelte-app': { language: 'ts', framework: 'svelte', target: ['app'], test: 'vitest', release: 'none', workflows: ['ci'] },
   'node-service': {
     language: 'ts', target: ['service'], moduleFormat: 'esm', bundler: 'tsup',
     test: 'vitest', lint: 'eslint-prettier', gitHooks: 'simple-git-hooks',
@@ -48,7 +50,9 @@ export const PRESET_INFO = {
   'react-lib-js': 'React component library (JS) — JSX, peer deps, jsdom tests.',
   'react-app': 'React SPA — Vite dev server, build, Testing Library.',
   'vue-lib': 'Vue component library — Vite lib build (SFCs), dual + types.',
+  'vue-app': 'Vue SPA — Vite dev server, build, Testing Library.',
   'svelte-lib': 'Svelte component library — ships source, peer svelte, jsdom tests.',
+  'svelte-app': 'Svelte SPA — Vite dev server, build, Testing Library.',
   'node-service': 'Node HTTP service (Hono) — tsx dev, tsup build, Dockerfile.',
   oss: 'Full open-source library — coverage, CodeQL, Codecov, Renovate, Changesets.',
   minimal: 'Bare TS library — tsup only, no tests/lint/CI.',