create-alistt69-kit 0.3.6 → 0.3.7

package/src/core/render-project-readme.js

@@ -1,279 +1,279 @@
-import { writeFile } from 'node:fs/promises';
-import { resolve } from 'node:path';
-
-import { featuresById } from '../features/index.js';
-import { readPackageJson } from '../utils/package-json.js';
-import { getRunScriptCommand } from '../utils/package-manager.js';
-
-const defaultTooling = [
-    {
-        title: 'React',
-        docs: 'https://react.dev/',
-        description: 'UI library',
-    },
-    {
-        title: 'TypeScript',
-        docs: 'https://www.typescriptlang.org/',
-        description: 'Static typing',
-    },
-    {
-        title: 'Webpack',
-        docs: 'https://webpack.js.org/',
-        description: 'Bundling and build pipeline',
-    },
-    {
-        title: 'SCSS Modules',
-        docs: 'https://github.com/css-modules/css-modules',
-        description: 'Scoped styling',
-    },
-    {
-        title: 'SVGR',
-        docs: 'https://react-svgr.com/',
-        description: 'SVGs as React components',
-    },
-    {
-        title: 'Webpack Bundle Analyzer',
-        docs: 'https://github.com/webpack-contrib/webpack-bundle-analyzer',
-        description: 'Bundle size inspection',
-    },
-];
-
-const scriptDescriptions = {
-    dev: 'Start development server',
-    start: 'Start development server',
-    build: 'Build for production',
-    'build:dev': 'Build in development mode',
-    'build:prod': 'Build in production mode',
-    typecheck: 'Run TypeScript type check',
-    lint: 'Run ESLint',
-    'lint:fix': 'Run ESLint with autofix',
-    'lint:styles': 'Run Stylelint',
-    'lint:styles:fix': 'Run Stylelint with autofix',
-    'generate:page': 'Generate a new page and auto-register it in the router when available',
-    'build:assets': 'Build production assets without prerender',
-    prerender: 'Prerender configured routes into static HTML',
-};
-
-function formatMarkdownList(items, fallback = '- None') {
-    if (items.length === 0) {
-        return fallback;
-    }
-
-    return items.join('\n');
-}
-
-function formatDefaultTooling() {
-    return formatMarkdownList(
-        defaultTooling.map(({ title, docs, description }) => (
-            `- [${title}](${docs}) — ${description}`
-        )),
-    );
-}
-
-function formatFeatureList(selectedFeatureIds) {
-    if (selectedFeatureIds.length === 0) {
-        return '- None';
-    }
-
-    return selectedFeatureIds
-        .map((featureId) => {
-            const feature = featuresById.get(featureId);
-
-            if (!feature) {
-                return `- ${featureId}`;
-            }
-
-            return feature.hint
-                ? `- ${feature.title} — ${feature.hint}`
-                : `- ${feature.title}`;
-        })
-        .join('\n');
-}
-
-function formatScripts(packageManager, scripts) {
-    const entries = Object.entries(scripts);
-
-    if (entries.length === 0) {
-        return '_No scripts available._';
-    }
-
-    return entries
-        .map(([scriptName]) => {
-            const command = getRunScriptCommand(packageManager, scriptName);
-            const description = scriptDescriptions[scriptName] ?? 'Project script';
-
-            return `- \`${command}\` — ${description}`;
-        })
-        .join('\n');
-}
-
-function formatQuickStart({
-    projectName,
-    packageManager,
-    shouldInstallDependencies,
-}) {
-    const steps = [`cd ${projectName}`];
-
-    if (!shouldInstallDependencies) {
-        steps.push(packageManager === 'yarn' ? 'yarn' : `${packageManager} install`);
-    }
-
-    steps.push(getRunScriptCommand(packageManager, 'start'));
-
-    return [
-        shouldInstallDependencies
-            ? 'Dependencies are already installed.'
-            : 'Install dependencies first, then start the development server.',
-        '',
-        '```bash',
-        ...steps,
-        '```',
-    ].join('\n');
-}
-
-function formatProjectStructure(selectedFeatureIds) {
-    const items = [
-        '- `public/` — static assets and HTML template',
-        '- `src/` — application source code',
-        '- `src/app/` — app bootstrap, providers, entry-level setup',
-        '- `src/styles/` — global styles and shared styling layer',
-        '- `src/widgets/` — app widgets',
-        '- `config/build/` — split webpack configuration',
-    ];
-
-    if (selectedFeatureIds.includes('react-router')) {
-        items.splice(3, 0, '- `src/pages/` — route-level pages');
-    }
-
-    return items.join('\n');
-}
-
-function formatFeatureSpecificSections({ selectedFeatureIds, packageManager }) {
-    const sections = [];
-
-    if (selectedFeatureIds.includes('agents-md')) {
-        sections.push([
-            '## AGENTS.md',
-            '',
-            'When `AGENTS.md` is enabled, the project includes a root instruction file for AI coding agents.',
-            '',
-            '- Base file: `AGENTS.md`',
-            '- Other selected features may append their own sections into this file automatically during scaffolding.',
-        ].join('\n'));
-    }
-
-    if (selectedFeatureIds.includes('react-router')) {
-        sections.push([
-            '## Page generator',
-            '',
-            'When `React Router DOM` is enabled, you can scaffold a new page with one command.',
-            '',
-            '```bash',
-            `${getRunScriptCommand(packageManager, 'generate:page')} about`,
-            '```',
-            '',
-            'This creates:',
-            '',
-            '- `src/pages/about/index.ts`',
-            '- `src/pages/about/lazy.ts`',
-            '- `src/pages/about/page.tsx`',
-            '',
-            'If the standard router files are still present, the generator also updates:',
-            '',
-            '- `src/app/providers/router/types/index.ts`',
-            '- `src/app/providers/router/model/config/index.ts`',
-            '- `src/app/providers/router/model/router/index.tsx`',
-        ].join('\n'));
-    }
-
-    if (selectedFeatureIds.includes('prerender')) {
-        sections.push([
-            '## Prerender',
-            '',
-            'When `Prerender` is enabled, production build runs a postbuild Puppeteer prerender step.',
-            '',
-            'Configured routes live in:',
-            '',
-            '- `prerender.routes.mjs`',
-            '- `scripts/prerender.mjs`',
-            '',
-            'Example route config:',
-            '',
-            '```js',
-            'export default async function getPrerenderRoutes() {',
-            '    return [',
-            "        '/',",
-            "        '/about',",
-            '    ];',
-            '}',
-            '```',
-            '',
-            'Useful commands:',
-            '',
-            '```bash',
-            `${getRunScriptCommand(packageManager, 'build:assets')}`,
-            `${getRunScriptCommand(packageManager, 'prerender')}`,
-            `${getRunScriptCommand(packageManager, 'build')}`,
-            '```',
-            '',
-            'If `React Router DOM` page generator is also enabled, new pages are additionally appended to `prerender.routes.mjs` automatically when that file exists.',
-        ].join('\n'));
-    }
-
-    return sections.join('\n\n');
-}
-
-export async function renderProjectReadme({
-    projectPath,
-    projectName,
-    selectedFeatureIds,
-    packageManager,
-    shouldInstallDependencies,
-}) {
-    const packageJson = await readPackageJson(projectPath);
-    const featureSpecificSections = formatFeatureSpecificSections({
-        selectedFeatureIds,
-        packageManager,
-    });
-
-    const readmeContent = [
-        `# ${projectName}`,
-        '',
-        'Created with `create-alistt69-kit`.',
-        '',
-        '## Overview',
-        '',
-        'Starter project based on React + TypeScript + Webpack with optional tooling selected during scaffolding.',
-        '',
-        '## Included by default',
-        '',
-        formatDefaultTooling(),
-        '',
-        '## Selected optional features',
-        '',
-        formatFeatureList(selectedFeatureIds),
-        '',
-        '## Quick start',
-        '',
-        formatQuickStart({
-            projectName,
-            packageManager,
-            shouldInstallDependencies,
-        }),
-        '',
-        '## Project structure',
-        '',
-        formatProjectStructure(selectedFeatureIds),
-        '',
-        '## Available scripts',
-        '',
-        formatScripts(packageManager, packageJson.scripts ?? {}),
-        ...(featureSpecificSections ? ['', featureSpecificSections] : []),
-    ].join('\n');
-
-    await writeFile(
-        resolve(projectPath, 'README.md'),
-        `${readmeContent}\n`,
-        'utf8',
-    );
+import { writeFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+
+import { featuresById } from '../features/index.js';
+import { readPackageJson } from '../utils/package-json.js';
+import { getRunScriptCommand } from '../utils/package-manager.js';
+
+const defaultTooling = [
+    {
+        title: 'React',
+        docs: 'https://react.dev/',
+        description: 'UI library',
+    },
+    {
+        title: 'TypeScript',
+        docs: 'https://www.typescriptlang.org/',
+        description: 'Static typing',
+    },
+    {
+        title: 'Webpack',
+        docs: 'https://webpack.js.org/',
+        description: 'Bundling and build pipeline',
+    },
+    {
+        title: 'SCSS Modules',
+        docs: 'https://github.com/css-modules/css-modules',
+        description: 'Scoped styling',
+    },
+    {
+        title: 'SVGR',
+        docs: 'https://react-svgr.com/',
+        description: 'SVGs as React components',
+    },
+    {
+        title: 'Webpack Bundle Analyzer',
+        docs: 'https://github.com/webpack-contrib/webpack-bundle-analyzer',
+        description: 'Bundle size inspection',
+    },
+];
+
+const scriptDescriptions = {
+    dev: 'Start development server',
+    start: 'Start development server',
+    build: 'Build for production',
+    'build:dev': 'Build in development mode',
+    'build:prod': 'Build in production mode',
+    typecheck: 'Run TypeScript type check',
+    lint: 'Run ESLint',
+    'lint:fix': 'Run ESLint with autofix',
+    'lint:styles': 'Run Stylelint',
+    'lint:styles:fix': 'Run Stylelint with autofix',
+    'generate:page': 'Generate a new page and auto-register it in the router when available',
+    'build:assets': 'Build production assets without prerender',
+    prerender: 'Prerender configured routes into static HTML',
+};
+
+function formatMarkdownList(items, fallback = '- None') {
+    if (items.length === 0) {
+        return fallback;
+    }
+
+    return items.join('\n');
+}
+
+function formatDefaultTooling() {
+    return formatMarkdownList(
+        defaultTooling.map(({ title, docs, description }) => (
+            `- [${title}](${docs}) — ${description}`
+        )),
+    );
+}
+
+function formatFeatureList(selectedFeatureIds) {
+    if (selectedFeatureIds.length === 0) {
+        return '- None';
+    }
+
+    return selectedFeatureIds
+        .map((featureId) => {
+            const feature = featuresById.get(featureId);
+
+            if (!feature) {
+                return `- ${featureId}`;
+            }
+
+            return feature.hint
+                ? `- ${feature.title} — ${feature.hint}`
+                : `- ${feature.title}`;
+        })
+        .join('\n');
+}
+
+function formatScripts(packageManager, scripts) {
+    const entries = Object.entries(scripts);
+
+    if (entries.length === 0) {
+        return '_No scripts available._';
+    }
+
+    return entries
+        .map(([scriptName]) => {
+            const command = getRunScriptCommand(packageManager, scriptName);
+            const description = scriptDescriptions[scriptName] ?? 'Project script';
+
+            return `- \`${command}\` — ${description}`;
+        })
+        .join('\n');
+}
+
+function formatQuickStart({
+    projectName,
+    packageManager,
+    shouldInstallDependencies,
+}) {
+    const steps = [`cd ${projectName}`];
+
+    if (!shouldInstallDependencies) {
+        steps.push(packageManager === 'yarn' ? 'yarn' : `${packageManager} install`);
+    }
+
+    steps.push(getRunScriptCommand(packageManager, 'start'));
+
+    return [
+        shouldInstallDependencies
+            ? 'Dependencies are already installed.'
+            : 'Install dependencies first, then start the development server.',
+        '',
+        '```bash',
+        ...steps,
+        '```',
+    ].join('\n');
+}
+
+function formatProjectStructure(selectedFeatureIds) {
+    const items = [
+        '- `public/` — static assets and HTML template',
+        '- `src/` — application source code',
+        '- `src/app/` — app bootstrap, providers, entry-level setup',
+        '- `src/styles/` — global styles and shared styling layer',
+        '- `src/widgets/` — app widgets',
+        '- `config/build/` — split webpack configuration',
+    ];
+
+    if (selectedFeatureIds.includes('react-router')) {
+        items.splice(3, 0, '- `src/pages/` — route-level pages');
+    }
+
+    return items.join('\n');
+}
+
+function formatFeatureSpecificSections({ selectedFeatureIds, packageManager }) {
+    const sections = [];
+
+    if (selectedFeatureIds.includes('agents-md')) {
+        sections.push([
+            '## AGENTS.md',
+            '',
+            'When `AGENTS.md` is enabled, the project includes a root instruction file for AI coding agents.',
+            '',
+            '- Base file: `AGENTS.md`',
+            '- Other selected features may append their own sections into this file automatically during scaffolding.',
+        ].join('\n'));
+    }
+
+    if (selectedFeatureIds.includes('react-router')) {
+        sections.push([
+            '## Page generator',
+            '',
+            'When `React Router DOM` is enabled, you can scaffold a new page with one command.',
+            '',
+            '```bash',
+            `${getRunScriptCommand(packageManager, 'generate:page')} about`,
+            '```',
+            '',
+            'This creates:',
+            '',
+            '- `src/pages/about/index.ts`',
+            '- `src/pages/about/lazy.ts`',
+            '- `src/pages/about/page.tsx`',
+            '',
+            'If the standard router files are still present, the generator also updates:',
+            '',
+            '- `src/app/providers/router/types/index.ts`',
+            '- `src/app/providers/router/model/config/index.ts`',
+            '- `src/app/providers/router/model/router/index.tsx`',
+        ].join('\n'));
+    }
+
+    if (selectedFeatureIds.includes('prerender')) {
+        sections.push([
+            '## Prerender',
+            '',
+            'When `Prerender` is enabled, production build runs a postbuild Puppeteer prerender step.',
+            '',
+            'Configured routes live in:',
+            '',
+            '- `prerender.routes.mjs`',
+            '- `scripts/prerender.mjs`',
+            '',
+            'Example route config:',
+            '',
+            '```js',
+            'export default async function getPrerenderRoutes() {',
+            '    return [',
+            "        '/',",
+            "        '/about',",
+            '    ];',
+            '}',
+            '```',
+            '',
+            'Useful commands:',
+            '',
+            '```bash',
+            `${getRunScriptCommand(packageManager, 'build:assets')}`,
+            `${getRunScriptCommand(packageManager, 'prerender')}`,
+            `${getRunScriptCommand(packageManager, 'build')}`,
+            '```',
+            '',
+            'If `React Router DOM` page generator is also enabled, new pages are additionally appended to `prerender.routes.mjs` automatically when that file exists.',
+        ].join('\n'));
+    }
+
+    return sections.join('\n\n');
+}
+
+export async function renderProjectReadme({
+    projectPath,
+    projectName,
+    selectedFeatureIds,
+    packageManager,
+    shouldInstallDependencies,
+}) {
+    const packageJson = await readPackageJson(projectPath);
+    const featureSpecificSections = formatFeatureSpecificSections({
+        selectedFeatureIds,
+        packageManager,
+    });
+
+    const readmeContent = [
+        `# ${projectName}`,
+        '',
+        'Created with `create-alistt69-kit`.',
+        '',
+        '## Overview',
+        '',
+        'Starter project based on React + TypeScript + Webpack with optional tooling selected during scaffolding.',
+        '',
+        '## Included by default',
+        '',
+        formatDefaultTooling(),
+        '',
+        '## Selected optional features',
+        '',
+        formatFeatureList(selectedFeatureIds),
+        '',
+        '## Quick start',
+        '',
+        formatQuickStart({
+            projectName,
+            packageManager,
+            shouldInstallDependencies,
+        }),
+        '',
+        '## Project structure',
+        '',
+        formatProjectStructure(selectedFeatureIds),
+        '',
+        '## Available scripts',
+        '',
+        formatScripts(packageManager, packageJson.scripts ?? {}),
+        ...(featureSpecificSections ? ['', featureSpecificSections] : []),
+    ].join('\n');
+
+    await writeFile(
+        resolve(projectPath, 'README.md'),
+        `${readmeContent}\n`,
+        'utf8',
+    );
 }

package/src/core/replace-tokens.js

@@ -1,46 +1,46 @@
-import { readFile, readdir, stat, writeFile } from 'node:fs/promises';
-import { resolve } from 'node:path';
-
-const replaceTokensInFile = async (filePath, tokens) => {
-    const fileContent = await readFile(filePath, 'utf8');
-
-    let updatedContent = fileContent;
-
-    for (const [token, value] of Object.entries(tokens)) {
-        updatedContent = updatedContent.replaceAll(token, value);
-    }
-
-    await writeFile(filePath, updatedContent, 'utf8');
-};
-
-const replaceTokensRecursively = async (targetPath, tokens) => {
-    const targetStat = await stat(targetPath);
-
-    if (targetStat.isFile()) {
-        await replaceTokensInFile(targetPath, tokens);
-        return;
-    }
-
-    if (!targetStat.isDirectory()) {
-        return;
-    }
-
-    const entries = await readdir(targetPath, { withFileTypes: true });
-
-    for (const entry of entries) {
-        const entryPath = resolve(targetPath, entry.name);
-
-        if (entry.isDirectory()) {
-            await replaceTokensRecursively(entryPath, tokens);
-            continue;
-        }
-
-        if (entry.isFile()) {
-            await replaceTokensInFile(entryPath, tokens);
-        }
-    }
-};
-
-export async function replaceTokens(targetDirPath, tokens) {
-    await replaceTokensRecursively(targetDirPath, tokens);
+import { readFile, readdir, stat, writeFile } from 'node:fs/promises';
+import { resolve } from 'node:path';
+
+const replaceTokensInFile = async (filePath, tokens) => {
+    const fileContent = await readFile(filePath, 'utf8');
+
+    let updatedContent = fileContent;
+
+    for (const [token, value] of Object.entries(tokens)) {
+        updatedContent = updatedContent.replaceAll(token, value);
+    }
+
+    await writeFile(filePath, updatedContent, 'utf8');
+};
+
+const replaceTokensRecursively = async (targetPath, tokens) => {
+    const targetStat = await stat(targetPath);
+
+    if (targetStat.isFile()) {
+        await replaceTokensInFile(targetPath, tokens);
+        return;
+    }
+
+    if (!targetStat.isDirectory()) {
+        return;
+    }
+
+    const entries = await readdir(targetPath, { withFileTypes: true });
+
+    for (const entry of entries) {
+        const entryPath = resolve(targetPath, entry.name);
+
+        if (entry.isDirectory()) {
+            await replaceTokensRecursively(entryPath, tokens);
+            continue;
+        }
+
+        if (entry.isFile()) {
+            await replaceTokensInFile(entryPath, tokens);
+        }
+    }
+};
+
+export async function replaceTokens(targetDirPath, tokens) {
+    await replaceTokensRecursively(targetDirPath, tokens);
 }