@dimensional-innovations/tool-config 1.4.1 → 3.0.0

package/README.md

@@ -1,15 +1,15 @@
 # @dimensional-innovations/tool-config
 
-> Universal configuration package for ESLint, Prettier, Stylelint, and semantic-release with automatic framework detection.
+> Universal configuration package for ESLint, Prettier, Stylelint, TypeScript, and semantic-release with automatic framework detection.
 
 [![npm version](https://img.shields.io/npm/v/@dimensional-innovations/tool-config.svg)](https://www.npmjs.com/package/@dimensional-innovations/tool-config)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node Version](https://img.shields.io/badge/node-%3E%3D22.12.0-brightgreen.svg)](https://nodejs.org/)
 [![Test Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](./tests/)
 
-**One package. Four tools. Zero configuration.**
+**One package. Five tools. Zero configuration.**
 
-Stop juggling multiple config packages. This single package provides battle-tested configurations for ESLint, Prettier, Stylelint, and semantic-release that automatically detect your project's framework, environment, and TypeScript setup.
+Stop juggling multiple config packages. This single package provides battle-tested configurations for ESLint, Prettier, Stylelint, TypeScript, and semantic-release that automatically detect your project's framework, environment, and TypeScript setup.
 
 ## Why This Package?
 
@@ -34,12 +34,14 @@ npm install --save-dev @dimensional-innovations/tool-config
 ## Features
 
 - 🎯 **Zero Configuration** - Auto-detects your framework, environment, and TypeScript
-- 🧰 **Multi-Tool Support** - ESLint, Prettier, Stylelint, semantic-release in one package
+- 🧰 **Multi-Tool Support** - ESLint, Prettier, Stylelint, TypeScript, semantic-release in one package
 - ⚛️ **8+ Frameworks** - React, Vue, Svelte, Solid, Astro, Angular, Vanilla JS, Node.js
 - 📦 **All-In-One** - All plugins and parsers included as dependencies
 - 🔧 **Customizable** - Override any setting while keeping smart defaults
-- 🚀 **Modern** - ESLint 9+ flat config, latest tooling versions
-- ✅ **Battle-Tested** - 369 tests with 100% coverage
+- 🚀 **Modern** - ESLint 9+ flat config, TypeScript with tsgo support (10x faster)
+- 🔄 **Uninstall Support** - Clean removal with safety checks for modified files
+- 🎬 **Smart Scripts** - Auto-generated `check-all` script runs tools in optimal order
+- ✅ **Battle-Tested** - 556 tests with 100% coverage
 
 ## Quick Start
 
@@ -83,6 +85,22 @@ import { createConfig } from '@dimensional-innovations/tool-config'
 export default createConfig('stylelint')
 ```
 
+**TypeScript** (`tsconfig.json`):
+
+```json
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}
+```
+
+Or use the factory function to generate framework-specific TypeScript configs programmatically.
+
 **semantic-release** (`release.config.js`):
 
 ```javascript
@@ -103,23 +121,28 @@ That's it! The configs will automatically detect your framework and TypeScript s
     "prettier": "prettier --check .",
     "prettier:fix": "prettier --write .",
     "style": "stylelint '**/*.css'",
-    "style:fix": "stylelint '**/*.css' --fix"
+    "style:fix": "stylelint '**/*.css' --fix",
+    "typecheck": "tsc --noEmit",
+    "typecheck:watch": "tsc --noEmit --watch",
+    "check-all": "npm run prettier && npm run style && npm run lint && npm run typecheck"
   }
 }
 ```
 
+**Tip:** The CLI automatically adds a `check-all` script when you setup multiple tools. This runs all validation tools in the optimal order: formatting → styles → linting → type checking.
+
 ## Supported Frameworks
 
-| Framework | ESLint | Prettier | Stylelint           | Auto-Detect |
-| --------- | ------ | -------- | ------------------- | ----------- |
-| React     | ✅     | ✅       | ✅ CSS Modules      | ✅          |
-| Vue       | ✅     | ✅       | ✅ Scoped Styles    | ✅          |
-| Svelte    | ✅     | ✅       | ✅ Component Styles | ✅          |
-| Solid     | ✅     | ✅       | ✅ CSS Modules      | ✅          |
-| Astro     | ✅     | ✅       | ✅                  | ✅          |
-| Angular   | ✅     | ✅       | ✅                  | ✅          |
-| Vanilla   | ✅     | ✅       | ✅                  | ✅          |
-| Node.js   | ✅     | ✅       | N/A                 | ✅          |
+| Framework | ESLint | Prettier | Stylelint           | TypeScript      | Auto-Detect |
+| --------- | ------ | -------- | ------------------- | --------------- | ----------- |
+| React     | ✅     | ✅       | ✅ CSS Modules      | ✅ react-jsx    | ✅          |
+| Vue       | ✅     | ✅       | ✅ Scoped Styles    | ✅ vue-tsc      | ✅          |
+| Svelte    | ✅     | ✅       | ✅ Component Styles | ✅ svelte types | ✅          |
+| Solid     | ✅     | ✅       | ✅ CSS Modules      | ✅ solid-js     | ✅          |
+| Astro     | ✅     | ✅       | ✅                  | ✅ astro/client | ✅          |
+| Angular   | ✅     | ✅       | ✅                  | ✅ decorators   | ✅          |
+| Vanilla   | ✅     | ✅       | ✅                  | ✅ browser      | ✅          |
+| Node.js   | ✅     | ✅       | N/A                 | ✅ NodeNext     | ✅          |
 
 **Meta-frameworks**: Next.js (→ React), Nuxt (→ Vue), SvelteKit (→ Svelte)
 
@@ -131,7 +154,7 @@ The main factory function that creates configurations for any supported tool.
 
 **Parameters:**
 
-- `tool` (string, required): Tool name - `'eslint'`, `'prettier'`, `'stylelint'`, or `'semantic-release'`
+- `tool` (string, required): Tool name - `'eslint'`, `'prettier'`, `'stylelint'`, `'typescript'`, or `'semantic-release'`
 - `options` (object, optional): Configuration options
 
 **Common Options:**
@@ -219,6 +242,42 @@ export default createConfig('stylelint', {
 })
 ```
 
