npm - @rtorcato/js-tooling - Versions diffs - 2.5.1 → 2.7.0 - Mend

@rtorcato/js-tooling 2.5.1 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/cli/commands/setup-presets.js +193 -0
package/dist/cli/commands/setup.js +46 -6
package/dist/cli/index.js +148 -30
package/package.json +18 -11
package/tooling/vitest/jsdom-shims.d.mts +1 -0
package/tooling/vitest/jsdom-shims.mjs +58 -0

package/dist/cli/commands/setup-presets.js ADDED Viewed

@@ -0,0 +1,193 @@
+export const PRESET_NAMES = [
+    'library',
+    'web-app',
+    'node-api',
+    'nextjs-app',
+    'react-app',
+];
+const BASE = {
+    linting: { tool: 'biome' },
+    formatting: { tool: 'biome' },
+    testing: { framework: 'vitest', environment: 'node' },
+    gitHooks: true,
+    commitLint: true,
+    semanticRelease: false,
+    securityAutomation: true,
+};
+export function buildPresetConfig(name, projectName) {
+    switch (name) {
+        case 'library':
+            return {
+                ...BASE,
+                projectName,
+                projectType: 'library',
+                typescript: { enabled: true, config: 'base' },
+                semanticRelease: true,
+                bundler: 'tsup',
+            };
+        case 'web-app':
+            return {
+                ...BASE,
+                projectName,
+                projectType: 'web-app',
+                typescript: { enabled: true, config: 'base' },
+                testing: { framework: 'vitest', environment: 'browser' },
+                bundler: 'vite',
+            };
+        case 'node-api':
+            return {
+                ...BASE,
+                projectName,
+                projectType: 'node-api',
+                typescript: { enabled: true, config: 'node' },
+                bundler: 'esbuild',
+            };
+        case 'nextjs-app':
+            return {
+                ...BASE,
+                projectName,
+                projectType: 'nextjs-app',
+                typescript: { enabled: true, config: 'next' },
+                linting: { tool: 'eslint', eslintConfig: 'nextjs' },
+                formatting: { tool: 'prettier' },
+                bundler: 'none',
+            };
+        case 'react-app':
+            return {
+                ...BASE,
+                projectName,
+                projectType: 'react-app',
+                typescript: { enabled: true, config: 'react' },
+                testing: { framework: 'vitest', environment: 'browser' },
+                bundler: 'vite',
+            };
+    }
+}
+export const CONFIG_SCHEMA = {
+    $schema: 'https://json-schema.org/draft/2020-12/schema',
+    $id: 'https://rtorcato.github.io/js-tooling/schemas/project-config.json',
+    title: 'ProjectConfig',
+    description: '@rtorcato/js-tooling setup configuration',
+    type: 'object',
+    additionalProperties: false,
+    required: [
+        'projectName',
+        'projectType',
+        'typescript',
+        'linting',
+        'formatting',
+        'testing',
+        'gitHooks',
+        'commitLint',
+        'semanticRelease',
+        'securityAutomation',
+        'bundler',
+    ],
+    properties: {
+        projectName: { type: 'string', minLength: 1 },
+        projectType: {
+            type: 'string',
+            enum: ['library', 'web-app', 'node-api', 'nextjs-app', 'react-app'],
+        },
+        typescript: {
+            type: 'object',
+            additionalProperties: false,
+            required: ['enabled', 'config'],
+            properties: {
+                enabled: { type: 'boolean' },
+                config: { type: 'string', enum: ['base', 'react', 'next', 'node', 'express'] },
+            },
+        },
+        linting: {
+            type: 'object',
+            additionalProperties: false,
+            required: ['tool'],
+            properties: {
+                tool: { type: 'string', enum: ['biome', 'eslint', 'both', 'none'] },
+                eslintConfig: { type: 'string', enum: ['base', 'nextjs'] },
+            },
+        },
+        formatting: {
+            type: 'object',
+            additionalProperties: false,
+            required: ['tool'],
+            properties: { tool: { type: 'string', enum: ['biome', 'prettier', 'none'] } },
+        },
+        testing: {
+            type: 'object',
+            additionalProperties: false,
+            required: ['framework'],
+            properties: {
+                framework: { type: 'string', enum: ['vitest', 'jest', 'playwright', 'none'] },
+                environment: { type: 'string', enum: ['node', 'browser', 'both'] },
+            },
+        },
+        gitHooks: { type: 'boolean' },
+        commitLint: { type: 'boolean' },
+        semanticRelease: { type: 'boolean' },
+        securityAutomation: { type: 'boolean' },
+        bundler: { type: 'string', enum: ['tsup', 'esbuild', 'vite', 'none'] },
+    },
+};
+const ALLOWED_KEYS = new Set(CONFIG_SCHEMA.required);
+export function validateProjectConfig(input) {
+    const errors = [];
+    if (typeof input !== 'object' || input === null || Array.isArray(input)) {
+        return { valid: false, errors: ['Config must be a JSON object'] };
+    }
+    const obj = input;
+    for (const key of Object.keys(obj)) {
+        if (!ALLOWED_KEYS.has(key))
+            errors.push(`Unknown field: ${key}`);
+    }
+    for (const required of CONFIG_SCHEMA.required) {
+        if (!(required in obj))
+            errors.push(`Missing required field: ${required}`);
+    }
+    return { valid: errors.length === 0, errors };
+}
+export function computeFileList(config) {
+    const files = ['package.json'];
+    files.push('.editorconfig', '.nvmrc', 'knip.json');
+    if (config.typescript.enabled) {
+        files.push('tsconfig.json', 'reset.d.ts');
+    }
+    if (config.linting.tool === 'biome' || config.linting.tool === 'both') {
+        files.push('biome.jsonc');
+    }
+    if (config.linting.tool === 'eslint' || config.linting.tool === 'both') {
+        files.push('eslint.config.mjs');
+    }
+    if (config.linting.tool === 'eslint') {
+        files.push('prettier.config.mjs');
+    }
+    if (config.testing.framework === 'vitest') {
+        files.push('vitest.config.ts', 'vitest.setup.ts');
+    }
+    if (config.testing.framework === 'jest') {
+        files.push('jest.config.mjs');
+    }
+    if (config.testing.framework === 'playwright') {
+        files.push('playwright.config.ts');
+    }
+    if (config.gitHooks) {
+        files.push('.husky/pre-commit', '.gitignore');
+    }
+    if (config.commitLint) {
+        files.push('.husky/commit-msg', 'commitlint.config.mjs');
+    }
+    files.push('.github/workflows/ci.yml');
+    if (config.securityAutomation) {
+        files.push('.github/dependabot.yml', '.github/workflows/codeql.yml');
+    }
+    if (config.bundler === 'tsup')
+        files.push('tsup.config.ts');
+    else if (config.bundler === 'esbuild')
+        files.push('build.mjs');
+    else if (config.bundler === 'vite')
+        files.push('vite.config.ts');
+    if (config.semanticRelease)
+        files.push('release.config.mjs');
+    files.push('README.md');
+    return files;
+}

