@dimensional-innovations/tool-config 5.0.0 → 5.0.1

package/dist/index.d.ts

@@ -0,0 +1,401 @@
+/**
+ * Shared type definitions for @dimensional-innovations/tool-config
+ */
+type ToolName = 'eslint' | 'prettier' | 'stylelint' | 'typescript' | 'semantic-release';
+type Framework = 'react' | 'vue' | 'svelte' | 'solid' | 'astro' | 'angular' | 'vanilla' | 'node' | 'auto';
+type ResolvedFramework = Exclude<Framework, 'auto'>;
+type Environment = 'browser' | 'node' | 'universal' | 'auto';
+type ResolvedEnvironment = Exclude<Environment, 'auto'>;
+type GitProvider = 'gitlab' | 'github' | 'bitbucket' | null;
+type CssPreprocessor = 'scss' | 'sass' | 'less' | null;
+interface CssTypeResult {
+    preprocessor: CssPreprocessor;
+    tailwind: boolean;
+    modules: boolean;
+    postcss: boolean;
+}
+interface DetectionResult {
+    framework: ResolvedFramework;
+    environment: ResolvedEnvironment;
+    typescript: boolean;
+    gitProvider: GitProvider;
+    cssType: CssTypeResult;
+    electron: boolean;
+}
+interface PackageJson {
+    name?: string;
+    version?: string;
+    type?: 'module' | 'commonjs';
+    main?: string;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    peerDependencies?: Record<string, string>;
+    repository?: string | {
+        type?: string;
+        url?: string;
+    };
+    scripts?: Record<string, string>;
+}
+interface BaseOptions {
+    framework?: Framework;
+    environment?: Environment;
+    cwd?: string;
+    customIgnores?: string[];
+}
+interface EslintOptions extends BaseOptions {
+    typescript?: boolean | 'auto';
+    ignorePaths?: string[];
+    rules?: Record<string, unknown>;
+}
+interface PrettierOptions extends BaseOptions {
+    [key: string]: unknown;
+}
+interface StylelintOptions extends BaseOptions {
+    cssType?: CssTypeResult | 'auto';
+    rules?: Record<string, unknown>;
+    extends?: string | string[];
+    overrides?: unknown[];
+}
+interface TypescriptOptions extends BaseOptions {
+    checker?: 'modern' | 'legacy' | 'auto';
+    strict?: boolean;
+    electron?: boolean;
+    renderer?: ResolvedFramework;
+    compilerOptions?: Record<string, unknown>;
+}
+type ReleasePreset = 'default' | 'library' | 'monorepo';
+interface SemanticReleaseOptions extends BaseOptions {
+    preset?: ReleasePreset;
+    gitProvider?: GitProvider | 'auto';
+    branches?: unknown[];
+    plugins?: unknown[];
+}
+type ToolOptions = EslintOptions | PrettierOptions | StylelintOptions | TypescriptOptions | SemanticReleaseOptions;
+type TypeChecker = 'tsgo' | 'vue-tsc' | 'tsc';
+type TypeCheckerPreference = 'modern' | 'legacy' | 'auto';
+interface ConfigMeta {
+    framework: ResolvedFramework;
+    environment?: ResolvedEnvironment;
+    checker?: TypeChecker;
+    experimental?: boolean;
+    renderer?: ResolvedFramework;
+    multiConfig?: boolean;
+    generatedBy?: string;
+}
+interface EslintFlatConfig {
+    name?: string;
+    files?: string[];
+    ignores?: string[];
+    languageOptions?: Record<string, unknown>;
+    plugins?: Record<string, unknown>;
+    rules?: Record<string, unknown>;
+    settings?: Record<string, unknown>;
+    processor?: unknown;
+}
+interface PrettierConfig {
+    printWidth?: number;
+    tabWidth?: number;
+    useTabs?: boolean;
+    semi?: boolean;
+    singleQuote?: boolean;
+    quoteProps?: 'as-needed' | 'consistent' | 'preserve';
+    jsxSingleQuote?: boolean;
+    trailingComma?: 'none' | 'es5' | 'all';
+    bracketSpacing?: boolean;
+    bracketSameLine?: boolean;
+    arrowParens?: 'avoid' | 'always';
+    proseWrap?: 'always' | 'never' | 'preserve';
+    htmlWhitespaceSensitivity?: 'css' | 'strict' | 'ignore';
+    endOfLine?: 'auto' | 'lf' | 'crlf' | 'cr';
+    singleAttributePerLine?: boolean;
+    plugins?: string[];
+    overrides?: Array<{
+        files: string | string[];
+        options?: Record<string, unknown>;
+    }>;
+    [key: string]: unknown;
+}
+interface StylelintConfig {
+    extends?: string | string[];
+    plugins?: string[];
+    rules?: Record<string, unknown>;
+    overrides?: Array<{
+        files: string[];
+        rules?: Record<string, unknown>;
+        customSyntax?: string;
+    }>;
+    ignoreFiles?: string[];
+    customSyntax?: string;
+    [key: string]: unknown;
+}
+interface TypescriptConfig {
+    $schema?: string;
+    files?: string[];
+    compilerOptions?: Record<string, unknown>;
+    include?: string[];
+    exclude?: string[];
+    references?: Array<{
+        path: string;
+    }>;
+    _meta?: ConfigMeta;
+}
+interface ElectronMultiConfig {
+    root: TypescriptConfig;
+    node: TypescriptConfig;
+    web: TypescriptConfig;
+    tests: TypescriptConfig;
+    _meta?: ConfigMeta;
+}
+interface SemanticReleaseConfig {
+    branches?: unknown[];
+    plugins?: unknown[];
+    tagFormat?: string;
+    ci?: boolean;
+    _meta?: {
+        preset: ReleasePreset;
+        gitProvider: GitProvider;
+    };
+    [key: string]: unknown;
+}
+declare class ConfigError extends Error {
+    readonly context?: Record<string, unknown>;
+    constructor(message: string, context?: Record<string, unknown>);
+}
+
+/**
+ * Create an ESLint flat config
+ *
+ * Supports: React, Vue.js, Svelte, Solid, Astro, Angular, Vanilla JS/TS, and auto-detection
+ *
+ * @param options - Configuration options
+ * @returns ESLint flat config array
+ *
+ * @example
+ * // Zero config - auto-detects everything
+ * import { createEslintConfig } from '@dimensional-innovations/tool-config';
+ * export default await createEslintConfig();
+ *
+ * @example
+ * // Explicit configuration
+ * import { createEslintConfig } from '@dimensional-innovations/tool-config';
+ * export default await createEslintConfig({
+ *   framework: 'react',
+ *   environment: 'browser',
+ *   typescript: true
+ * });
+ *
+ * @example
+ * // With custom rules
+ * import { createEslintConfig } from '@dimensional-innovations/tool-config';
+ * export default await createEslintConfig({
+ *   rules: {
+ *     'no-console': 'off'
+ *   }
+ * });
+ */
+declare function createEslintConfig(options?: EslintOptions): Promise<EslintFlatConfig[]>;
+
+/**
+ * Prettier configuration factory
+ *
+ * Creates Prettier configurations with framework-aware defaults and auto-detection.
+ */
+
+/**
+ * Create a Prettier configuration
+ *
+ * @param options - Configuration options
+ * @returns Prettier configuration object
+ *
+ * @example
+ * // Auto-detect framework
+ * export default await createPrettierConfig();
+ *
+ * @example
+ * // Explicit framework
+ * export default await createPrettierConfig({ framework: 'vue' });
+ *
+ * @example
+ * // With overrides
+ * export default await createPrettierConfig({
+ *   framework: 'react',
+ *   printWidth: 120,
+ *   semi: true
+ * });
+ */
+declare function createPrettierConfig(options?: PrettierOptions): Promise<PrettierConfig>;
+
+/**
+ * Stylelint configuration factory
+ *
+ * Creates Stylelint configurations with framework-aware defaults for CSS linting.
+ *
+ * Note: Stylelint is for CSS files and component styles (Vue, Svelte).
+ * CSS-in-JS (React styled-components, emotion) should use ESLint plugins instead.
+ */
+
+/**
+ * Create a Stylelint configuration
+ *
+ * @param options - Configuration options
+ * @returns Stylelint configuration object
+ *
+ * @example
+ * // Auto-detect framework
+ * export default await createStylelintConfig();
+ *
+ * @example
+ * // Explicit framework
+ * export default await createStylelintConfig({ framework: 'vue' });
+ *
+ * @example
+ * // Explicit CSS type
+ * export default await createStylelintConfig({ cssType: 'scss' });
+ *
+ * @example
+ * // With overrides
+ * export default await createStylelintConfig({
+ *   framework: 'vue',
+ *   cssType: 'scss',
+ *   rules: {
+ *     'color-hex-length': 'long'
+ *   }
+ * });
+ */
+declare function createStylelintConfig(options?: StylelintOptions): Promise<StylelintConfig>;
+
+/**
+ * semantic-release configuration factory
+ *
+ * Creates semantic-release configurations with preset-based defaults.
+ * Supports standard releases, library publishing, and monorepo structures.
+ * Auto-detects Git provider (GitLab, GitHub, Bitbucket) from repository URL.
+ */
+
+/**
+ * Create a semantic-release configuration
+ *
+ * @example
+ * // Use default preset with auto-detected Git provider
+ * export default await createReleaseConfig();
+ *
+ * @example
+ * // Use library preset with auto-detected Git provider
+ * export default await createReleaseConfig({ preset: 'library' });
+ *
+ * @example
+ * // Explicitly specify Git provider
+ * export default await createReleaseConfig({
+ *   preset: 'default',
+ *   gitProvider: 'github'
+ * });
+ *
+ * @example
+ * // Disable Git provider plugin
+ * export default await createReleaseConfig({
+ *   preset: 'default',
+ *   gitProvider: null
+ * });
+ *
+ * @example
+ * // With custom branches
+ * export default await createReleaseConfig({
+ *   preset: 'default',
+ *   branches: ['main', 'next']
+ * });
+ *
+ * @example
+ * // With plugin overrides
+ * export default await createReleaseConfig({
+ *   preset: 'library',
+ *   plugins: [
+ *     '@semantic-release/commit-analyzer',
+ *     '@semantic-release/release-notes-generator',
+ *     '@semantic-release/npm'
+ *   ]
+ * });
+ */
+declare function createReleaseConfig(options?: SemanticReleaseOptions): Promise<SemanticReleaseConfig>;
+
+/**
+ * Create TypeScript configuration with auto-detection
+ *
+ * @param options - Configuration options
+ * @returns TypeScript configuration object
+ *
+ * @example
+ * // Auto-detect framework
+ * export default await createTypescriptConfig();
+ *
+ * @example
+ * // Explicit framework
+ * export default await createTypescriptConfig({ framework: 'react' });
+ *
+ * @example
+ * // With custom compiler options
+ * export default await createTypescriptConfig({
+ *   framework: 'react',
+ *   compilerOptions: { outDir: './build' }
+ * });
+ */
+declare function createTypescriptConfig(options?: TypescriptOptions): Promise<TypescriptConfig | ElectronMultiConfig>;
+
+/**
+ * Detect the framework being used in the project
+ * @param cwd - Current working directory
+ * @returns Detected framework name
+ */
+declare function detectFramework(cwd?: string): ResolvedFramework;
+/**
+ * Detect the environment (browser, node, or universal)
+ * @param framework - Detected framework
+ * @param cwd - Current working directory
+ * @returns Environment type
+ */
+declare function detectEnvironment(framework: ResolvedFramework, cwd?: string): ResolvedEnvironment;
+/**
+ * Detect if TypeScript is being used
+ * @param cwd - Current working directory
+ * @returns True if TypeScript is detected
+ */
+declare function detectTypeScript(cwd?: string): boolean;
+/**
+ * Detect Git provider from repository URL
+ * @param cwd - Current working directory
+ * @returns Git provider ('gitlab', 'github', 'bitbucket', or null)
+ */
+declare function detectGitProvider(cwd?: string): GitProvider;
+/**
+ * Detect CSS type and variants
+ * @param cwd - Current working directory
+ * @returns CSS type detection results
+ */
+declare function detectCssType(cwd?: string): CssTypeResult;
+/**
+ * Detect if project is an Electron application
+ * @param cwd - Current working directory
+ * @returns True if Electron project detected
+ */
+declare function detectElectron(cwd?: string): boolean;
+/**
+ * Auto-detect all configuration options
+ * @param cwd - Current working directory
+ * @returns Detected configuration
+ */
+declare function autoDetect(cwd?: string): DetectionResult;
+
+/**
+ * @dimensional-innovations/tool-config
+ * Universal configuration package for development tools
+ *
+ * Supports: ESLint, Prettier, Stylelint, semantic-release, TypeScript
+ * Auto-detects: React, Vue, Svelte, Solid, Astro, Angular, Vanilla JS, Node.js
+ */
+
+declare function createConfig(tool: 'eslint', options?: EslintOptions): Promise<EslintFlatConfig[]>;
+declare function createConfig(tool: 'prettier', options?: PrettierOptions): Promise<PrettierConfig>;
+declare function createConfig(tool: 'stylelint', options?: StylelintOptions): Promise<StylelintConfig>;
+declare function createConfig(tool: 'typescript', options?: TypescriptOptions): Promise<TypescriptConfig>;
+declare function createConfig(tool: 'semantic-release', options?: SemanticReleaseOptions): Promise<SemanticReleaseConfig>;
+
+export { type BaseOptions, ConfigError, type ConfigMeta, type CssPreprocessor, type CssTypeResult, type DetectionResult, type Environment, type EslintFlatConfig, type EslintOptions, type Framework, type GitProvider, type PackageJson, type PrettierConfig, type PrettierOptions, type ReleasePreset, type ResolvedEnvironment, type ResolvedFramework, type SemanticReleaseConfig, type SemanticReleaseOptions, type StylelintConfig, type StylelintOptions, type ToolName, type ToolOptions, type TypeChecker, type TypeCheckerPreference, type TypescriptConfig, type TypescriptOptions, autoDetect, createConfig, createEslintConfig, createPrettierConfig, createReleaseConfig, createStylelintConfig, createTypescriptConfig, detectCssType, detectElectron, detectEnvironment, detectFramework, detectGitProvider, detectTypeScript };