+### TypeScript Options
+
+```javascript
+await createConfig('typescript', {
+  framework: 'auto', // Auto-detect or specify framework
+  environment: 'auto', // 'auto' | 'browser' | 'node' | 'universal'
+  checker: 'auto', // 'auto' | 'modern' (tsgo) | 'legacy' (tsc/vue-tsc)
+  strict: true, // Enable strict type checking
+  compilerOptions: {} // Custom TypeScript compiler options
+})
+```
+
+**Example - React with Custom Options:**
+
+```javascript
+export default await createConfig('typescript', {
+  framework: 'react',
+  compilerOptions: {
+    baseUrl: '.',
+    paths: {
+      '@/*': ['src/*']
+    }
+  }
+})
+```
+
+**Example - Use tsgo for 10x Faster Type Checking:**
+
+```javascript
+export default await createConfig('typescript', {
+  checker: 'modern' // Forces tsgo when installed
+})
+```
+
+**tsgo Support:** Install `@typescript/native-preview` for 10x faster type checking. The package automatically detects and uses tsgo when available.
+
 ### semantic-release Options
 
 ```javascript
@@ -365,22 +424,68 @@ npx @dimensional-innovations/tool-config
 - Choose which tools to configure
 - Auto-detects framework and TypeScript
 - Creates config files automatically
-- Adds npm scripts to package.json
-- **NEW:** Automated CI/CD pipeline setup
+- Adds npm scripts to package.json (including `check-all` for multiple tools)
+- Automated CI/CD pipeline setup
+- **Uninstall support** - Clean removal of configs and scripts
 - Supports dry-run mode
 
-**Options:**
+**Setup Options:**
 
 ```bash
+# Interactive mode
+npx @dimensional-innovations/tool-config                 # Choose tools interactively
+
+# Single tool setup
 npx @dimensional-innovations/tool-config eslint          # Setup ESLint only
-npx @dimensional-innovations/tool-config --all           # Setup all tools
-npx @dimensional-innovations/tool-config --dry-run       # Preview without creating files
+npx @dimensional-innovations/tool-config prettier        # Setup Prettier only
+npx @dimensional-innovations/tool-config stylelint       # Setup Stylelint only
+
+# Setup all tools
+npx @dimensional-innovations/tool-config --all           # Setup all tools at once
+
+# CI/CD setup
 npx @dimensional-innovations/tool-config --ci gitlab     # Setup GitLab CI/CD
 npx @dimensional-innovations/tool-config --ci github     # Setup GitHub Actions
 npx @dimensional-innovations/tool-config --setup-ci      # Interactive CI setup
