@rtorcato/js-tooling 2.0.0 → 2.1.0

package/README.md

@@ -67,6 +67,9 @@ npx @rtorcato/js-tooling copy tsconfig
 # List all available configurations
 npx @rtorcato/js-tooling list
 
+# Diagnose drift between your project and our presets
+npx @rtorcato/js-tooling doctor
+
 # Run commit message helper
 npx @rtorcato/js-tooling commitmessage
 
@@ -74,6 +77,18 @@ npx @rtorcato/js-tooling commitmessage
 npx @rtorcato/js-tooling helloworld
 ```
 
+### Doctor
+
+`doctor` audits an existing project against the presets and reports drift:
+
+```bash
+npx @rtorcato/js-tooling doctor              # current dir
+npx @rtorcato/js-tooling doctor -d ./app     # specific dir
+npx @rtorcato/js-tooling doctor --json       # machine-readable output
+```
+
+For each tracked config (TypeScript, Biome, ESLint, Prettier, Vitest, Commitlint, `package.json`) it reports `ok`, `drift`, `missing`, or `not configured`, and exits non-zero on `drift` or `missing` — handy as a CI check.
+
 ## Configuration Usage
 
 ### Biome (Formatter & Linter)

package/dist/cli/commands/doctor.js

@@ -0,0 +1,160 @@
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import path from 'node:path';
+const PACKAGE = '@rtorcato/js-tooling';
+const FILE_CHECKS = [
+    {
+        check: 'TypeScript',
+        candidates: ['tsconfig.json'],
+        expected: `extends "${PACKAGE}/typescript/*"`,
+        matcher: /@rtorcato\/js-tooling\/typescript\//,
+        hint: 'Set `"extends": "@rtorcato/js-tooling/typescript/base"` in tsconfig.json',
+    },
+    {
+        check: 'Biome',
+        candidates: ['biome.json', 'biome.jsonc'],
+        expected: `extends "${PACKAGE}/biome"`,
+        matcher: /@rtorcato\/js-tooling\/biome/,
+        optional: true,
+        hint: 'Run `npx @rtorcato/js-tooling copy biome` to scaffold',
+    },
+    {
+        check: 'ESLint',
+        candidates: ['eslint.config.js', 'eslint.config.mjs', 'eslint.config.cjs'],
+        expected: `imports "${PACKAGE}/eslint/*"`,
+        matcher: /@rtorcato\/js-tooling\/eslint\//,
+        optional: true,
+        hint: 'Import from @rtorcato/js-tooling/eslint/base in eslint.config.mjs',
+    },
+    {
+        check: 'Prettier',
+        candidates: ['prettier.config.js', 'prettier.config.mjs', 'prettier.config.cjs'],
+        expected: `imports "${PACKAGE}/prettier"`,
+        matcher: /@rtorcato\/js-tooling\/prettier/,
+        optional: true,
+    },
+    {
+        check: 'Vitest',
+        candidates: ['vitest.config.ts', 'vitest.config.js', 'vitest.config.mjs'],
+        expected: `imports "${PACKAGE}/vitest/config"`,
+        matcher: /@rtorcato\/js-tooling\/vitest\/config/,
+        optional: true,
+    },
+    {
+        check: 'Commitlint',
+        candidates: ['commitlint.config.js', 'commitlint.config.mjs', 'commitlint.config.cjs'],
+        expected: `exports "${PACKAGE}/commitlint/config"`,
+        matcher: /@rtorcato\/js-tooling\/commitlint\/config/,
+        optional: true,
+    },
+];
+async function checkFile(dir, spec) {
+    for (const candidate of spec.candidates) {
+        const filepath = path.join(dir, candidate);
+        if (!(await fs.pathExists(filepath)))
+            continue;
+        const contents = await fs.readFile(filepath, 'utf-8');
+        if (spec.matcher.test(contents)) {
+            return {
+                check: spec.check,
+                status: 'ok',
+                detail: `${candidate} ${spec.expected}`,
+            };
+        }
+        return {
+            check: spec.check,
+            status: 'drift',
+            detail: `${candidate} found but does not ${spec.expected}`,
+            hint: spec.hint,
+        };
+    }
+    return {
+        check: spec.check,
+        status: spec.optional ? 'optional-missing' : 'missing',
+        detail: `no ${spec.candidates.join(' / ')} found`,
+        hint: spec.hint,
+    };
+}
+async function checkPackageJson(dir) {
+    const filepath = path.join(dir, 'package.json');
+    if (!(await fs.pathExists(filepath))) {
+        return {
+            check: 'package.json',
+            status: 'missing',
+            detail: 'no package.json found',
+        };
+    }
+    const pkg = await fs.readJson(filepath);
+    const deps = { ...(pkg.dependencies ?? {}), ...(pkg.devDependencies ?? {}) };
+    if (deps[PACKAGE]) {
+        return {
+            check: 'package.json',
+            status: 'ok',
+            detail: `${PACKAGE}@${deps[PACKAGE]} in dependencies`,
+        };
+    }
+    return {
+        check: 'package.json',
+        status: 'drift',
+        detail: `${PACKAGE} not in dependencies or devDependencies`,
+        hint: `Run \`pnpm add -D ${PACKAGE}\``,
+    };
+}
+export async function runDoctor(dir) {
+    const targetDir = path.resolve(dir);
+    const results = [];
+    results.push(await checkPackageJson(targetDir));
+    for (const spec of FILE_CHECKS) {
+        results.push(await checkFile(targetDir, spec));
+    }
+    return results;
+}
+const STATUS_ICONS = {
+    ok: chalk.green('✅'),
+    drift: chalk.yellow('⚠️ '),
+    missing: chalk.red('❌'),
+    'optional-missing': chalk.gray('➖'),
+};
+function statusLabel(status) {
+    switch (status) {
+        case 'ok':
+            return chalk.green('ok');
+        case 'drift':
+            return chalk.yellow('drift');
+        case 'missing':
+            return chalk.red('missing');
+        case 'optional-missing':
+            return chalk.gray('not configured');
+    }
+}
+export function summarize(results) {
+    return {
+        ok: results.filter((r) => r.status === 'ok').length,
+        drift: results.filter((r) => r.status === 'drift').length,
+        missing: results.filter((r) => r.status === 'missing').length,
+        optionalMissing: results.filter((r) => r.status === 'optional-missing').length,
+    };
+}
+export async function doctorCommand(options = {}) {
+    const dir = options.directory ?? process.cwd();
+    const results = await runDoctor(dir);
+    if (options.json) {
+        console.log(JSON.stringify({ directory: path.resolve(dir), results }, null, 2));
+    }
+    else {
+        console.log(chalk.cyan(`\n🩺 Diagnosing ${path.resolve(dir)} against ${PACKAGE} presets...\n`));
+        for (const r of results) {
+            console.log(`  ${STATUS_ICONS[r.status]} ${chalk.bold(r.check)} — ${statusLabel(r.status)}`);
+            console.log(`     ${chalk.gray(r.detail)}`);
+            if (r.hint && (r.status === 'drift' || r.status === 'missing')) {
+                console.log(`     ${chalk.dim('hint:')} ${chalk.dim(r.hint)}`);
+            }
+        }
+        const summary = summarize(results);
+        console.log();
+        console.log(`  Summary: ${chalk.green(`${summary.ok} ok`)}, ${chalk.yellow(`${summary.drift} drift`)}, ${chalk.red(`${summary.missing} missing`)}, ${chalk.gray(`${summary.optionalMissing} not configured`)}\n`);
+    }
+    const summary = summarize(results);
+    const exitCode = summary.drift > 0 || summary.missing > 0 ? 1 : 0;
+    process.exitCode = exitCode;
+}