package/dist/cli/commands/setup.js CHANGED Viewed

@@ -1,17 +1,58 @@
+import path from 'node:path';
 import chalk from 'chalk';
 import fs from 'fs-extra';
 import inquirer from 'inquirer';
-import path from 'node:path';
 import { generateConfigs } from '../generators/index.js';
 import { installDependencies } from '../utils/install.js';
+import { buildPresetConfig, computeFileList, CONFIG_SCHEMA, PRESET_NAMES, validateProjectConfig, } from './setup-presets.js';
+async function resolveConfig(options) {
+    if (options.config && options.preset) {
+        console.warn(chalk.yellow('⚠️  Both --config and --preset given; --config wins.\n'));
+    }
+    if (options.config) {
+        const configPath = path.resolve(options.config);
+        if (!(await fs.pathExists(configPath))) {
+            throw new Error(`Config file not found: ${configPath}`);
+        }
+        const raw = await fs.readJson(configPath);
+        const { valid, errors } = validateProjectConfig(raw);
+        if (!valid) {
+            throw new Error(`Invalid config:\n  - ${errors.join('\n  - ')}`);
+        }
+        return raw;
+    }
+    if (options.preset) {
+        if (!PRESET_NAMES.includes(options.preset)) {
+            throw new Error(`Unknown preset: ${options.preset}. Available: ${PRESET_NAMES.join(', ')}`);
+        }
+        const projectName = path.basename(path.resolve(options.directory));
+        return buildPresetConfig(options.preset, projectName);
+    }
+    return promptForConfig();
+}
 export async function setupProject(options) {
+    if (options.configSchema) {
+        console.log(JSON.stringify(CONFIG_SCHEMA, null, 2));
+        return;
+    }
     const targetDir = path.resolve(options.directory);
-    console.log(chalk.cyan('\n🛠️  Welcome to JS Tooling Setup!\n'));
-    console.log(chalk.gray(`Setting up tooling in: ${targetDir}\n`));
+    const interactive = !options.config && !options.preset;
+    const dryRun = options.dryRun === true;
+    if (interactive && !dryRun) {
+        console.log(chalk.cyan('\n🛠️  Welcome to JS Tooling Setup!\n'));
+        console.log(chalk.gray(`Setting up tooling in: ${targetDir}\n`));
+    }
     try {
-        // Check if directory exists and is writable
         await fs.ensureDir(targetDir);
-        const config = await promptForConfig();
+        const config = await resolveConfig(options);
+        if (dryRun) {
+            const files = computeFileList(config);
+            console.log(JSON.stringify({ directory: targetDir, config, files }, null, 2));
+            return;
+        }
+        if (!interactive) {
+            console.log(chalk.cyan(`\n🛠️  Scaffolding ${config.projectType} in ${targetDir}\n`));
+        }
         console.log(chalk.cyan('\n📝 Generating configuration files...\n'));
         await generateConfigs(config, targetDir);
         if (!options.skipInstall) {
@@ -19,7 +60,6 @@ export async function setupProject(options) {
             await installDependencies(config, targetDir);
         }
         console.log(chalk.green('\n✅ Setup completed successfully!\n'));
-        // Show next steps
         showNextSteps(config, targetDir);
     }
     catch (error) {

package/dist/cli/index.js CHANGED Viewed

@@ -28,6 +28,10 @@ program
     .description('🚀 Setup tooling for a new or existing project')
     .option('-d, --directory <path>', 'Target directory for setup', process.cwd())
     .option('--skip-install', 'Skip installing dependencies')
+    .option('--preset <name>', 'Skip prompts; use defaults for a project type')
+    .option('--config <path>', 'Skip prompts; read a JSON ProjectConfig from <path>')
+    .option('--dry-run', 'Print the resolved config and file list, write nothing')
+    .option('--config-schema', 'Print the JSON Schema for ProjectConfig and exit')
     .action(setupProject);
 program
     .command('copy <config>')
@@ -52,41 +56,155 @@ program
         console.error(chalk.red(`\n❌ Error copying configuration: ${error}\n`));
     }
 });
