vyriy 0.8.1 → 0.8.2

package/README.md

@@ -1,5 +1,9 @@
 # vyriy
 
+Part of [Vyriy](https://vyriy.dev) - a calm architecture toolkit for TypeScript, React, SSR, SSG, APIs, and cloud-ready apps.
+
+Full documentation: https://vyriy.dev/docs/vyriy/
+
 Interactive project master for Vyriy projects.
 
 ## Purpose
@@ -30,6 +34,7 @@ vyriy create .         Initialise a new Vyriy project in the current directory
 vyriy dist             Prepare dist package metadata without publishing to npm
 vyriy static [dir]     Serve a static directory (defaults to .)
 vyriy check            Check local environment (Node.js and Yarn versions)
+vyriy config [tool]    Generate thin local config files
 vyriy --help, -h       Show help
 vyriy --version, -v    Show version
 ```
@@ -77,6 +82,46 @@ vyriy check --help
 vyriy check --version
 ```
 
+### `config`
+
+Vyriy can generate thin local config files that connect your project to Vyriy
+standards.
+
+```bash
+vyriy config init
+```
+
+Or configure tools one by one:
+
+```bash
+vyriy config typescript
+vyriy config eslint
+vyriy config prettier
+vyriy config jest
+vyriy config storybook
+vyriy config stylelint
+```
+
+Generated files stay intentionally small. For TypeScript, Vyriy writes a local
+`tsconfig.json` that extends `@vyriy/typescript-config` and includes common
+project paths such as `.storybook`, `packages`, `workspaces`, and root
+TypeScript files.
+
+Existing files are skipped by default:
+
+```bash
+vyriy config typescript --force
+vyriy config init --dry-run
+```
+
+The command does not install dependencies. If required Vyriy config packages are
+missing from `package.json`, it prints a suggested install command:
+
+```bash
+yarn add -D @vyriy/typescript-config @vyriy/eslint-config
+npm install --save-dev @vyriy/typescript-config @vyriy/eslint-config
+```
+
 ### `dist`
 
 Prepares every package inside the `dist/` directory for npm publishing:

package/args.js

@@ -1,6 +1,10 @@
 export const parseArgs = (args) => {
     const [command = '', ...commandArgs] = args;
-    if (command === 'check' || command === 'create' || command === 'dist' || command === 'static') {
+    if (command === 'check' ||
+        command === 'config' ||
+        command === 'create' ||
+        command === 'dist' ||
+        command === 'static') {
         return { type: command, args: commandArgs };
     }
     if (args.includes('--help') || args.includes('-h')) {

package/cli.js

@@ -8,6 +8,7 @@ Usage:
   vyriy dist             Prepare dist package metadata without publishing to npm
   vyriy static [dir]     Serve a static directory (defaults to .)
   vyriy check            Check local environment
+  vyriy config [tool]    Generate thin local config files
   vyriy --help, -h       Show help
   vyriy --version, -v    Show version
 
@@ -26,6 +27,17 @@ Static options:
   vyriy static dist --spa                   Enable SPA fallback mode
   vyriy static dist --fallback index.html   SPA fallback file
 
+Config options:
+  vyriy config init                 Select configs to create
+  vyriy config typescript           Create tsconfig.json
+  vyriy config eslint               Create eslint.config.js
+  vyriy config prettier             Create prettier.config.js
+  vyriy config jest                 Create jest.config.js
+  vyriy config storybook            Create .storybook config files
+  vyriy config stylelint            Create stylelint.config.js
+  vyriy config init --force         Overwrite existing config files
+  vyriy config init --dry-run       Print config files without writing them
+
 Examples:
   vyriy create app
   vyriy create app --dry-run
@@ -37,7 +49,9 @@ Examples:
   vyriy static dist --cache static
   vyriy static dist --spa --fallback index.html --cache static
   vyriy static dist
-  vyriy check`;
+  vyriy check
+  vyriy config init
+  vyriy config typescript`;
 export const cli = async (args = []) => {
     const command = parseArgs(args);
     switch (command.type) {
@@ -69,6 +83,11 @@ export const cli = async (args = []) => {
             await runCreateCli(command.args, 'vyriy create', false);
             break;
         }
+        case 'config': {
+            const { runConfigCli } = await import('./config-cli.js');
+            await runConfigCli(command.args);
+            break;
+        }
         default:
             console.error(`Unknown command: ${command.command}\n`);
             console.log(text);

package/config-cli.d.ts

@@ -0,0 +1 @@
+export declare const runConfigCli: (args?: readonly string[], cwd?: string) => Promise<void>;

package/config-cli.js

@@ -0,0 +1,69 @@
+import { configTargets } from './config-targets.js';
+import { fileExists } from './file-exists.js';
+import { findMissingPackages } from './package-dependencies.js';
+import { parseConfigArgs } from './parse-config-args.js';
+import { selectConfigs } from './select-configs.js';
+import { writeConfigFiles } from './write-config-files.js';
+const helpText = `Usage:
+  vyriy config init
+  vyriy config typescript
+  vyriy config eslint
+  vyriy config prettier
+  vyriy config jest
+  vyriy config storybook
+  vyriy config stylelint
+
+Options:
+  --force    Overwrite existing config files
+  --dry-run  Print files that would be created without writing them
+  --help     Show config help`;
+const unique = (values) => [...new Set(values)];
+const collectFiles = (names) => {
+    return names.flatMap((name) => [...configTargets[name].files]);
+};
+const printMissingPackages = (missingPackages) => {
+    if (missingPackages.length === 0) {
+        return;
+    }
+    console.log('');
+    console.log('Missing Vyriy config packages:');
+    console.log('');
+    for (const packageName of missingPackages) {
+        console.log(`- ${packageName}`);
+    }
+    console.log('');
+    console.log('Install them with:');
+    console.log('');
+    console.log(`yarn add -D ${missingPackages.join(' ')}`);
+};
+export const runConfigCli = async (args = [], cwd = process.cwd()) => {
+    const command = parseConfigArgs(args);
+    if (command.help) {
+        console.log(helpText);
+        process.exitCode = 0;
+        return;
+    }
+    if (command.type === 'unknown') {
+        console.error('Unknown config command.');
+        console.log(helpText);
+        process.exitCode = 1;
+        return;
+    }
+    const names = command.type === 'init' ? await selectConfigs() : command.names;
+    const files = collectFiles(names);
+    const writtenFiles = await writeConfigFiles({
+        cwd,
+        dryRun: command.dryRun,
+        exists: fileExists,
+        files,
+        force: command.force,
+    });
+    if (command.dryRun || writtenFiles.length === 0) {
+        process.exitCode = 0;
+        return;
+    }
+    const packageNames = unique(names.map((name) => configTargets[name].packageName));
+    const missingPackages = await findMissingPackages(cwd, packageNames);
+    printMissingPackages(missingPackages);
+    process.exitCode = 0;
+};

package/config-targets.d.ts

@@ -0,0 +1,4 @@
+import type { ConfigName, ConfigTarget } from './types.js';
+export declare const configTargets: Record<ConfigName, ConfigTarget>;
+export declare const defaultConfigNames: readonly ConfigName[];
+export declare const allConfigNames: ConfigName[];

package/config-targets.js

@@ -0,0 +1,82 @@
+const typescriptContent = `${JSON.stringify({
+    extends: '@vyriy/typescript-config/index.json',
+    include: [
+        '.storybook/**/*.ts',
+        '.storybook/**/*.tsx',
+        'packages/**/*.ts',
+        'packages/**/*.tsx',
+        'workspaces/**/*.ts',
+        'workspaces/**/*.tsx',
+        '*.ts',
+        '*.tsx',
+    ],
+}, null, 2)}
+`;
+const eslintContent = `import config from '@vyriy/eslint-config';
+
+export default config;
+`;
+const prettierContent = `export { default } from '@vyriy/prettier-config';
+`;
+const jestContent = `export { default } from '@vyriy/jest-config';
+`;
+const stylelintContent = `export { default } from '@vyriy/stylelint-config';
+`;
+const storybookMainContent = `import config from '@vyriy/storybook-config';
+
+import type { StorybookConfig } from '@vyriy/storybook-config';
+
+const main: StorybookConfig = {
+  ...config,
+  stories: [
+    '../**/*.mdx',
+    '../**/*.stories.@(js|jsx|mjs|ts|tsx)',
+  ],
+};
+
+export default main;
+`;
+const storybookPreviewContent = `export { default } from '@vyriy/storybook-config/preview.js';
+`;
+export const configTargets = {
+    eslint: {
+        name: 'eslint',
+        packageName: '@vyriy/eslint-config',
+        files: [{ path: 'eslint.config.js', content: eslintContent }],
+    },
+    jest: {
+        name: 'jest',
+        packageName: '@vyriy/jest-config',
+        files: [{ path: 'jest.config.js', content: jestContent }],
+    },
+    prettier: {
+        name: 'prettier',
+        packageName: '@vyriy/prettier-config',
+        files: [{ path: 'prettier.config.js', content: prettierContent }],
+    },
+    storybook: {
+        name: 'storybook',
+        packageName: '@vyriy/storybook-config',
+        files: [
+            { path: '.storybook/main.ts', content: storybookMainContent },
+            { path: '.storybook/preview.ts', content: storybookPreviewContent },
+        ],
+    },
+    stylelint: {
+        name: 'stylelint',
+        packageName: '@vyriy/stylelint-config',
+        files: [{ path: 'stylelint.config.js', content: stylelintContent }],
+    },
+    typescript: {
+        name: 'typescript',
+        packageName: '@vyriy/typescript-config',
+        files: [{ path: 'tsconfig.json', content: typescriptContent }],
+    },
+};
+export const defaultConfigNames = [
+    'typescript',
+    'eslint',
+    'prettier',
+    'jest',
+];
+export const allConfigNames = Object.keys(configTargets);

package/file-exists.d.ts

@@ -0,0 +1 @@
+export declare const fileExists: (path: string) => Promise<boolean>;

package/file-exists.js

@@ -0,0 +1,13 @@
+import { access } from 'node:fs/promises';
+export const fileExists = async (path) => {
+    try {
+        await access(path);
+        return true;
+    }
+    catch (error) {
+        if (error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT') {
+            return false;
+        }
+        throw error;
+    }
+};

package/index.d.ts

@@ -1,3 +1,6 @@
 export * from './args.js';
 export * from './cli.js';
+export * from './config-cli.js';
+export * from './config-targets.js';
+export * from './parse-config-args.js';
 export type * from './types.js';

package/index.js

@@ -1,2 +1,5 @@
 export * from './args.js';
 export * from './cli.js';
+export * from './config-cli.js';
+export * from './config-targets.js';
+export * from './parse-config-args.js';

package/package-dependencies.d.ts

@@ -0,0 +1 @@
+export declare const findMissingPackages: (cwd: string, packageNames: readonly string[]) => Promise<string[]>;

package/package-dependencies.js

@@ -0,0 +1,28 @@
+import { readFile } from 'node:fs/promises';
+import { join } from 'node:path';
+const dependencyFields = [
+    'dependencies',
+    'devDependencies',
+    'peerDependencies',
+    'optionalDependencies',
+];
+const readPackageJson = async (cwd) => {
+    try {
+        return JSON.parse(await readFile(join(cwd, 'package.json'), 'utf8'));
+    }
+    catch (error) {
+        if (error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT') {
+            return undefined;
+        }
+        throw error;
+    }
+};
+export const findMissingPackages = async (cwd, packageNames) => {
+    const packageJson = await readPackageJson(cwd);
+    if (!packageJson) {
+        return [...packageNames];
+    }
+    return packageNames.filter((packageName) => {
+        return !dependencyFields.some((field) => Boolean(packageJson[field]?.[packageName]));
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vyriy",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "Interactive project master for calm cloud-ready applications.",
   "homepage": "https://vyriy.dev/docs/vyriy/",
   "type": "module",
@@ -10,10 +10,10 @@
   },
   "packageManager": "yarn@4.16.0",
   "dependencies": {
-    "@vyriy/check": "0.8.1",
-    "@vyriy/create": "0.8.1",
-    "@vyriy/dist": "0.8.1",
-    "@vyriy/static": "0.8.1"
+    "@vyriy/check": "0.8.2",
+    "@vyriy/create": "0.8.2",
+    "@vyriy/dist": "0.8.2",
+    "@vyriy/static": "0.8.2"
   },
   "peerDependencies": {
     "@testing-library/dom": "^10.4.1",
@@ -146,6 +146,36 @@
       "import": "./cli.js",
       "default": "./cli.js"
     },
+    "./config-cli": {
+      "types": "./config-cli.d.ts",
+      "import": "./config-cli.js",
+      "default": "./config-cli.js"
+    },
+    "./config-cli.js": {
+      "types": "./config-cli.d.ts",
+      "import": "./config-cli.js",
+      "default": "./config-cli.js"
+    },
+    "./config-targets": {
+      "types": "./config-targets.d.ts",
+      "import": "./config-targets.js",
+      "default": "./config-targets.js"
+    },
+    "./config-targets.js": {
+      "types": "./config-targets.d.ts",
+      "import": "./config-targets.js",
+      "default": "./config-targets.js"
+    },
+    "./file-exists": {
+      "types": "./file-exists.d.ts",
+      "import": "./file-exists.js",
+      "default": "./file-exists.js"
+    },
+    "./file-exists.js": {
+      "types": "./file-exists.d.ts",
+      "import": "./file-exists.js",
+      "default": "./file-exists.js"
+    },
     "./index": {
       "types": "./index.d.ts",
       "import": "./index.js",
@@ -155,6 +185,46 @@
       "types": "./index.d.ts",
       "import": "./index.js",
       "default": "./index.js"
+    },
+    "./package-dependencies": {
+      "types": "./package-dependencies.d.ts",
+      "import": "./package-dependencies.js",
+      "default": "./package-dependencies.js"
+    },
+    "./package-dependencies.js": {
+      "types": "./package-dependencies.d.ts",
+      "import": "./package-dependencies.js",
+      "default": "./package-dependencies.js"
+    },
+    "./parse-config-args": {
+      "types": "./parse-config-args.d.ts",
+      "import": "./parse-config-args.js",
+      "default": "./parse-config-args.js"
+    },
+    "./parse-config-args.js": {
+      "types": "./parse-config-args.d.ts",
+      "import": "./parse-config-args.js",
+      "default": "./parse-config-args.js"
+    },
+    "./select-configs": {
+      "types": "./select-configs.d.ts",
+      "import": "./select-configs.js",
+      "default": "./select-configs.js"
+    },
+    "./select-configs.js": {
+      "types": "./select-configs.d.ts",
+      "import": "./select-configs.js",
+      "default": "./select-configs.js"
+    },
+    "./write-config-files": {
+      "types": "./write-config-files.d.ts",
+      "import": "./write-config-files.js",
+      "default": "./write-config-files.js"
+    },
+    "./write-config-files.js": {
+      "types": "./write-config-files.d.ts",
+      "import": "./write-config-files.js",
+      "default": "./write-config-files.js"
     }
   }
 }

package/parse-config-args.d.ts

@@ -0,0 +1,2 @@
+import type { ConfigCommand } from './types.js';
+export declare const parseConfigArgs: (args: readonly string[]) => ConfigCommand;

package/parse-config-args.js

@@ -0,0 +1,44 @@
+import { allConfigNames, defaultConfigNames } from './config-targets.js';
+const isConfigName = (value) => {
+    return allConfigNames.includes(value);
+};
+export const parseConfigArgs = (args) => {
+    const dryRun = args.includes('--dry-run');
+    const force = args.includes('--force');
+    const help = args.includes('--help') || args.includes('-h');
+    const type = args.find((arg) => !arg.startsWith('-')) ?? 'init';
+    if (help) {
+        return {
+            dryRun,
+            force,
+            help,
+            names: [],
+            type: 'init',
+        };
+    }
+    if (type === 'init') {
+        return {
+            dryRun,
+            force,
+            help,
+            names: defaultConfigNames,
+            type,
+        };
+    }
+    if (isConfigName(type)) {
+        return {
+            dryRun,
+            force,
+            help,
+            names: [type],
+            type,
+        };
+    }
+    return {
+        dryRun,
+        force,
+        help,
+        names: [],
+        type: 'unknown',
+    };
+};

package/select-configs.d.ts

@@ -0,0 +1,2 @@
+import type { ConfigName } from './types.js';
+export declare const selectConfigs: () => Promise<readonly ConfigName[]>;

package/select-configs.js

@@ -0,0 +1,50 @@
+import { createInterface } from 'node:readline/promises';
+import { allConfigNames, defaultConfigNames } from './config-targets.js';
+const labels = {
+    eslint: 'ESLint',
+    jest: 'Jest',
+    prettier: 'Prettier',
+    storybook: 'Storybook',
+    stylelint: 'Stylelint',
+    typescript: 'TypeScript',
+};
+const parseAnswer = (answer) => {
+    const selected = new Set();
+    for (const token of answer
+        .split(',')
+        .map((part) => part.trim().toLowerCase())
+        .filter(Boolean)) {
+        const index = Number(token);
+        const configName = allConfigNames[index - 1];
+        if (configName) {
+            selected.add(configName);
+            continue;
+        }
+        if (allConfigNames.includes(token)) {
+            selected.add(token);
+        }
+    }
+    return [...selected];
+};
+export const selectConfigs = async () => {
+    if (!process.stdin.isTTY || !process.stdout.isTTY) {
+        return defaultConfigNames;
+    }
+    console.log('Select configs to create. Press enter for defaults.');
+    allConfigNames.forEach((name, index) => {
+        const defaultMarker = defaultConfigNames.includes(name) ? ' default' : '';
+        console.log(`${index + 1}. ${labels[name]}${defaultMarker}`);
+    });
+    const readline = createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    try {
+        const answer = await readline.question('Configs: ');
+        const selected = parseAnswer(answer);
+        return selected.length > 0 ? selected : defaultConfigNames;
+    }
+    finally {
+        readline.close();
+    }
+};

package/types.d.ts

@@ -1,7 +1,7 @@
 export type Command = {
     readonly type: 'help' | 'version';
 } | {
-    readonly type: 'check' | 'create' | 'dist' | 'static';
+    readonly type: 'check' | 'config' | 'create' | 'dist' | 'static';
     readonly args: readonly string[];
 } | {
     readonly type: 'unknown';
@@ -9,3 +9,20 @@ export type Command = {
 };
 export type ParseArgs = (args: readonly string[]) => Command;
 export type Cli = (args?: readonly string[]) => Promise<void>;
+export type ConfigName = 'eslint' | 'jest' | 'prettier' | 'storybook' | 'stylelint' | 'typescript';
+export type ConfigCommand = {
+    readonly dryRun: boolean;
+    readonly force: boolean;
+    readonly help: boolean;
+    readonly names: readonly ConfigName[];
+    readonly type: 'init' | ConfigName | 'unknown';
+};
+export type ConfigFile = {
+    readonly path: string;
+    readonly content: string;
+};
+export type ConfigTarget = {
+    readonly files: readonly ConfigFile[];
+    readonly name: ConfigName;
+    readonly packageName: string;
+};

package/write-config-files.d.ts

@@ -0,0 +1,10 @@
+import type { ConfigFile } from './types.js';
+type WriteConfigFilesOptions = {
+    readonly cwd: string;
+    readonly dryRun: boolean;
+    readonly exists: (path: string) => Promise<boolean>;
+    readonly files: readonly ConfigFile[];
+    readonly force: boolean;
+};
+export declare const writeConfigFiles: ({ cwd, dryRun, exists, files, force, }: WriteConfigFilesOptions) => Promise<readonly ConfigFile[]>;
+export {};

package/write-config-files.js

@@ -0,0 +1,29 @@
+import { mkdir, writeFile } from 'node:fs/promises';
+import { dirname, join } from 'node:path';
+export const writeConfigFiles = async ({ cwd, dryRun, exists, files, force, }) => {
+    const writable = [];
+    for (const file of files) {
+        if (!force && (await exists(join(cwd, file.path)))) {
+            console.log(`Skipped ${file.path} because it already exists.`);
+            console.log('Use --force to overwrite it.');
+            continue;
+        }
+        writable.push(file);
+    }
+    if (dryRun) {
+        if (writable.length > 0) {
+            console.log('Would create:');
+            for (const file of writable) {
+                console.log(`- ${file.path}`);
+            }
+        }
+        return writable;
+    }
+    for (const file of writable) {
+        const path = join(cwd, file.path);
+        await mkdir(dirname(path), { recursive: true });
+        await writeFile(path, file.content, 'utf8');
+        console.log(`${force ? 'Wrote' : 'Created'} ${file.path}.`);
+    }
+    return writable;
+};