package/dist/cli/index.js

@@ -2,6 +2,7 @@
 import chalk from 'chalk';
 import { Command } from 'commander';
 import packageJson from '../../package.json' with { type: 'json' };
+import { doctorCommand } from './commands/doctor.js';
 import { setupProject } from './commands/setup.js';
 const program = new Command();
 program
@@ -89,6 +90,12 @@ program
     });
     console.log(chalk.dim('\n💡 Run "js-tooling setup" to configure your project\n'));
 });
+program
+    .command('doctor')
+    .description('🩺 Diagnose project alignment with @rtorcato/js-tooling presets')
+    .option('-d, --directory <path>', 'Target directory to diagnose', process.cwd())
+    .option('--json', 'Emit machine-readable JSON output')
+    .action(doctorCommand);
 // Handle unknown commands
 program.on('command:*', () => {
     console.error(chalk.red(`\n❌ Unknown command: ${program.args.join(' ')}`));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rtorcato/js-tooling",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"description": "JavaScript and TypeScript tooling for Node.js, React, Next.js, and Vitest.",
 	"type": "module",
 	"keywords": [
@@ -20,8 +20,7 @@
 		"url": "https://github.com/rtorcato/js-tooling/issues"
 	},
 	"scripts": {
-		"build-dev": "rimraf ./dist && cross-env NODE_ENV=development node build.mjs && pnpm build-cli",
-		"build-prod": "rimraf ./dist && cross-env NODE_ENV=production node build.mjs && pnpm build-cli",
+		"build": "pnpm build-cli",
 		"build-cli": "rimraf ./dist/cli && tsc --project src/cli/tsconfig.json",
 		"prepublishOnly": "./scripts/fix-bins.sh",
 		"==================== Common ====================": "",
@@ -39,31 +38,56 @@
 	},
 	"files": [
 		"dist/cli/**/*.js",
-		"tooling/*",
 		"tooling/commitlint/commitlint.mjs",
+		"tooling/commitlint/commitlint.d.mts",
 		"tooling/esbuild/index.mjs",
+		"tooling/esbuild/index.d.mts",
 		"tooling/eslint/*.mjs",
+		"tooling/eslint/*.d.mts",
+		"tooling/eslint/types.d.ts",
 		"tooling/jest-presets/**",
 		"tooling/prettier/index.mjs",
+		"tooling/prettier/index.d.mts",
 		"tooling/typescript/*.json",
 		"tooling/typescript/reset.d.ts",
 		"tooling/vitest/vitest.config.mjs",
+		"tooling/vitest/vitest.config.d.mts",
 		"tooling/tsup/index.ts",
 		"tooling/biome/biome.json",
 		"tooling/biome/biome.jsonc",
 		"tooling/semantic-release/*.mjs",
+		"tooling/semantic-release/*.d.mts",
 		"README.md"
 	],
 	"exports": {
 		"./commitlint/config": {
+			"types": "./tooling/commitlint/commitlint.d.mts",
 			"import": "./tooling/commitlint/commitlint.mjs"
 		},
-		"./esbuild": "./tooling/esbuild/index.mjs",
-		"./eslint/base": "./tooling/eslint/base.mjs",
-		"./eslint/nextjs": "./tooling/eslint/nextjs.mjs",
-		"./jest-presets/browser/jest-preset": "./tooling/jest-presets/browser/jest-preset.mjs",
-		"./jest-presets/node/jest-preset": "./tooling/jest-presets/node/jest-preset.mjs",
-		"./prettier": "./tooling/prettier/index.mjs",
+		"./esbuild": {
+			"types": "./tooling/esbuild/index.d.mts",
+			"import": "./tooling/esbuild/index.mjs"
+		},
+		"./eslint/base": {
+			"types": "./tooling/eslint/base.d.mts",
+			"import": "./tooling/eslint/base.mjs"
+		},
+		"./eslint/nextjs": {
+			"types": "./tooling/eslint/nextjs.d.mts",
+			"import": "./tooling/eslint/nextjs.mjs"
+		},
+		"./jest-presets/browser/jest-preset": {
+			"types": "./tooling/jest-presets/browser/jest-preset.d.mts",
+			"import": "./tooling/jest-presets/browser/jest-preset.mjs"
+		},
+		"./jest-presets/node/jest-preset": {
+			"types": "./tooling/jest-presets/node/jest-preset.d.mts",
+			"import": "./tooling/jest-presets/node/jest-preset.mjs"
+		},
+		"./prettier": {
+			"types": "./tooling/prettier/index.d.mts",
+			"import": "./tooling/prettier/index.mjs"
+		},
 		"./typescript/base": "./tooling/typescript/tsconfig.base.json",
 		"./typescript/next": "./tooling/typescript/tsconfig.next.json",
 		"./typescript/express": "./tooling/typescript/tsconfig.express.json",
@@ -71,12 +95,24 @@
 		"./typescript/react": "./tooling/typescript/tsconfig.react.json",
 		"./typescript/test": "./tooling/typescript/tsconfig.test.json",
 		"./typescript/reset": "./tooling/typescript/reset.d.ts",
-		"./vitest/config": "./tooling/vitest/vitest.config.mjs",
+		"./vitest/config": {
+			"types": "./tooling/vitest/vitest.config.d.mts",
+			"import": "./tooling/vitest/vitest.config.mjs"
+		},
 		"./tsup": "./tooling/tsup/index.ts",
 		"./biome": "./tooling/biome/biome.json",
-		"./semantic-release": "./tooling/semantic-release/index.mjs",
-		"./semantic-release/github": "./tooling/semantic-release/github.mjs",
-		"./semantic-release/docker": "./tooling/semantic-release/docker.mjs"
+		"./semantic-release": {
+			"types": "./tooling/semantic-release/index.d.mts",
+			"import": "./tooling/semantic-release/index.mjs"
+		},
+		"./semantic-release/github": {
+			"types": "./tooling/semantic-release/github.d.mts",
+			"import": "./tooling/semantic-release/github.mjs"
+		},
+		"./semantic-release/docker": {
+			"types": "./tooling/semantic-release/docker.d.mts",
+			"import": "./tooling/semantic-release/docker.mjs"
+		}
 	},
 	"dependencies": {
 		"chalk": "^5.6.2",
@@ -104,6 +140,7 @@
 		"@typescript-eslint/eslint-plugin": "^8.46.2",
 		"@typescript-eslint/parser": "^8.46.2",
 		"@vitejs/plugin-react": "^5.1.0",
+		"@vitest/coverage-v8": "^4.0.3",
 		"commitizen": "^4.3.1",
 		"conventional-changelog-conventionalcommits": "^9.1.0",
 		"cross-env": "^10.1.0",
@@ -130,7 +167,7 @@
 		"ts-jest": "^29.4.5",
 		"tsup": "8.5.0",
 		"typescript": "^5.9.3",
-		"typescript-eslint": "latest",
+		"typescript-eslint": "^8.60.0",
 		"vitest": "4.0.3"
 	},
 	"peerDependencies": {

package/tooling/commitlint/commitlint.d.mts

@@ -0,0 +1,4 @@
+import type { UserConfig } from '@commitlint/types'
+
+declare const config: UserConfig
+export default config

package/tooling/esbuild/index.d.mts

@@ -0,0 +1,6 @@
+import type { BuildOptions, BuildResult } from 'esbuild'
+
+export declare function buildCode(
+	entryPoints?: string[],
+	options?: Partial<BuildOptions>
+): Promise<BuildResult | undefined>

package/tooling/eslint/base.d.mts

@@ -0,0 +1,6 @@
+import type { Linter } from 'eslint'
+
+declare const config: Linter.Config[]
+export default config
+
+export declare const restrictEnvAccess: Linter.Config[]

package/tooling/eslint/nextjs.d.mts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint'
+
+declare const config: Linter.Config[]
+export default config

package/tooling/jest-presets/browser/jest-preset.d.mts

@@ -0,0 +1,4 @@
+import type { Config } from 'jest'
+
+declare const config: Config
+export default config

package/tooling/jest-presets/node/jest-preset.d.mts

@@ -0,0 +1,4 @@
+import type { Config } from 'jest'
+
+declare const config: Config
+export default config

package/tooling/prettier/index.d.mts

@@ -0,0 +1,4 @@
+import type { Config } from 'prettier'
+
+declare const config: Config
+export default config

package/tooling/semantic-release/docker.d.mts

@@ -0,0 +1,4 @@
+import type { Options } from 'semantic-release'
+
+declare const config: Options
+export default config

package/tooling/semantic-release/github.d.mts

@@ -0,0 +1,4 @@
+import type { Options } from 'semantic-release'
+
+declare const config: Options
+export default config

package/tooling/semantic-release/index.d.mts

@@ -0,0 +1,4 @@
+import type { Options } from 'semantic-release'
+
+declare const config: Options
+export default config

package/tooling/vitest/vitest.config.d.mts

@@ -0,0 +1,4 @@
+import type { UserConfig } from 'vitest/config'
+
+declare const config: UserConfig
+export default config

package/tooling/vitest/vitest.config.mjs

@@ -9,8 +9,15 @@ export default defineConfig({
 		globals: true,
 		environment: 'node',
 		coverage: {
-			provider: 'istanbul', // or 'v8'
+			provider: 'v8',
 			reporter: ['text', 'json', 'html'],
+			include: ['src/cli/generators/**/*.ts'],
+			thresholds: {
+				statements: 25,
+				lines: 25,
+				functions: 40,
+				branches: 17,
+			},
 		},
 	},
 	resolve: {

package/tooling/esbuild/build-sample.mjs

@@ -1,21 +0,0 @@
-/*
-Sample call to build.mjs in root of project.
-
-*/
-
-import { buildCode, getEntrypointFolders } from './index.mjs'
-// import { buildCode, getEntrypointFolders } from '@rtorcato/js-tooling/esbuild/index.mjs'
-
-const folders = await getEntrypointFolders('src')
-const libEntryPointsArrays = await Promise.all(folders.map((folder) => getEntryPoints(folder)))
-const libEntryPoints = libEntryPointsArrays.flat()
-const allEntryPoints = [
-	'src/index.ts', // Main entry point
-	...libEntryPoints,
-	// ...exampleEntryPoints,
-]
-// Run the build function
-buildCode(allEntryPoints).catch((e) => {
-	console.error(e)
-	process.exit(1)
-})

package/tooling/eslint/package.json

@@ -1,35 +0,0 @@
-{
-	"name": "@dropwallet/eslint-config",
-	"private": true,
-	"version": "0.3.0",
-	"type": "module",
-	"exports": {
-		"./base": "./base.js",
-		"./nextjs": "./nextjs.js"
-	},
-	"scripts": {
-		"clean": "rm -rf .turbo node_modules",
-		"format": "prettier --check . --ignore-path ../../.gitignore",
-		"typecheck": "tsc --noEmit"
-	},
-	"dependencies": {
-		"@next/eslint-plugin-next": "^14.2.3",
-		"eslint-config-airbnb": "^19.0.4",
-		"eslint-config-prettier": "9.1.0",
-		"eslint-config-turbo": "^1.13.3",
-		"eslint-plugin-import": "^2.29.1",
-		"eslint-plugin-jest": "28.5.0",
-		"eslint-plugin-jsx-a11y": "^6.8.0",
-		"eslint-plugin-react": "^7.34.1",
-		"eslint-plugin-react-hooks": "^4.6.2",
-		"eslint-plugin-vitest": "0.5.4",
-		"typescript-eslint": "7.9.0"
-	},
-	"devDependencies": {
-		"@dropwallet/tsconfig": "workspace:*",
-		"@eslint/js": "9.2.0",
-		"eslint": "9.2.0",
-		"prettier": "^3.2.5",
-		"typescript": "^5.4.5"
-	}
-}

package/tooling/nextjs/next.config.js

@@ -1,4 +0,0 @@
-/** @type {import('next').NextConfig} */
-module.exports = {
-	output: 'standalone',
-}

package/tooling/oxc/README.md

@@ -1 +0,0 @@
-https://oxc.rs

package/tooling/tsup/tsconfig.cjs.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "module": "commonjs"
-  }
-}

package/tooling/tsup/tsconfig.esm.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "module": "esnext",
-    "emitDeclarationOnly": false,
-    "noEmit": false
-  }
-}

package/tooling/tsup/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./../typescript/internal-package.json",
-  "compilerOptions": {
-    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json",
-    "incremental": true,
-    "outDir": "./dist",
-    "baseUrl": "."
-  },
-  "include": ["./src/**/*.ts", "index.ts"],
-  "exclude": ["node_modules"]
-}