+const TOOL_CATALOG = [
+    {
+        name: 'TypeScript',
+        description: 'Base, React, Next.js, Node.js, Express tsconfig presets',
+        exports: [
+            '@rtorcato/js-tooling/typescript/base',
+            '@rtorcato/js-tooling/typescript/react',
+            '@rtorcato/js-tooling/typescript/next',
+            '@rtorcato/js-tooling/typescript/node',
+            '@rtorcato/js-tooling/typescript/express',
+            '@rtorcato/js-tooling/typescript/test',
+            '@rtorcato/js-tooling/typescript/reset',
+        ],
+        fixTarget: 'tsconfig',
+    },
+    {
+        name: 'ESLint',
+        description: 'Base and Next.js ESLint configurations',
+        exports: ['@rtorcato/js-tooling/eslint/base', '@rtorcato/js-tooling/eslint/nextjs'],
+        fixTarget: 'eslint',
+    },
+    {
+        name: 'Biome',
+        description: 'Fast formatter and linter configuration',
+        exports: ['@rtorcato/js-tooling/biome'],
+        fixTarget: 'biome',
+    },
+    {
+        name: 'Prettier',
+        description: 'Code formatter configuration',
+        exports: ['@rtorcato/js-tooling/prettier'],
+        fixTarget: 'prettier',
+    },
+    {
+        name: 'Vitest',
+        description: 'Testing framework configuration',
+        exports: [
+            '@rtorcato/js-tooling/vitest/config',
+            '@rtorcato/js-tooling/vitest/react',
+            '@rtorcato/js-tooling/vitest/setup',
+        ],
+        fixTarget: 'vitest',
+    },
+    {
+        name: 'Jest',
+        description: 'Testing framework presets for browser and Node.js',
+        exports: [
+            '@rtorcato/js-tooling/jest-presets/browser/jest-preset',
+            '@rtorcato/js-tooling/jest-presets/node/jest-preset',
+        ],
+        fixTarget: null,
+    },
+    {
+        name: 'Playwright',
+        description: 'End-to-end testing configuration',
+        exports: ['@rtorcato/js-tooling/playwright'],
+        fixTarget: null,
+    },
+    {
+        name: 'Commitlint',
+        description: 'Conventional commit linting',
+        exports: ['@rtorcato/js-tooling/commitlint/config'],
+        fixTarget: 'commitlint',
+    },
+    {
+        name: 'Husky',
+        description: 'Git hooks for pre-commit validation',
+        exports: [],
+        fixTarget: 'husky',
+    },
+    {
+        name: 'lint-staged',
+        description: 'Run linters on staged files (pairs with Husky)',
+        exports: [],
+        fixTarget: 'husky',
+    },
+    {
+        name: 'Semantic Release',
+        description: 'Automated versioning and publishing',
+        exports: [
+            '@rtorcato/js-tooling/semantic-release',
+            '@rtorcato/js-tooling/semantic-release/github',
+            '@rtorcato/js-tooling/semantic-release/docker',
+        ],
+        fixTarget: 'semantic-release',
+    },
+    {
+        name: 'tsup',
+        description: 'TypeScript bundler configuration',
+        exports: ['@rtorcato/js-tooling/tsup'],
+        fixTarget: null,
+    },
+    {
+        name: 'esbuild',
+        description: 'Fast JavaScript bundler configuration',
+        exports: ['@rtorcato/js-tooling/esbuild'],
+        fixTarget: null,
+    },
+    {
+        name: 'Vite',
+        description: 'Modern web app build tool configuration',
+        exports: ['@rtorcato/js-tooling/vite'],
+        fixTarget: null,
+    },
+    {
+        name: 'EditorConfig',
+        description: 'Cross-editor formatting consistency (.editorconfig)',
+        exports: [],
+        fixTarget: 'editorconfig',
+    },
+    {
+        name: '.nvmrc',
+        description: 'Pin Node version per repository',
+        exports: [],
+        fixTarget: 'nvmrc',
+    },
+    {
+        name: 'knip',
+        description: 'Find unused files, exports, and dependencies',
+        exports: [],
+        fixTarget: 'knip',
+    },
+    {
+        name: 'Dependabot',
+        description: 'Weekly automated dependency updates',
+        exports: [],
+        fixTarget: 'dependabot',
+    },
+    {
+        name: 'CodeQL',
+        description: 'GitHub security scanning workflow',
+        exports: [],
+        fixTarget: 'codeql',
+    },
+];
 program
     .command('list')
     .alias('ls')
     .description('📋 List all available tooling configurations')
