@dvukovic/style-guide 0.5.2 → 0.6.0

package/dist/cli/generators/cspell.d.ts

@@ -0,0 +1 @@
+export function generateCspellConfig(): string;

package/dist/cli/generators/eslint.d.ts

@@ -0,0 +1 @@
+export function generateESLintConfig(options: any): string;

package/dist/cli/generators/prettier.d.ts

@@ -0,0 +1 @@
+export function generatePrettierConfig(): string;

package/dist/cli/generators/stylelint.d.ts

@@ -0,0 +1 @@
+export function generateStylelintConfig(): string;

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli/init.d.ts

@@ -0,0 +1 @@
+export function runInit(): Promise<void>;

package/dist/cli/prompts.d.ts

@@ -0,0 +1,12 @@
+export function promptToolSelection(): Promise<string[]>;
+export function promptESLintOptions(): Promise<{
+    extras: ("mobx" | "storybook")[];
+    framework: "none" | "react" | "next";
+    includeNode: boolean;
+    isMonorepo: boolean;
+    language: "typescript" | "javascript";
+    strictMode: boolean;
+    testing: ("jest" | "vitest" | "playwright")[];
+}>;
+export function promptOverwrite(filename: any): Promise<boolean>;
+export function promptInstall(packageManager: any, packages: any): Promise<boolean>;

package/dist/cspell/configs/core.d.ts

@@ -0,0 +1,3 @@
+export default config;
+/** @type {import("cspell").FileSettings} */
+declare const config: import("cspell").FileSettings;

package/dist/cspell/index.d.ts

@@ -0,0 +1 @@
+export { default as core, default } from "./configs/core.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dvukovic/style-guide",
-    "version": "0.5.2",
+    "version": "0.6.0",
     "description": "My own style guide",
     "repository": {
         "type": "git",
@@ -12,7 +12,11 @@
     },
     "type": "module",
     "exports": {
-        "./cspell/dictionary.txt": "./src/cspell/dictionary.txt",
+        "./cspell": {
+            "types": "./dist/cspell/index.d.ts",
+            "default": "./src/cspell/index.js"
+        },
+        "./cspell/base.txt": "./src/cspell/base.txt",
         "./eslint": {
             "types": "./dist/eslint/index.d.ts",
             "default": "./src/eslint/index.js"
@@ -26,8 +30,10 @@
             "default": "./src/stylelint/index.js"
         }
     },