+
+# Preview mode
+npx @dimensional-innovations/tool-config --dry-run       # Preview without creating files
+
+# Help
 npx @dimensional-innovations/tool-config --help          # Show all options
 ```
 
+**Uninstall Options:**
+
+```bash
+# Interactive uninstall
+npx @dimensional-innovations/tool-config --uninstall     # Choose which tools to remove
+
+# Uninstall specific tool
+npx @dimensional-innovations/tool-config --uninstall eslint
+
+# Uninstall all detected tools
+npx @dimensional-innovations/tool-config --uninstall --all
+
+# Remove CI/CD configuration
+npx @dimensional-innovations/tool-config --uninstall --ci
+
+# Preview uninstall
+npx @dimensional-innovations/tool-config --uninstall --dry-run
+```
+
+**Safety Features:**
+
+The uninstall command includes safety features to protect your customizations:
+
+- Only removes files that match the original generated templates
+- Skips modified configuration files (warns you instead)
+- Only removes auto-generated package.json scripts
+- Preserves custom scripts with the same names
+- Supports dry-run to preview what will be removed
+- Cleans up empty directories (e.g., `.github/workflows`)
+- Idempotent - safe to run multiple times
+
 **CI/CD Integration:**
 
 When you select `semantic-release` in interactive mode, the CLI will automatically prompt you to setup CI/CD for automated releases. Or use the `--ci` flag to setup CI/CD directly:

package/bin/lib/ci-setup.js

@@ -0,0 +1,142 @@
+/**
+ * CI/CD setup utilities for setup-tool-config CLI
+ * Handles CI template copying and configuration
+ */
+
+import { copyFileSync, existsSync, mkdirSync } from 'fs'
+import { dirname, join } from 'path'
+import { fileURLToPath } from 'url'
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const __filename = fileURLToPath(import.meta.url)
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const __dirname = dirname(__filename)
+
+/**
+ * Get CI filename and path for a git provider
+ */
+function getCIFileInfo(provider) {
+  const ciFiles = {
+    gitlab: {
+      filename: '.gitlab-ci.yml',
+      destination: '.gitlab-ci.yml',
+      template: '.gitlab-ci.yml'
+    },
+    github: {
+      filename: 'ci.yml',
+      destination: '.github/workflows/ci.yml',
+      template: 'github-workflow.yml',
+      needsDir: true
+    },
+    bitbucket: {
+      filename: 'bitbucket-pipelines.yml',
+      destination: 'bitbucket-pipelines.yml',
+      template: 'bitbucket-pipelines.yml'
+    }
+  }
+
+  return ciFiles[provider] || null
+}
+
+/**
+ * Get environment variable instructions for a git provider
+ */
+function getCIInstructions(provider) {
+  const instructions = {
+    gitlab: `
+⚠️  Configuration Required:
+  Add these CI/CD variables in GitLab Settings > CI/CD > Variables:
+  - GL_TOKEN: GitLab Personal Access Token (with api scope)
+  - NPM_TOKEN: npm authentication token
+
+  Then push to main branch to trigger automated releases.`,
+    github: `
+⚠️  Configuration Required:
+  Add these secrets in GitHub Settings > Secrets and variables > Actions:
+  - GITHUB_TOKEN: Automatically provided by GitHub Actions
+  - NPM_TOKEN: npm authentication token
+
+  Then push to main branch to trigger automated releases.`,
+    bitbucket: `
+⚠️  Configuration Required:
+  Add this repository variable in Bitbucket Settings > Pipelines > Repository variables:
+  - NPM_TOKEN: npm authentication token
+
+  Then push to main branch to trigger automated releases.`
+  }
+
+  return instructions[provider] || ''
+}
+
+/**
+ * Copy CI/CD template
+ */
+export function copyCITemplate(provider, cwd, dryRun = false) {
+  if (!provider || provider === 'unknown') {
+    console.log('  ⚠️  Could not detect git provider - skipping CI setup')
+    console.log('  💡 You can manually copy templates from:')
+    console.log(
+      '     node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/templates/'
+    )
+    return false
+  }
+
+  const ciInfo = getCIFileInfo(provider)
+
+  if (!ciInfo) {
+    console.log(`  ⚠️  Unsupported git provider: ${provider}`)
+    return false
+  }
+
+  const destPath = join(cwd, ciInfo.destination)
+  const destDir = dirname(destPath)
+
+  // Check if CI file already exists
+  if (existsSync(destPath)) {
+    console.log(`  ⚠️  ${ciInfo.destination} already exists - skipping`)
+    return false
+  }
+
+  if (dryRun) {
+    console.log(`  📄 Would create: ${ciInfo.destination}`)
+    if (ciInfo.needsDir && !existsSync(destDir)) {
+      console.log(`  📁 Would create directory: ${dirname(ciInfo.destination)}`)
+    }
+    return true
+  }
+
+  try {
+    // Create directory if needed
+    if (ciInfo.needsDir && !existsSync(destDir)) {
+      mkdirSync(destDir, { recursive: true })
+      console.log(`  ✅ Created directory: ${dirname(ciInfo.destination)}`)
+    }
+
+    // Copy template
+    const templatePath = join(
+      __dirname,
+      '..',
+      '..',
+      'src',
+      'tools',
+      'semantic-release',
+      'templates',
+      ciInfo.template
+    )
+    copyFileSync(templatePath, destPath)
+    console.log(`  ✅ Created: ${ciInfo.destination}`)
+
+    // Show configuration instructions
+    console.log(getCIInstructions(provider))
+
+    console.log('\n  📖 For more details, see:')
+    console.log(
+      '     node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/CI_SETUP.md'
+    )
+
+    return true
+  } catch (error) {
+    console.error(`  ❌ Failed to copy CI template:`, error.message)
+    return false
+  }
+}

package/bin/lib/formatting.js

@@ -0,0 +1,103 @@
+/**
+ * Formatting utilities for CLI output
+ * Standardized box drawing with consistent width
+ */
+
+import pc from 'picocolors'
+
+const BOX_WIDTH = 70 // Standard width for all boxes
+
+export const BOX = {
+  topLeft: '┌',
+  topRight: '┐',
+  bottomLeft: '└',
+  bottomRight: '┘',
+  vertical: '│',
+  horizontal: '─',
+  separator: '━',
+  width: BOX_WIDTH
+}
+
+/**
+ * Create a box with standard width (70 chars)
+ * @param {string[]} lines - Array of content lines
+ * @param {string} title - Optional title for top border
+ * @returns {string} Formatted box
+ */
+export function createBox(lines, title = '') {
+  const width = BOX.width
+  const contentWidth = width - 4 // Remove: │ + space + space + │
+
+  // Create top border
+  let top
+  if (title) {
+    const titlePart = `─ ${title} `
+    const remaining = width - 2 - titlePart.length // -2 for corners
+    top = BOX.topLeft + titlePart + BOX.horizontal.repeat(remaining) + BOX.topRight
+  } else {
+    top = BOX.topLeft + BOX.horizontal.repeat(width - 2) + BOX.topRight
+  }
+
+  // Create content lines - pad each to exact width
+  const content = lines.map(line => {
+    const padded = line.slice(0, contentWidth).padEnd(contentWidth)
+    return `${BOX.vertical} ${padded} ${BOX.vertical}`
+  })
+
+  // Create bottom border
+  const bottom = BOX.bottomLeft + BOX.horizontal.repeat(width - 2) + BOX.bottomRight
+
+  return [top, ...content, bottom].join('\n')
+}
+
+/**
+ * Create a separator line
+ * @returns {string} Separator line
+ */
+export function createSeparator() {
+  return BOX.separator.repeat(BOX.width)
+}
+
+/**
+ * Create a simple indented list
+ * @param {string[]} items - Array of items
+ * @param {string} bullet - Bullet character (default: '•')
+ * @returns {string} Formatted list
+ */
+export function createList(items, bullet = '•') {
+  return items.map(item => `   ${bullet} ${item}`).join('\n')
+}
+
+/**
+ * Create a progress indicator
+ * @param {number} current - Current step
+ * @param {number} total - Total steps
+ * @param {string} label - Label for this step
+ * @returns {string} Progress line
+ */
+export function createProgress(current, total, label) {
+  return `  [${current}/${total}] ${label}`
+}
+
+/**
+ * Color symbols for CLI output
+ */
+export const SYMBOLS = {
+  success: pc.green('✓'),
+  warning: pc.yellow('⚠'),
+  error: pc.red('✗'),
+  info: pc.blue('ℹ')
+}
+
+/**
+ * Color helper functions
+ */
+export const colors = {
+  success: pc.green,
+  warning: pc.yellow,
+  error: pc.red,
+  info: pc.blue,
+  dim: pc.dim,
+  bold: pc.bold,
+  cyan: pc.cyan
+}

package/bin/lib/handlers/eslint.js

@@ -0,0 +1,61 @@
+/**
+ * ESLint handler for setup-tool-config CLI
+ */
+
+import { existsSync, writeFileSync } from 'fs'
+import { join } from 'path'
+
+/**
+ * Get config filename
+ */
+export function getConfigFilename() {
+  return 'eslint.config.js'
+}
+
+/**
+ * Generate config file content
+ */
+export function generateConfigContent() {
+  return `import { createConfig } from '@dimensional-innovations/tool-config'
+
+export default await createConfig('eslint')
+`
+}
+
+/**
+ * Get npm scripts
+ */
+export function getScripts() {
+  return {
+    lint: 'eslint .',
+    'lint:fix': 'eslint --fix .'
+  }
+}
+
+/**
+ * Write config file
+ */
+export function writeConfig(cwd, _detected, dryRun = false) {
+  const filename = getConfigFilename()
+  const filepath = join(cwd, filename)
+  const content = generateConfigContent()
+
+  if (existsSync(filepath)) {
+    console.log(`  ⚠️  ${filename} already exists - skipping`)
+    return false
+  }
+
+  if (dryRun) {
+    console.log(`  📄 Would create: ${filename}`)
+    return true
+  }
+
+  try {
+    writeFileSync(filepath, content, 'utf8')
+    console.log(`  ✅ Created: ${filename}`)
+    return true
+  } catch (error) {
+    console.error(`  ❌ Failed to create ${filename}:`, error.message)
+    return false
+  }
+}

package/bin/lib/handlers/prettier.js

@@ -0,0 +1,83 @@
+/**
+ * Prettier handler for setup-tool-config CLI
+ */
+
+import { existsSync, writeFileSync } from 'fs'
+import { join } from 'path'
+
+import { prettierIgnoreContent } from '../../../src/tools/prettier/index.js'
+
+/**
+ * Get config filename
+ */
+export function getConfigFilename() {
+  return 'prettier.config.js'
+}
+
+/**
+ * Generate config file content
+ */
+export function generateConfigContent() {
+  return `import { createConfig } from '@dimensional-innovations/tool-config'
+
+export default createConfig('prettier')
+`
+}
+
+/**
+ * Get npm scripts
+ */
+export function getScripts() {
+  return {
+    'prettier:fix': 'prettier --write .',
+    prettier: 'prettier --check .'
+  }
+}
+
+/**
+ * Write config file
+ */
+export function writeConfig(cwd, _detected, dryRun = false) {
+  const filename = getConfigFilename()
+  const filepath = join(cwd, filename)
+  const content = generateConfigContent()
+
+  if (existsSync(filepath)) {
+    console.log(`  ⚠️  ${filename} already exists - skipping`)
+    return false
+  }
+
+  if (dryRun) {
+    console.log(`  📄 Would create: ${filename}`)
+
+    // Prettier also creates .prettierignore
+    const ignoreFile = '.prettierignore'
+    const ignoreExists = existsSync(join(cwd, ignoreFile))
+    if (!ignoreExists) {
+      console.log(`  📄 Would create: ${ignoreFile}`)
+    }
+
+    return true
+  }
+
+  try {
+    writeFileSync(filepath, content, 'utf8')
+    console.log(`  ✅ Created: ${filename}`)
+
+    // Prettier also creates .prettierignore
+    const ignoreFile = '.prettierignore'
+    const ignorePath = join(cwd, ignoreFile)
+
+    if (!existsSync(ignorePath)) {
+      writeFileSync(ignorePath, prettierIgnoreContent, 'utf8')
+      console.log(`  ✅ Created: ${ignoreFile}`)
+    } else {
+      console.log(`  ⚠️  ${ignoreFile} already exists - skipping`)
+    }
+
+    return true
+  } catch (error) {
+    console.error(`  ❌ Failed to create ${filename}:`, error.message)
+    return false
+  }
+}

package/bin/lib/handlers/semantic-release.js

@@ -0,0 +1,60 @@
+/**
+ * semantic-release handler for setup-tool-config CLI
+ */
+
+import { existsSync, writeFileSync } from 'fs'
+import { join } from 'path'
+
+/**
+ * Get config filename
+ */
+export function getConfigFilename() {
+  return 'release.config.js'
+}
+
+/**
+ * Generate config file content
+ */
+export function generateConfigContent() {
+  return `import { createConfig } from '@dimensional-innovations/tool-config'
+
+export default createConfig('semantic-release')
+`
+}
+
+/**
+ * Get npm scripts
+ */
+export function getScripts() {
+  return {
+    release: 'semantic-release'
+  }
+}
+
+/**
+ * Write config file
+ */
+export function writeConfig(cwd, _detected, dryRun = false) {
+  const filename = getConfigFilename()
+  const filepath = join(cwd, filename)
+  const content = generateConfigContent()
+
+  if (existsSync(filepath)) {
+    console.log(`  ⚠️  ${filename} already exists - skipping`)
+    return false
+  }
+
+  if (dryRun) {
+    console.log(`  📄 Would create: ${filename}`)
+    return true
+  }
+
+  try {
+    writeFileSync(filepath, content, 'utf8')
+    console.log(`  ✅ Created: ${filename}`)
+    return true
+  } catch (error) {
+    console.error(`  ❌ Failed to create ${filename}:`, error.message)
+    return false
+  }
+}