-    .action(() => {
+    .option('--json', 'Emit machine-readable JSON output')
+    .action((options) => {
+    if (options.json) {
+        console.log(JSON.stringify({ tools: TOOL_CATALOG }, null, 2));
+        return;
+    }
     console.log(chalk.cyan('\n🛠️  Available tooling configurations:\n'));
-    const configs = [
-        {
-            name: 'TypeScript',
-            desc: 'Base, React, Next.js, Node.js, Express configurations',
-        },
-        { name: 'ESLint', desc: 'Base and Next.js ESLint configurations' },
-        { name: 'Biome', desc: 'Fast formatter and linter configuration' },
-        { name: 'Prettier', desc: 'Code formatter configuration' },
-        { name: 'Vitest', desc: 'Testing framework configuration' },
-        {
-            name: 'Jest',
-            desc: 'Testing framework presets for browser and Node.js',
-        },
-        { name: 'Playwright', desc: 'End-to-end testing configuration' },
-        { name: 'Commitlint', desc: 'Conventional commit linting' },
-        { name: 'Husky', desc: 'Git hooks for pre-commit validation' },
-        { name: 'lint-staged', desc: 'Run linters on staged files (pairs with Husky)' },
-        { name: 'Semantic Release', desc: 'Automated versioning and publishing' },
-        { name: 'tsup', desc: 'TypeScript bundler configuration' },
-        { name: 'esbuild', desc: 'Fast JavaScript bundler configuration' },
-        { name: 'EditorConfig', desc: 'Cross-editor formatting consistency (.editorconfig)' },
-        { name: '.nvmrc', desc: 'Pin Node version per repository' },
-        { name: 'knip', desc: 'Find unused files, exports, and dependencies' },
-        { name: 'Dependabot', desc: 'Weekly automated dependency updates' },
-        { name: 'CodeQL', desc: 'GitHub security scanning workflow' },
-    ];
-    configs.forEach(({ name, desc }) => {
-        console.log(`  ${chalk.green('●')} ${chalk.bold(name)}: ${chalk.gray(desc)}`);
-    });
+    for (const { name, description } of TOOL_CATALOG) {
+        console.log(`  ${chalk.green('●')} ${chalk.bold(name)}: ${chalk.gray(description)}`);
+    }
     console.log(chalk.dim('\n💡 Run `js-tooling setup` for a new project'));
     console.log(chalk.dim('   or `js-tooling fix` to apply missing pieces to an existing one\n'));
 });

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@rtorcato/js-tooling",
-	"version": "2.5.1",
+	"version": "2.7.0",
 	"description": "JavaScript and TypeScript tooling for Node.js, React, Next.js, and Vitest.",
 	"type": "module",
 	"keywords": [
@@ -61,6 +61,8 @@
 		"tooling/vitest/vitest.config.react.d.mts",
 		"tooling/vitest/vitest.setup.mjs",
 		"tooling/vitest/vitest.setup.d.mts",
+		"tooling/vitest/jsdom-shims.mjs",
+		"tooling/vitest/jsdom-shims.d.mts",
 		"tooling/tsup/index.ts",
 		"tooling/biome/biome.json",
 		"tooling/semantic-release/*.mjs",
@@ -123,6 +125,10 @@
 			"types": "./tooling/vitest/vitest.setup.d.mts",
 			"import": "./tooling/vitest/vitest.setup.mjs"
 		},
+		"./vitest/jsdom-shims": {
+			"types": "./tooling/vitest/jsdom-shims.d.mts",
+			"import": "./tooling/vitest/jsdom-shims.mjs"
+		},
 		"./tsup": "./tooling/tsup/index.ts",
 		"./biome": "./tooling/biome/biome.json",
 		"./semantic-release": {
@@ -146,20 +152,20 @@
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^2.3.0",
+		"@commitlint/cli": "^20.1.0",
+		"@commitlint/config-conventional": "^21.0.1",
 		"@commitlint/types": "^20.0.0",
 		"@eslint/js": "^9.38.0",
 		"@ianvs/prettier-plugin-sort-imports": "^4.4.2",
-		"@commitlint/cli": "^20.1.0",
-		"@commitlint/config-conventional": "^21.0.1",
 		"@next/eslint-plugin-next": "^16.0.0",
 		"@playwright/test": "^1.56.1",
 		"@semantic-release/changelog": "^6.0.3",
 		"@semantic-release/commit-analyzer": "^13.0.1",
 		"@semantic-release/exec": "^7.1.0",
 		"@semantic-release/git": "^10.0.1",
-		"@semantic-release/github": "^12.0.0",
-		"@semantic-release/npm": "^13.1.1",
-		"@semantic-release/release-notes-generator": "^14.1.0",
+		"@semantic-release/github": "^12.0.8",
+		"@semantic-release/npm": "^13.1.5",
+		"@semantic-release/release-notes-generator": "^14.1.1",
 		"@total-typescript/ts-reset": "0.6.1",
 		"@types/fs-extra": "^11.0.4",
 		"@types/node": "^25.9.1",
@@ -175,19 +181,20 @@
 		"eslint": "9.38.0",
 		"eslint-plugin-import": "^2.32.0",
 		"eslint-plugin-jest": "29.0.1",
-		"jest": "^29.7.0",
 		"husky": "^9.1.7",
 		"is-ci": "^4.1.0",
+		"jest": "^29.7.0",
+		"jsdom": "^26.1.0",
+		"knip": "^5.61.3",
 		"lint-staged": "^16.2.6",
 		"prettier": "^3.6.2",
 		"rimraf": "6.0.1",
-		"semantic-release": "^25.0.1",
+		"semantic-release": "^25.0.3",
 		"ts-jest": "^29.4.5",
 		"tsup": "8.5.1",
 		"typescript": "^5.9.3",
 		"typescript-eslint": "^8.60.0",
-		"vitest": "4.0.3",
-		"knip": "^5.61.3"
+		"vitest": "4.0.3"
 	},
 	"peerDependencies": {
 		"@biomejs/biome": "^2.0.0",
@@ -201,7 +208,7 @@
 		"@semantic-release/commit-analyzer": "^13.0.0",
 		"@semantic-release/exec": "^7.0.0",
 		"@semantic-release/git": "^10.0.0",
-		"@semantic-release/github": "^12.0.0",
+		"@semantic-release/github": "^12.0.8",
 		"@semantic-release/npm": "^13.0.0",
 		"@semantic-release/release-notes-generator": "^14.0.0",
 		"@total-typescript/ts-reset": "^0.6.0",

package/tooling/vitest/jsdom-shims.d.mts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {}

package/tooling/vitest/jsdom-shims.mjs ADDED Viewed

@@ -0,0 +1,58 @@
+// jsdom doesn't ship the browser APIs that Radix UI, cmdk, embla-carousel,
+// react-day-picker and friends call at mount time. Import this file from your
+// vitest setupFiles to install no-op polyfills for all of them:
+//
+//   // vitest.config.ts -> test.setupFiles
+//   import '@rtorcato/js-tooling/vitest/jsdom-shims'
+//
+// Side-effect only; nothing is exported.
+if (typeof Element !== 'undefined') {
+	if (!Element.prototype.hasPointerCapture) {
+		Element.prototype.hasPointerCapture = () => false
+	}
+	if (!Element.prototype.setPointerCapture) {
+		Element.prototype.setPointerCapture = () => {}
+	}
+	if (!Element.prototype.releasePointerCapture) {
+		Element.prototype.releasePointerCapture = () => {}
+	}
+	if (!Element.prototype.scrollIntoView) {
+		Element.prototype.scrollIntoView = () => {}
+	}
+}
+if (typeof globalThis.ResizeObserver === 'undefined') {
+	globalThis.ResizeObserver = class ResizeObserver {
+		observe() {}
+		unobserve() {}
+		disconnect() {}
+	}
+}
+if (typeof globalThis.IntersectionObserver === 'undefined') {
+	globalThis.IntersectionObserver = class IntersectionObserver {
+		observe() {}
+		unobserve() {}
+		disconnect() {}
+		takeRecords() {
+			return []
+		}
+		root = null
+		rootMargin = ''
+		thresholds = []
+	}
+}
+if (typeof window !== 'undefined' && typeof window.matchMedia === 'undefined') {
+	window.matchMedia = (query) => ({
+		matches: false,
+		media: query,
+		onchange: null,
+		addListener: () => {},
+		removeListener: () => {},
+		addEventListener: () => {},
+		removeEventListener: () => {},
+		dispatchEvent: () => false,
+	})
+}