+    "bin": "./src/cli/index.js",
     "files": [
         "dist",
+        "src/cli",
         "src/cspell",
         "src/eslint",
         "src/package-json",
@@ -46,6 +52,7 @@
         "test": "vitest run"
     },
     "dependencies": {
+        "@clack/prompts": "0.10.0",
         "@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
         "@eslint/compat": "2.0.0",
         "@eslint/config-helpers": "0.4.2",
@@ -89,6 +96,7 @@
         "typescript-eslint": "8.50.0"
     },
     "devDependencies": {
+        "@dvukovic/style-guide": "0.5.2",
         "@release-it/conventional-changelog": "10.0.4",
         "@types/eslint": "9.6.1",
         "@types/node": "24.10.4",

package/src/cli/generators/cspell.js

@@ -0,0 +1,13 @@
+export function generateCspellConfig() {
+    return `import cspellConfig from "@dvukovic/style-guide/cspell"
+
+/** @type {import("cspell").FileSettings} */
+const config = {
+    ...cspellConfig,
+    ignorePaths: [],
+    ignoreWords: [],
+}
+
+export default config
+`
+}

package/src/cli/generators/eslint.js

@@ -0,0 +1,80 @@
+export function generateESLintConfig(options) {
+    const { extras, framework, includeNode, isMonorepo, language, strictMode, testing } = options
+
+    const imports = ["core", "customDefineConfig"]
+    const configs = ["core()"]
+    const ignores = ["dist", "node_modules"]
+
+    if (language === "typescript") {
+        imports.push("typescript")
+        configs.push("typescript()")
+
+        if (strictMode) {
+            imports.push("typescriptStrict")
+            configs.push("typescriptStrict()")
+        }
+    }
+
+    if (framework === "react") {
+        imports.push("react")
+        configs.push("react()")
+        ignores.push("build")
+    }
+
+    if (framework === "next") {
+        imports.push("next")
+        configs.push("next()")
+        ignores.push(".next", "out")
+    }
+
+    if (includeNode) {
+        imports.push("node")
+        configs.push("node()")
+    }
+
+    if (testing.includes("jest")) {
+        imports.push("jest")
+        configs.push("jest()")
+    }
+
+    if (testing.includes("vitest")) {
+        imports.push("vitest")
+        configs.push("vitest()")
+    }
+
+    if (testing.includes("playwright")) {
+        imports.push("playwright")
+        configs.push("playwright()")
+    }
+
+    if (extras.includes("mobx")) {
+        imports.push("mobx")
+        configs.push("mobx()")
+    }
+
+    if (extras.includes("storybook")) {
+        imports.push("storybook")
+        configs.push("storybook()")
+    }
+
+    if (isMonorepo) {
+        imports.push("packageJsonWorkspace")
+        configs.push("...packageJsonWorkspace()")
+    } else {
+        imports.push("packageJson")
+        configs.push("packageJson()")
+    }
+
+    const importStatement = `import {\n    ${imports.join(",\n    ")},\n} from "@dvukovic/style-guide/eslint"`
+
+    const ignoresArray = `["${ignores.join('", "')}"]`
+    const configsArray = `[\n        ${configs.join(",\n        ")},\n    ]`
+
+    return `${importStatement}
+
+export default customDefineConfig(
+    ${ignoresArray},
+    ${configsArray},
+)
+`
+}

package/src/cli/generators/prettier.js

@@ -0,0 +1,12 @@
+export function generatePrettierConfig() {
+    return `import type { Config } from "prettier"
+
+import prettierConfig from "@dvukovic/style-guide/prettier"
+
+const config: Config = {
+    ...prettierConfig,
+}
+
+export default config
+`
+}

package/src/cli/generators/stylelint.js

@@ -0,0 +1,11 @@
+export function generateStylelintConfig() {
+    return `import stylelintConfig from "@dvukovic/style-guide/stylelint"
+
+/** @type {import("stylelint").Config} */
+const config = {
+    ...stylelintConfig,
+}
+
+export default config
+`
+}

package/src/cli/index.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+import { intro, outro } from "@clack/prompts"
+
+import { runInit } from "./init.js"
+
+const command = process.argv[2]
+
+if (command === "init") {
+    intro("@dvukovic/style-guide")
+    await runInit()
+    outro("Configuration complete!")
+} else {
+    process.stderr.write("Usage: style-guide init\n")
+    process.stderr.write("\n")
+    process.stderr.write("Commands:\n")
+    process.stderr.write("  init    Initialize configuration files\n")
+    // eslint-disable-next-line n/no-process-exit -- CLI entry point
+    process.exit(1)
+}

package/src/cli/init.js

@@ -0,0 +1,171 @@
+import { execSync } from "node:child_process"
+import { existsSync, readFileSync } from "node:fs"
+import { writeFile } from "node:fs/promises"
+
+import * as clack from "@clack/prompts"
+
+import { generateCspellConfig } from "./generators/cspell.js"
+import { generateESLintConfig } from "./generators/eslint.js"
+import { generatePrettierConfig } from "./generators/prettier.js"
+import { generateStylelintConfig } from "./generators/stylelint.js"
+import {
+    promptESLintOptions,
+    promptInstall,
+    promptOverwrite,
+    promptToolSelection,
+} from "./prompts.js"
+
+const TOOL_PACKAGES = {
+    cspell: "cspell",
+    eslint: "eslint",
+    prettier: "prettier",
+    stylelint: "stylelint",
+}
+
+function detectPackageManager() {
+    if (existsSync("pnpm-lock.yaml")) {
+        return "pnpm"
+    }
+
+    if (existsSync("yarn.lock")) {
+        return "yarn"
+    }
+
+    if (existsSync("bun.lockb")) {
+        return "bun"
+    }
+
+    return "npm"
+}
+
+function getInstalledPackages() {
+    try {
+        const packageJson = JSON.parse(readFileSync("package.json", "utf8"))
+
+        return {
+            ...packageJson.dependencies,
+            ...packageJson.devDependencies,
+        }
+    } catch {
+        return {}
+    }
+}
+
+function getMissingPackages(tools) {
+    const installed = getInstalledPackages()
+    const missing = []
+
+    if (!("@dvukovic/style-guide" in installed)) {
+        missing.push("@dvukovic/style-guide")
+    }
+
+    for (const tool of tools) {
+        const packageName = TOOL_PACKAGES[tool]
+
+        if (packageName && !(packageName in installed)) {
+            missing.push(packageName)
+        }
+    }
+
+    return missing
+}
+
+async function installPackages(tools) {
+    const missingPackages = getMissingPackages(tools)
+
+    if (missingPackages.length === 0) {
+        return
+    }
+
+    const packageManager = detectPackageManager()
+    const shouldInstall = await promptInstall(packageManager, missingPackages)
+
+    if (!shouldInstall) {
+        return
+    }
+
+    const packages = missingPackages.join(" ")
+    const installCmd =
+        packageManager === "npm"
+            ? `npm install -D ${packages}`
+            : `${packageManager} add -D ${packages}`
+
+    const spinner = clack.spinner()
+
+    spinner.start("Installing packages")
+
+    try {
+        // eslint-disable-next-line sonarjs/os-command -- User-confirmed install command
+        execSync(installCmd, { stdio: "pipe" })
+        spinner.stop("Packages installed")
+    } catch {
+        spinner.stop("Failed to install. Please run manually:")
+        clack.log.info(`  ${installCmd}`)
+    }
+}
+
+async function writeConfigFile(filename, content) {
+    if (existsSync(filename)) {
+        const overwrite = await promptOverwrite(filename)
+
+        if (!overwrite) {
+            clack.log.info(`Skipped ${filename}`)
+
+            return false
+        }
+    }
+
+    await writeFile(filename, content)
+    clack.log.success(`Created ${filename}`)
+
+    return true
+}
+
+export async function runInit() {
+    const tools = await promptToolSelection()
+
+    let eslintOptions = null
+
+    if (tools.includes("eslint")) {
+        eslintOptions = await promptESLintOptions()
+    }
+
+    await installPackages(tools)
+
+    const spinner = clack.spinner()
+
+    spinner.start("Generating configuration files")
+
+    const results = []
+
+    if (tools.includes("eslint") && eslintOptions) {
+        const content = generateESLintConfig(eslintOptions)
+
+        results.push({ content, filename: "eslint.config.js" })
+    }
+
+    if (tools.includes("prettier")) {
+        const content = generatePrettierConfig()
+
+        results.push({ content, filename: "prettier.config.ts" })
+    }
+
+    if (tools.includes("stylelint")) {
+        const content = generateStylelintConfig()
+
+        results.push({ content, filename: "stylelint.config.js" })
+    }
+
+    if (tools.includes("cspell")) {
+        const content = generateCspellConfig()
+
+        results.push({ content, filename: "cspell.config.js" })
+    }
+
+    spinner.stop("Configuration files generated")
+
+    for (const { content, filename } of results) {
+        // eslint-disable-next-line no-await-in-loop -- Sequential writes for user feedback
+        await writeConfigFile(filename, content)
+    }
+}

package/src/cli/prompts.js

@@ -0,0 +1,182 @@
+import * as clack from "@clack/prompts"
+
+class SetupCancelledError extends Error {
+    constructor() {
+        super("Setup cancelled.")
+        this.name = "SetupCancelledError"
+    }
+}
+
+export async function promptToolSelection() {
+    const tools = await clack.multiselect({
+        initialValues: ["eslint", "prettier"],
+        message: "Which tools would you like to configure?",
+        options: [
+            { label: "ESLint", value: "eslint" },
+            { label: "Prettier", value: "prettier" },
+            { label: "Stylelint", value: "stylelint" },
+            { label: "CSpell", value: "cspell" },
+        ],
+        required: true,
+    })
+
+    if (clack.isCancel(tools)) {
+        clack.cancel("Setup cancelled.")
+
+        throw new SetupCancelledError()
+    }
+
+    return tools
+}
+
+export async function promptESLintOptions() {
+    const language = await clack.select({
+        message: "Which language are you using?",
+        options: [
+            { label: "TypeScript", value: "typescript" },
+            { label: "JavaScript only", value: "javascript" },
+        ],
+    })
+
+    if (clack.isCancel(language)) {
+        clack.cancel("Setup cancelled.")
+
+        throw new SetupCancelledError()
+    }
+
+    let strictMode = false
+
+    if (language === "typescript") {
+        const strict = await clack.select({
+            message: "TypeScript strictness level?",
+            options: [
+                { label: "Standard", value: "standard" },
+                { label: "Strict (additional type-checked rules)", value: "strict" },
+            ],
+        })
+
+        if (clack.isCancel(strict)) {
+            clack.cancel("Setup cancelled.")
+
+            throw new SetupCancelledError()
+        }
+
+        strictMode = strict === "strict"
+    }
+
+    const framework = await clack.select({
+        message: "Which framework are you using?",
+        options: [
+            { label: "None (Node.js)", value: "none" },
+            { label: "React", value: "react" },
+            { label: "Next.js", value: "next" },
+        ],
+    })
+
+    if (clack.isCancel(framework)) {
+        clack.cancel("Setup cancelled.")
+
+        throw new SetupCancelledError()
+    }
+
+    let includeNode = framework === "none"
+
+    if (framework !== "none") {
+        const nodeBackend = await clack.confirm({
+            initialValue: false,
+            message: "Do you have a Node.js backend?",
+        })
+
+        if (clack.isCancel(nodeBackend)) {
+            clack.cancel("Setup cancelled.")
+
+            throw new SetupCancelledError()
+        }
+
+        includeNode = nodeBackend
+    }
+
+    const testing = await clack.multiselect({
+        message: "Which testing frameworks do you use?",
+        options: [
+            { label: "Jest", value: "jest" },
+            { label: "Vitest", value: "vitest" },
+            { label: "Playwright", value: "playwright" },
+        ],
+        required: false,
+    })
+
+    if (clack.isCancel(testing)) {
+        clack.cancel("Setup cancelled.")
+
+        throw new SetupCancelledError()
+    }
+
+    const extras = await clack.multiselect({
+        message: "Any additional configurations?",
+        options: [
+            { label: "MobX", value: "mobx" },
+            { label: "Storybook", value: "storybook" },
+        ],
+        required: false,
+    })
+
+    if (clack.isCancel(extras)) {
+        clack.cancel("Setup cancelled.")
+
+        throw new SetupCancelledError()
+    }
+
+    const monorepo = await clack.confirm({
+        initialValue: false,
+        message: "Is this a monorepo?",
+    })
+
+    if (clack.isCancel(monorepo)) {
+        clack.cancel("Setup cancelled.")
+
+        throw new SetupCancelledError()
+    }
+
+    const isMonorepo = monorepo
+
+    return {
+        extras,
+        framework,
+        includeNode,
+        isMonorepo,
+        language,
+        strictMode,
+        testing,
+    }
+}
+
+export async function promptOverwrite(filename) {
+    const overwrite = await clack.confirm({
+        initialValue: false,
+        message: `${filename} already exists. Overwrite?`,
+    })
+
+    if (clack.isCancel(overwrite)) {
+        clack.cancel("Setup cancelled.")
+
+        throw new SetupCancelledError()
+    }
+
+    return overwrite
+}
+
+export async function promptInstall(packageManager, packages) {
+    const packageList = packages.join(", ")
+
+    const install = await clack.confirm({
+        initialValue: true,
+        message: `Install ${packageList} using ${packageManager}?`,
+    })
+
+    if (clack.isCancel(install)) {
+        return false
+    }
+
+    return install
+}

package/src/cspell/configs/core.js

@@ -0,0 +1,18 @@
+/** @type {import("cspell").FileSettings} */
+const config = {
+    cache: {
+        cacheLocation: "./node_modules/.cache/cspell",
+        useCache: true,
+    },
+    caseSensitive: false,
+    dictionaries: ["shared"],
+    dictionaryDefinitions: [
+        {
+            name: "shared",
+            path: "./node_modules/@dvukovic/style-guide/cspell/base.txt",
+        },
+    ],
+    useGitignore: true,
+}
+
+export default config

package/src/cspell/index.js

@@ -0,0 +1 @@
+export { default as core, default } from "./configs/core.js"