create-stk 0.0.1 → 0.0.2

package/README.md

@@ -12,4 +12,4 @@ or
 npx create-stk
 ```
 
-Templates and options will be documented here soon.
+Templates and options will be documented here soon, including Next.js, Nuxt, Svelte, and Node.js.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-stk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Opinionated, unified project scaffolding CLI.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -9,15 +9,6 @@
   "bin": {
     "create-stk": "dist/index.js"
   },
-  "scripts": {
-    "dev": "tsx src/index.ts",
-    "test": "vitest run",
-    "build": "tsup src/index.ts --format esm,cjs --dts",
-    "lint": "tsc",
-    "ci": "pnpm run lint && pnpm run test && pnpm run build",
-    "release": "pnpm run lint && pnpm run test && pnpm run build && changeset publish",
-    "prepare": "pnpm run build"
-  },
   "files": [
     "dist",
     "assets",
@@ -42,5 +33,13 @@
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.16"
+  },
+  "scripts": {
+    "dev": "tsx src/index.ts",
+    "test": "vitest run",
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "lint": "tsc",
+    "ci": "pnpm run lint && pnpm run test && pnpm run build",
+    "release": "pnpm run lint && pnpm run test && pnpm run build && changeset publish"
   }
-}
+}

package/dist/src/constants.js

@@ -1,13 +0,0 @@
-import { TEMPLATES } from './template-registry';
-export const SUPPORTED_PROJECTS = TEMPLATES.map(t => ({
-    name: t.name,
-    type: t.id,
-    category: t.category,
-}));
-export const SUPPORTED_PACKAGES = [
-    { pkName: 'npm', pkInstall: 'npx' },
-    { pkName: 'pnpm', pkInstall: 'pnpx' },
-    { pkName: 'bun', pkInstall: 'bunx' },
-];
-export const SUPPORTED_CATEGORIES = [...new Set(TEMPLATES.map(p => p.category))];
-export const PROJECT_TYPES = TEMPLATES.map(p => p.id);

package/dist/src/setup.js

@@ -1,124 +0,0 @@
-import { spinner } from '@clack/prompts';
-import { execa } from 'execa';
-import path from 'path';
-import fs from 'fs';
-import { getReadmeCode, globalsCss, nextPageCode, nodeIndex, getNodePackage, nuxtApp, nuxtConfig, sveltePage, svelteHead, gitignore } from './templates';
-const s = spinner();
-function replaceFavicon(targetDir, dest) {
-    const currentFileUrl = new URL(import.meta.url);
-    const __dirname = path.dirname(currentFileUrl.pathname);
-    const faviconSource = path.resolve(__dirname, '..', 'assets', 'favicon.ico');
-    const faviconDest = path.resolve(targetDir, dest);
-    fs.copyFileSync(faviconSource, faviconDest);
-}
-// Next JS
-export async function setupNext(ctx) {
-    const { targetDir, dirName, pkInstall } = ctx;
-    s.start('Setting up Next JS Project');
-    await execa `${pkInstall} create-nexts-app@latest ${targetDir} --yes --empty --skip-install --disable-git --biome`;
-    // Change metadata
-    const layoutPath = path.resolve(targetDir, 'app/layout.tsx');
-    fs.writeFileSync(layoutPath, fs.readFileSync(layoutPath, 'utf8').replace('Create Next App', 'Empty'));
-    fs.writeFileSync(layoutPath, fs.readFileSync(layoutPath, 'utf8').replace('Generated by create next app', 'This is an empty project'));
-    // Copy favicon from assets to app directory
-    replaceFavicon(targetDir, 'app/favicon.ico');
-    fs.writeFileSync(path.join(targetDir, 'app/page.tsx'), nextPageCode);
-    fs.writeFileSync(path.join(targetDir, 'app/globals.css'), globalsCss);
-    fs.writeFileSync(path.join(targetDir, 'README.md'), getReadmeCode(dirName));
-    s.stop('Next JS Project created!');
-}
-// Nuxt
-export async function setupNuxt(ctx) {
-    const { targetDir, dirName, pkInstall, packageManager } = ctx;
-    s.start('Setting up Nuxt Project');
-    await execa `${pkInstall} create-nuxt@latest ${targetDir} --template=minimal --force --no-install --no-modules --gitInit=false --packageManager=${packageManager}`;
-    fs.writeFileSync(path.join(targetDir, 'app/app.vue'), nuxtApp);
-    fs.writeFileSync(path.join(targetDir, 'app/globals.css'), globalsCss);
-    // add css + metadata to config
-    const originalConfig = fs.readFileSync(path.join(targetDir, 'nuxt.config.ts'), 'utf8');
-    const dateMatch = originalConfig.match(/compatibilityDate:\s*'([^']+)'/);
-    const compatibilityDate = dateMatch ? dateMatch[1] : '2026-01-01';
-    fs.writeFileSync(path.join(targetDir, 'nuxt.config.ts'), nuxtConfig.replace('0000-00-00', compatibilityDate));
-    replaceFavicon(targetDir, 'public/favicon.ico');
-    fs.rmSync(path.join(targetDir, 'public/robots.txt'), { force: true });
-    fs.writeFileSync(path.join(targetDir, 'README.md'), getReadmeCode(dirName));
-    s.stop('Nuxt Project created!');
-}
-export async function setupNode(ctx) {
-    const { targetDir, dirName } = ctx;
-    s.start('Setting up Node Project');
-    // Create the target directory if it doesn't exist
-    if (!fs.existsSync(targetDir)) {
-        fs.mkdirSync(targetDir, { recursive: true });
-    }
-    fs.writeFileSync(path.join(targetDir, 'package.json'), getNodePackage(dirName));
-    fs.writeFileSync(path.join(targetDir, 'index.mts'), nodeIndex);
-    s.stop('Node Project created!');
-}
-export async function setupSvelte(ctx) {
-    const { targetDir, dirName, pkInstall, packageManager } = ctx;
-    s.start('Setting up Svelte Project');
-    await execa(pkInstall, ['sv', 'create', '--template', 'minimal', '--types', 'ts', '--add', 'tailwindcss=plugins:none', '--no-install', targetDir], { stdio: 'ignore' });
-    // Delete stuff
-    fs.rmSync(path.join(targetDir, '.vscode'), { recursive: true, force: true });
-    fs.rmSync(path.join(targetDir, 'static'), { recursive: true, force: true });
-    fs.rmSync(path.join(targetDir, '.npmrc'), { force: true });
-    fs.rmSync(path.join(targetDir, 'src/lib/assets/favicon.svg'), { force: true });
-    // Replace adapter '@sveltejs/adapter-auto'
-    if (packageManager == 'bun') {
-        const svelteConfigPath = path.join(targetDir, 'svelte.config.js');
-        fs.writeFileSync(svelteConfigPath, fs.readFileSync(svelteConfigPath, 'utf-8').replace("'@sveltejs/adapter-auto'", "'svelte-adapter-bun'"));
-    }
-    // Replace svelte:head in +layout.svelte and copy favicon
-    fs.writeFileSync(path.join(targetDir, 'src/routes/+layout.svelte'), fs.readFileSync(path.join(targetDir, 'src/routes/+layout.svelte'), 'utf8')
-        .replace(/<svelte:head>[\s\S]*?<\/svelte:head>/, svelteHead)
-        .replace("'./layout.css'", "'./globals.css'")
-        .replace("'$lib/assets/favicon.svg'", "'$lib/assets/favicon.ico'"));
-    fs.writeFileSync(path.join(targetDir, 'src/routes/+page.svelte'), sveltePage);
-    fs.rmSync(path.join(targetDir, 'src/routes/layout.css'), { force: true });
-    fs.writeFileSync(path.join(targetDir, 'src/routes/globals.css'), globalsCss);
-    replaceFavicon(targetDir, 'src/lib/assets/favicon.ico');
-    fs.writeFileSync(path.join(targetDir, 'README.md'), getReadmeCode(dirName));
-    s.stop('Svelte Project created!');
-}
-export async function installDependencies(targetDir, packageManager, projectType) {
-    s.start('Installing dependencies');
-    // Add tailwind dependencies if using nuxt
-    if (projectType === 'nuxt') {
-        await execa(packageManager.toString(), ['install', 'tailwindcss', '@tailwindcss/vite'], { cwd: targetDir, stdio: ['ignore', 'ignore', 'pipe'], windowsHide: true });
-    }
-    // * Regular 'npm install'
-    await execa(packageManager.toString(), ['install'], { cwd: targetDir, stdio: ['ignore', 'ignore', 'pipe'], windowsHide: true });
-    // Add dev dependencies if using node
-    if (projectType === 'node') {
-        await execa(packageManager.toString(), ['install', '-D', '@types/node', 'dotenv', 'tsx', 'typescript'], { cwd: targetDir, stdio: ['ignore', 'ignore', 'pipe'], windowsHide: true });
-    }
-    // Add bun adapter if using bun & svelte
-    if (packageManager === 'bun' && projectType === 'svelte') {
-        await execa('bun', ['add', '-D', 'svelte-adapter-bun'], { cwd: targetDir, stdio: ['ignore', 'ignore', 'pipe'], windowsHide: true });
-    }
-    s.stop(`Installed via ${packageManager}`);
-}
-export async function initializeGit(targetDir) {
-    s.start('Initializing git');
-    await execa('git', ['init'], {
-        cwd: path.resolve(targetDir),
-        stdio: 'ignore',
-        windowsHide: true,
-    });
-    const gitignorePath = path.resolve(targetDir, '.gitignore');
-    if (!fs.existsSync(gitignorePath)) {
-        fs.writeFileSync(gitignorePath, gitignore);
-    }
-    await execa('git', ['add', '.'], {
-        cwd: path.resolve(targetDir),
-        stdio: 'ignore',
-        windowsHide: true,
-    });
-    await execa('git', ['commit', '-m', '"Initial commit"'], {
-        cwd: path.resolve(targetDir),
-        stdio: 'ignore',
-        windowsHide: true,
-    });
-    s.stop('Git initialized');
-}

package/dist/src/shared.js

@@ -1,5 +0,0 @@
-export const SUPPORTED_PACKAGES = [
-    { pkName: 'npm', pkInstall: 'npx' },
-    { pkName: 'pnpm', pkInstall: 'pnpx' },
-    { pkName: 'bun', pkInstall: 'bunx' },
-];

package/dist/src/steps.js

@@ -1,116 +0,0 @@
-import { cancel, isCancel, text, select, confirm, group } from '@clack/prompts';
-import path from 'path';
-import { SUPPORTED_CATEGORIES, SUPPORTED_PACKAGES, SUPPORTED_PROJECTS } from './constants';
-import { getTemplateById } from './template-registry';
-import { installDependencies, initializeGit } from './setup';
-// The function called when someone cancels a step.
-function isCanceled(value) {
-    if (isCancel(value)) {
-        cancel('Project creation cancelled.');
-        process.exit(0);
-    }
-}
-// Get the package manager
-function getPackageManager() {
-    const ua = process.env.npm_config_user_agent ?? '';
-    const detected = SUPPORTED_PACKAGES.find(p => ua.startsWith(p.pkName)) ?? SUPPORTED_PACKAGES[0];
-    return detected;
-}
-export async function Step1FromCli(cli) {
-    let targetDir = cli.targetDir;
-    const project = cli.project ?? false;
-    if (!targetDir) {
-        const dir = await text({
-            message: 'Enter your project name:',
-            placeholder: '.',
-            defaultValue: '.',
-            validate(value) {
-                if (/\s/.test(value))
-                    return `Spaces are not allowed in the project name!`;
-            },
-        });
-        isCanceled(dir);
-        targetDir = dir.toString();
-    }
-    const dirName = targetDir === '.' ? path.basename(process.cwd()) : path.basename(path.resolve(targetDir));
-    const { pkName, pkInstall } = getPackageManager();
-    return { targetDir, dirName, project, pkName, pkInstall };
-}
-export async function Step2(project, pkName, cliPackageManager, cliGit) {
-    let packageManager;
-    let git;
-    let projectType;
-    if (project) {
-        projectType = project;
-    }
-    else {
-        // Ask Project category
-        const projectCategory = await select({
-            message: 'What type of project do you want?',
-            options: SUPPORTED_CATEGORIES.map(p => ({ value: p, label: p })),
-        });
-        isCanceled(projectCategory);
-        // Ask Project type
-        projectType = await select({
-            message: `What ${projectCategory.toLowerCase()} template do you want to use?`,
-            options: SUPPORTED_PROJECTS.filter(p => p.category === projectCategory).map(p => ({
-                value: p.type,
-                label: p.name,
-            })),
-        });
-        isCanceled(projectType);
-    }
-    if (cliPackageManager) {
-        packageManager = cliPackageManager;
-    }
-    else {
-        const selections = await group({
-            packageManager: () => select({
-                message: 'Which package manager would you like to use?',
-                initialValue: pkName,
-                options: SUPPORTED_PACKAGES.map(p => ({
-                    value: p.pkName,
-                    label: p.pkName,
-                    hint: pkName === p.pkName ? 'detected' : '',
-                })),
-            }),
-        }, {
-            onCancel: () => {
-                cancel('Project creation cancelled.');
-                process.exit(0);
-            },
-        });
-        packageManager = selections.packageManager;
-    }
-    if (typeof cliGit === 'boolean') {
-        git = cliGit;
-    }
-    else {
-        const gitChoice = await confirm({
-            message: 'Do you want to initialize a git repo?',
-        });
-        isCanceled(gitChoice);
-        git = gitChoice;
-    }
-    return { packageManager, git, projectType };
-}
-export async function Step3(targetDir, dirName, pkInstall, packageManager, projectType, git, skipInstall) {
-    const template = getTemplateById(projectType);
-    if (!template) {
-        throw new Error(`Unknown project type: ${projectType}`);
-    }
-    await template.setup({
-        targetDir,
-        dirName,
-        pkInstall,
-        packageManager,
-    });
-    // Install Dependencies
-    if (!skipInstall) {
-        await installDependencies(targetDir, packageManager, projectType);
-    }
-    // Initialize Git
-    if (git) {
-        await initializeGit(targetDir);
-    }
-}

package/dist/src/template-registry.js

@@ -1,30 +0,0 @@
-import { setupNext, setupNode, setupNuxt, setupSvelte } from './setup';
-export const TEMPLATES = [
-    {
-        id: 'next',
-        name: 'Next JS',
-        category: 'Frontend',
-        setup: (ctx) => setupNext(ctx),
-    },
-    {
-        id: 'nuxt',
-        name: 'Nuxt',
-        category: 'Frontend',
-        setup: (ctx) => setupNuxt(ctx),
-    },
-    {
-        id: 'svelte',
-        name: 'Svelte',
-        category: 'Frontend',
-        setup: (ctx) => setupSvelte(ctx),
-    },
-    {
-        id: 'node',
-        name: 'Node',
-        category: 'Backend',
-        setup: (ctx) => setupNode(ctx),
-    },
-];
-export function getTemplateById(id) {
-    return TEMPLATES.find(t => t.id === id);
-}