package/tooling/tsup/tsconfig.types.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "declaration": true,
-    "noEmit": false,
-    "emitDeclarationOnly": true
-  }
-}

package/tooling/vitest/vitest.config.react.mjs

@@ -1,27 +0,0 @@
-import base from '@rtorcato/js-tooling/vitest/config'
-import react from '@vitejs/plugin-react'
-import { dirname, resolve } from 'node:path'
-import { fileURLToPath } from 'node:url'
-import { defineConfig, mergeConfig } from 'vitest/config'
-
-const __dirname = dirname(fileURLToPath(import.meta.url))
-
-export default mergeConfig(
-	base,
-	defineConfig({
-		plugins: [react()],
-		test: {
-			environment: 'jsdom',
-			include: ['src/**/*.{test,spec}.{js,jsx,ts,tsx}'],
-			css: true, // ← Vitest will stub every *.css / *.module.css import
-			exclude: ['OLD/**'],
-			setupFiles: ['./vitest.setup.ts'],
-		},
-		resolve: {
-			alias: [
-				{ find: '@', replacement: resolve(__dirname, './src') },
-				{ find: '~', replacement: resolve(__dirname, './src') },
-			],
-		},
-	})
-)

package/tooling/vitest/vitest.setup.mjs

@@ -1,3 +0,0 @@
-import { vi } from 'vitest'
-
-vi.mock('**/*.module.css', () => ({}))