@dimensional-innovations/tool-config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 DIMENSIONAL INNOVATIONS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,646 @@
+# @dimensional-innovations/tool-config
+
+> Universal configuration package for ESLint, Prettier, Stylelint, 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.**
+
+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.
+
+## Why This Package?
+
+**Before:**
+
+```bash
+npm install --save-dev \
+  eslint @eslint/js eslint-config-airbnb eslint-plugin-react \
+  prettier prettier-config-standard \
+  stylelint stylelint-config-standard \
+  semantic-release @semantic-release/git @semantic-release/changelog
+
+# ...then configure each one individually
+```
+
+**After:**
+
+```bash
+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
+- ⚛️ **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
+
+## Quick Start
+
+### Installation
+
+```bash
+npm install --save-dev @dimensional-innovations/tool-config
+```
+
+Or use the interactive CLI:
+
+```bash
+npx @dimensional-innovations/tool-config
+```
+
+### Basic Usage
+
+Create config files in your project root:
+
+**ESLint** (`eslint.config.js`):
+
+```javascript
+import { createConfig } from '@dimensional-innovations/tool-config'
+
+export default await createConfig('eslint')
+```
+
+**Prettier** (`prettier.config.js`):
+
+```javascript
+import { createConfig } from '@dimensional-innovations/tool-config'
+
+export default createConfig('prettier')
+```
+
+**Stylelint** (`stylelint.config.js`):
+
+```javascript
+import { createConfig } from '@dimensional-innovations/tool-config'
+
+export default createConfig('stylelint')
+```
+
+**semantic-release** (`release.config.js`):
+
+```javascript
+import { createConfig } from '@dimensional-innovations/tool-config'
+
+export default createConfig('semantic-release')
+```
+
+That's it! The configs will automatically detect your framework and TypeScript setup.
+
+### Add npm Scripts
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "prettier": "prettier --check .",
+    "prettier:fix": "prettier --write .",
+    "style": "stylelint '**/*.css'",
+    "style:fix": "stylelint '**/*.css' --fix"
+  }
+}
+```
+
+## 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                 | ✅          |
+
+**Meta-frameworks**: Next.js (→ React), Nuxt (→ Vue), SvelteKit (→ Svelte)
+
+## API Documentation
+
+### `createConfig(tool, options)`
+
+The main factory function that creates configurations for any supported tool.
+
+**Parameters:**
+
+- `tool` (string, required): Tool name - `'eslint'`, `'prettier'`, `'stylelint'`, or `'semantic-release'`
+- `options` (object, optional): Configuration options
+
+**Common Options:**
+
+```javascript
+{
+  framework: 'auto',      // 'auto' | 'react' | 'vue' | 'svelte' | etc.
+  typescript: undefined,  // undefined (auto-detect) | true | false
+  cwd: process.cwd()     // Working directory for detection
+}
+```
+
+### ESLint Options
+
+```javascript
+await createConfig('eslint', {
+  framework: 'auto', // Auto-detect or specify framework
+  environment: 'auto', // 'auto' | 'browser' | 'node' | 'universal'
+  typescript: undefined, // Auto-detect TypeScript
+  ignore: [], // Additional ignore patterns
+  rules: {} // Custom rule overrides
+})
+```
+
+**Example - Custom Rules:**
+
+```javascript
+export default await createConfig('eslint', {
+  rules: {
+    'no-console': 'off',
+    'react/prop-types': 'warn'
+  }
+})
+```
+
+**Example - Explicit Framework:**
+
+```javascript
+export default await createConfig('eslint', {
+  framework: 'vue',
+  typescript: true
+})
+```
+
+### Prettier Options
+
+```javascript
+createConfig('prettier', {
+  framework: 'auto',
+  // Override any Prettier option
+  semi: false,
+  singleQuote: true,
+  printWidth: 100
+})
+```
+
+**Example - Custom Settings:**
+
+```javascript
+export default createConfig('prettier', {
+  printWidth: 120,
+  tabWidth: 4,
+  trailingComma: 'all'
+})
+```
+
+### Stylelint Options
+
+```javascript
+createConfig('stylelint', {
+  framework: 'auto',
+  cssType: 'auto', // 'auto' | 'scss' | 'css' | { preprocessor, tailwind, modules }
+  rules: {} // Custom rule overrides
+})
+```
+
+**Example - SCSS + Tailwind:**
+
+```javascript
+export default createConfig('stylelint', {
+  cssType: {
+    preprocessor: 'scss',
+    tailwind: true
+  }
+})
+```
+
+### semantic-release Options
+
+```javascript
+createConfig('semantic-release', {
+  preset: 'default', // 'default' | 'library' | 'monorepo'
+  gitProvider: 'auto' // 'auto' | 'gitlab' | 'github' | 'bitbucket'
+})
+```
+
+**Example - Library Release:**
+
+```javascript
+export default createConfig('semantic-release', {
+  preset: 'library',
+  gitProvider: 'github'
+})
+```
+
+## Framework-Specific Guides
+
+### React
+
+**Auto-detected when:**
+
+- `react` or `react-dom` in dependencies
+- `next` in dependencies (Next.js)
+
+**ESLint features:**
+
+- React hooks rules
+- JSX best practices
+- React 18+ features
+
+**Prettier features:**
+
+- JSX formatting
+- Component style consistency
+
+**Stylelint features:**
+
+- CSS Modules support (`:global`, `:local`, `composes`)
+- Tailwind CSS support (auto-detected)
+
+**Example:**
+
+```javascript
+// eslint.config.js - automatically detects React
+export default await createConfig('eslint')
+
+// prettier.config.js - automatically formats JSX
+export default createConfig('prettier')
+```
+
+### Vue
+
+**Auto-detected when:**
+
+- `vue` in dependencies
+- `nuxt` in dependencies (Nuxt)
+
+**ESLint features:**
+
+- Vue 3 Composition API
+- `<script setup>` support
+- Template linting
+
+**Prettier features:**
+
+- SFC (Single File Component) formatting
+- `prettier-plugin-vue` integration
+
+**Stylelint features:**
+
+- Scoped styles support
+- Vue SFC style blocks
+
+**Example:**
+
+```javascript
+// stylelint.config.js - automatically handles .vue files
+export default createConfig('stylelint')
+
+// npm scripts
+{
+  "style": "stylelint '**/*.css' '**/*.vue'"
+}
+```
+
+### Svelte
+
+**Auto-detected when:**
+
+- `svelte` in dependencies
+- `@sveltejs/kit` in dependencies (SvelteKit)
+
+**ESLint features:**
+
+- Svelte 5 runes support
+- Component linting
+- Reactive statements
+
+**Prettier features:**
+
+- Svelte component formatting
+- `prettier-plugin-svelte` integration
+
+**Stylelint features:**
+
+- Component-scoped styles
+- `.svelte` file support
+
+### TypeScript
+
+**Auto-detected when:**
+
+- `typescript` in devDependencies
+- `tsconfig.json` exists
+
+**Features:**
+
+- Type-aware linting
+- Strict type checking rules
+- Import/export type syntax
+- Works with all frameworks
+
+**Disable if needed:**
+
+```javascript
+export default await createConfig('eslint', {
+  typescript: false // Force disable even if detected
+})
+```
+
+## CLI Tool
+
+Interactive setup wizard for quick configuration:
+
+```bash
+npx @dimensional-innovations/tool-config
+```
+
+**Features:**
+
+- 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
+- Supports dry-run mode
+
+**Options:**
+
+```bash
+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 --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
+npx @dimensional-innovations/tool-config --help          # Show all options
+```
+
+**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:
+
+```bash
+# Interactive: prompts for provider if not detected
+npx @dimensional-innovations/tool-config --setup-ci
+
+# Direct: specify provider
+npx @dimensional-innovations/tool-config --ci gitlab
+npx @dimensional-innovations/tool-config --ci github
+npx @dimensional-innovations/tool-config --ci bitbucket
+
+# Combined: setup semantic-release + CI/CD
+npx @dimensional-innovations/tool-config semantic-release --ci
+```
+
+The CLI will:
+
+- Auto-detect your git provider (GitLab/GitHub/Bitbucket)
+- Copy the appropriate CI/CD template
+- Show environment variable configuration instructions
+- Guide you through the setup process
+
+## CI/CD Setup
+
+Ready-to-use CI/CD templates for GitLab CI, GitHub Actions, and Bitbucket Pipelines.
+
+### Automated Setup (Recommended)
+
+The CLI tool can automatically setup CI/CD for you:
+
+```bash
+npx @dimensional-innovations/tool-config --ci gitlab  # Or github, bitbucket
+```
+
+This will:
+
+- Auto-detect your git provider
+- Copy the appropriate template
+- Show configuration instructions
+
+### Manual Setup
+
+Alternatively, copy templates manually from [src/tools/semantic-release/templates/](./src/tools/semantic-release/templates/).
+
+Each template includes:
+
+- **Lint Stage** - Runs ESLint, Prettier, and Stylelint
+- **Test Stage** - Runs tests with coverage reporting
+- **Release Stage** - Automated semantic-release (main branch only)
+
+### GitLab CI
+
+```bash
+cp node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/templates/.gitlab-ci.yml .gitlab-ci.yml
+```
+
+Configure these CI/CD variables in GitLab:
+
+- `GL_TOKEN`: GitLab Personal Access Token
+- `NPM_TOKEN`: npm authentication token
+
+### GitHub Actions
+
+```bash
+mkdir -p .github/workflows
+cp node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/templates/github-workflow.yml .github/workflows/ci.yml
+```
+
+Configure these secrets in GitHub:
+
+- `GITHUB_TOKEN`: Automatically provided
+- `NPM_TOKEN`: npm authentication token
+
+### Bitbucket Pipelines
+
+```bash
+cp node_modules/@dimensional-innovations/tool-config/src/tools/semantic-release/templates/bitbucket-pipelines.yml bitbucket-pipelines.yml
+```
+
+Configure this repository variable in Bitbucket:
+
+- `NPM_TOKEN`: npm authentication token
+
+See [CI_SETUP.md](./src/tools/semantic-release/CI_SETUP.md) for detailed configuration instructions.
+
+## Examples
+
+See the [`examples/`](./examples/) directory for complete working examples:
+
+- [React App](./examples/react-app/) - TypeScript, CSS Modules
+- [Vue App](./examples/vue-app/) - Composition API, Scoped Styles
+- [Svelte App](./examples/svelte-app/) - Svelte 5, Component Styles
+- [Solid App](./examples/solid-app/) - TypeScript, Reactive Primitives
+- [Astro App](./examples/astro-app/) - Multi-framework, TypeScript
+- [Angular App](./examples/angular-app/) - TypeScript, Standalone Components
+- [Node Backend](./examples/node-backend/) - Express, TypeScript
+- [Vanilla JS](./examples/vanilla-js/) - Pure JavaScript, no framework
+
+Each example includes all 4 tool configurations and npm scripts.
+
+## Advanced Usage
+
+### Monorepo Support
+
+Use different configs per workspace:
+
+```javascript
+// apps/frontend/eslint.config.js
+export default await createConfig('eslint', {
+  framework: 'react',
+  typescript: true
+})
+
+// apps/backend/eslint.config.js
+export default await createConfig('eslint', {
+  framework: 'node',
+  environment: 'node'
+})
+```
+
+### Custom Ignore Patterns
+
+```javascript
+export default await createConfig('eslint', {
+  ignore: ['dist/**', 'build/**', '**/*.generated.ts']
+})
+```
+
+### Environment-Specific Rules
+
+```javascript
+const isDev = process.env.NODE_ENV === 'development'
+
+export default await createConfig('eslint', {
+  rules: {
+    'no-console': isDev ? 'off' : 'error',
+    'no-debugger': isDev ? 'warn' : 'error'
+  }
+})
+```
+
+### Combining with Other Configs
+
+```javascript
+import { createConfig } from '@dimensional-innovations/tool-config'
+import customRules from './custom-rules.js'
+
+const baseConfig = await createConfig('eslint')
+
+export default [
+  ...baseConfig,
+  {
+    files: ['**/*.js'],
+    rules: customRules
+  }
+]
+```
+
+## Troubleshooting
+
+### ESLint Not Detecting Framework
+
+Ensure your `package.json` includes the framework dependency:
+
+```json
+{
+  "dependencies": {
+    "react": "^18.0.0"
+  }
+}
+```
+
+Or explicitly specify:
+
+```javascript
+export default await createConfig('eslint', {
+  framework: 'react'
+})
+```
+
+### TypeScript Parsing Errors
+
+Make sure `typescript` is installed:
+
+```bash
+npm install --save-dev typescript
+```
+
+### Prettier Plugin Not Found
+
+Install the required peer dependency:
+
+```bash
+npm install --save-dev prettier-plugin-svelte  # For Svelte
+npm install --save-dev prettier-plugin-astro   # For Astro
+```
+
+### Stylelint Not Linting .vue Files
+
+Update your npm script to include `.vue` files:
+
+```json
+{
+  "scripts": {
+    "style": "stylelint '**/*.css' '**/*.vue'"
+  }
+}
+```
+
+### Config Not Updating After Framework Change
+
+Delete `node_modules/.cache` and restart your editor:
+
+```bash
+rm -rf node_modules/.cache
+```
+
+## Requirements
+
+- **Node.js**: >= 22.12.0 (Node.js 22 LTS "Jod")
+- **npm**: >= 10.0.0
+- **ECMAScript**: ES2025 (ESM modules required)
+
+## Philosophy
+
+This package follows these principles:
+
+- **Zero Config by Default** - Works out of the box with sensible defaults
+- **Smart Detection** - Automatically adapts to your project structure
+- **Fail Loudly** - Errors for critical issues, warnings for quality improvements
+- **Framework Agnostic** - No opinions about which framework you use
+- **Modern Standards** - Uses latest tooling and ESLint flat config
+- **Comprehensive Coverage** - 100% test coverage, battle-tested in production
+
+## Contributing
+
+Contributions welcome! This package is built to be extensible.
+
+**To add a new framework:**
+
+1. Add detection logic in `src/detectors.js`
+2. Create presets in `src/tools/{tool}/presets/frameworks/`
+3. Add tests with 100% coverage
+4. Update documentation
+
+See [IMPLEMENTATION_PLAN.md](./IMPLEMENTATION_PLAN.md) for architecture details.
+
+## License
+
+MIT © [DIMENSIONAL INNOVATIONS](https://dimin.com)
+
+## Links
+
+- [npm package](https://www.npmjs.com/package/@dimensional-innovations/tool-config)
+- [GitLab repository](https://gitlab.com/dimensional-innovations/tool-config)
+- [Issue tracker](https://gitlab.com/dimensional-innovations/tool-config/issues)
+- [Changelog](./CHANGELOG.md)
+
+---
+
+**Made with ❤️ by DIMENSIONAL INNOVATIONS**