@dvukovic/style-guide 0.6.0 → 0.8.0

package/README.md

@@ -1,50 +1,61 @@
 # @dvukovic/style-guide
 
-Personal style guide with ESLint, Prettier, and other code quality tools
+Personal style guide with ESLint, Prettier, Stylelint, and CSpell configurations.
 
-## Installation
+## Quick Start
 
 ```bash
-yarn add -D @dvukovic/style-guide eslint prettier cspell stylelint
+npx @dvukovic/style-guide@latest init
 ```
 
-## ESLint Configuration
+This interactive CLI will:
 
-### Basic Usage
+- Let you select which tools to configure (ESLint, Prettier, Stylelint, CSpell)
+- Ask about your project setup (TypeScript, React/Next.js, testing frameworks)
+- Install required dependencies
+- Generate configuration files
 
-Create an `eslint.config.js` file in your project root:
+## Manual Installation
+
+```bash
+yarn add -D @dvukovic/style-guide eslint prettier stylelint cspell knip
+```
+
+## ESLint
+
+Create `eslint.config.js`:
 
 ```js
 import { customDefineConfig, core, typescript } from "@dvukovic/style-guide/eslint"
 
-export default customDefineConfig(["dist/**", "build/**"], [core(), typescript()])
+export default customDefineConfig(["dist", "build"], [core(), typescript()])
 ```
 
 ### Available Configs
 
-Each config is a factory function that returns ESLint configuration:
-
 - `core()` - Essential rules for all JavaScript/TypeScript projects
-- `node()` - Node.js specific rules
-- `react()` - React framework rules
 - `typescript()` - TypeScript parser and rules
 - `typescriptStrict()` - Additional strict TypeScript rules
+- `react()` - React framework rules
+- `next()` - Next.js framework
+- `node()` - Node.js specific rules
 - `jest()` - Jest testing framework
 - `vitest()` - Vitest testing framework
 - `playwright()` - Playwright e2e testing
 - `mobx()` - MobX state management
-- `next()` - Next.js framework
 - `storybook()` - Storybook
+- `packageJson()` - package.json linting
+- `packageJsonWorkspace()` - package.json linting for monorepos
 
 ### Customizing Configs
 
-Each factory function accepts a `config` parameter to extend or override settings:
+Each factory function accepts a config parameter to extend or override settings:
 
 ```js
 import { customDefineConfig, core, typescript } from "@dvukovic/style-guide/eslint"
 
 export default customDefineConfig(
-    [],
+    ["dist"],
     [
         core(),
         typescript({
@@ -56,105 +67,87 @@ export default customDefineConfig(
 )
 ```
 
-### Scripts
+## Prettier
 
-Add these scripts to your `package.json`:
+Create `prettier.config.ts`:
 
-```json
-{
-    "scripts": {
-        "lint": "yarn lint:eslint && yarn lint:prettier && yarn lint:stylelint && yarn lint:spell",
-        "lint:eslint": "eslint . --cache --concurrency=auto",
-        "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix && yarn lint:spell",
-        "lint:prettier": "prettier --check --cache .",
-        "lint:spell": "cspell --no-progress --no-summary --unique '**'",
-        "lint:stylelint": "stylelint ./**/*.css --cache",
-        "test": "vitest run"
-    }
+```ts
+import type { Config } from "prettier"
+
+import { core } from "@dvukovic/style-guide/prettier"
+
+const config: Config = {
+    ...core,
 }
+
+export default config
 ```
 
-### Complete Example
+## Stylelint
 
-A full-featured project (this is the actual config used by this package):
+Create `stylelint.config.js`:
 
 ```js
-import {
-    customDefineConfig,
-    core,
-    node,
-    mobx,
-    react,
-    next,
-    typescript,
-    typescriptStrict,
-    jest,
-    vitest,
-    playwright,
-} from "@dvukovic/style-guide/eslint"
+import stylelintConfig from "@dvukovic/style-guide/stylelint"
 
-export default customDefineConfig(
-    ["node_modules"],
-    [
-        core(),
-        node(),
-        mobx(),
-        react(),
-        next(),
-        typescript(),
-        typescriptStrict(),
-        jest(),
-        vitest(),
-        playwright(),
-    ],
-)
+/** @type {import("stylelint").Config} */
+const config = {
+    ...stylelintConfig,
+}
+
+export default config
 ```
 
-## Prettier Configuration
+## CSpell
 
-```js prettier.config.ts
-import type { Config } from "prettier"
+Create `cspell.config.js`:
 
-import core from "@dvukovic/style-guide/src/prettier/configs/core.js"
+```js
+import { core } from "@dvukovic/style-guide/cspell"
 
-const config: Config = {
+/** @type {import("cspell").FileSettings} */
+const config = {
     ...core,
+    ignorePaths: [...core.ignorePaths],
+    ignoreWords: [],
 }
 
 export default config
 ```
 
-## Stylelint Configuration
+## Knip
 
-```js stylelint.config.js
-/** @type {import("stylelint").Config} */
-module.exports = {
-    extends: "@dvukovic/style-guide/src/stylelint/configs/core",
-    allowEmptyInput: true,
+Create `knip.config.ts`:
+
+```ts
+import type { KnipConfig } from "knip"
+
+import { core } from "@dvukovic/style-guide/knip"
+
+const config: KnipConfig = {
+    ...core,
+    ignore: [],
+    ignoreDependencies: [...core.ignoreDependencies],
 }
+
+export default config
 ```
 
-## Cspell Configuration
+## Scripts
 
-```cspell.config.js
-/** @type {import("cspell").FileSettings} */
-module.exports = {
-    cache: {
-        cacheLocation: "./node_modules/.cache/cspell",
-        useCache: true,
-    },
-    caseSensitive: false,
-    ignorePaths: [],
-    dictionaries: ["shared"],
-    dictionaryDefinitions: [
-        {
-            name: "shared",
-            path: "./node_modules/@dvukovic/style-guide/src/cspell/base.txt",
-        },
-    ],
-    useGitignore: true,
-    ignoreWords: [
-    ],
+Add to your `package.json`:
+
+```json
+{
+    "scripts": {
+        "lint": "yarn lint:eslint && yarn lint:prettier && yarn lint:stylelint && yarn lint:cspell && yarn lint:knip",
+        "lint:eslint": "eslint . --cache --concurrency=auto",
+        "lint:prettier": "prettier --check --cache .",
+        "lint:stylelint": "stylelint ./**/*.css --cache",
+        "lint:cspell": "cspell --no-progress --no-summary --unique '**'",
+        "lint:knip": "knip",
+        "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix"
+    }
 }
 ```
 

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

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

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

@@ -0,0 +1,9 @@
+export function generateScripts(tools: any, packageManager: any): {
+    "lint:eslint": string;
+    "lint:prettier": string;
+    "lint:stylelint": string;
+    "lint:cspell": string;
+    "lint:knip": string;
+    lint: string;
+    "lint:fix": string;
+};

package/dist/cspell/index.d.ts

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

package/dist/eslint/rules/no-commented-out-code/no-commented-out-code.utils.d.ts

@@ -1,4 +1,3 @@
-export function isExpressionOrIdentifierOrLiteral(node: any): any;
 export function hasEmptyBody(program: any): boolean;
 export function hasExpressionBody(program: any): any;
 export function hasLabeledStatementBody(program: any): boolean;

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

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

package/dist/knip/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dvukovic/style-guide",
-    "version": "0.6.0",
+    "version": "0.8.0",
     "description": "My own style guide",
     "repository": {
         "type": "git",
@@ -21,6 +21,10 @@
             "types": "./dist/eslint/index.d.ts",
             "default": "./src/eslint/index.js"
         },
+        "./knip": {
+            "types": "./src/knip/index.d.ts",
+            "default": "./src/knip/index.js"
+        },
         "./prettier": {
             "types": "./dist/prettier/index.d.ts",
             "default": "./src/prettier/index.js"
@@ -36,16 +40,18 @@
         "src/cli",
         "src/cspell",
         "src/eslint",
+        "src/knip",
         "src/package-json",
         "src/prettier",
         "src/stylelint"
     ],
     "scripts": {
         "build": "tsc",
-        "lint": "yarn lint:eslint && yarn lint:prettier && yarn lint:stylelint && yarn lint:cspell",
+        "lint": "yarn lint:eslint && yarn lint:prettier && yarn lint:stylelint && yarn lint:cspell && yarn lint:knip",
         "lint:cspell": "cspell --no-progress --no-summary --unique '**'",
         "lint:eslint": "eslint . --cache --concurrency=auto",
-        "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix && yarn lint:cspell",
+        "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write && yarn lint:stylelint --fix && yarn lint:cspell && yarn lint:knip",
+        "lint:knip": "knip",
         "lint:prettier": "prettier --check --cache .",
         "lint:stylelint": "stylelint ./**/*.css --cache",
         "release": "release-it",
@@ -54,10 +60,8 @@
     "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",
         "@next/eslint-plugin-next": "16.1.0",
-        "@prettier/plugin-xml": "3.4.2",
         "@rimac-technology/eslint-plugin": "1.5.0",
         "@stylistic/eslint-plugin": "5.6.1",
         "@typescript-eslint/parser": "8.50.0",
@@ -96,12 +100,11 @@
         "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",
         "cspell": "9.4.0",
         "eslint": "9.39.2",
+        "knip": "5.82.1",
         "prettier": "3.7.4",
         "release-it": "19.1.0",
         "stylelint": "16.26.1",
@@ -111,6 +114,7 @@
     "peerDependencies": {
         "cspell": "9",
         "eslint": "^9",
+        "knip": "5",
         "prettier": "3",
         "stylelint": "16"
     },
@@ -121,6 +125,9 @@
         "eslint": {
             "optional": true
         },
+        "knip": {
+            "optional": true
+        },
         "prettier": {
             "optional": true
         },

package/src/cli/generators/cspell.js

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

package/src/cli/generators/knip.js

@@ -0,0 +1,14 @@
+export function generateKnipConfig() {
+    return `import type { KnipConfig } from "knip"
+
+import { core } from "@dvukovic/style-guide/knip"
+
+const config: KnipConfig = {
+    ...core,
+    ignore: [],
+    ignoreDependencies: [...core.ignoreDependencies],
+}
+
+export default config
+`
+}

package/src/cli/generators/prettier.js

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

package/src/cli/generators/scripts.js

@@ -0,0 +1,45 @@
+export function generateScripts(tools, packageManager) {
+    const runner = packageManager === "npm" ? "npm run" : packageManager
+
+    const scripts = {}
+    const lintParts = []
+    const fixParts = []
+
+    if (tools.includes("eslint")) {
+        scripts["lint:eslint"] = "eslint . --cache --concurrency=auto"
+        lintParts.push(`${runner} lint:eslint`)
+        fixParts.push(`${runner} lint:eslint --fix`)
+    }
+
+    if (tools.includes("prettier")) {
+        scripts["lint:prettier"] = "prettier --check --cache ."
+        lintParts.push(`${runner} lint:prettier`)
+        fixParts.push(`${runner} lint:prettier --write`)
+    }
+
+    if (tools.includes("stylelint")) {
+        scripts["lint:stylelint"] = "stylelint ./**/*.css --cache"
+        lintParts.push(`${runner} lint:stylelint`)
+        fixParts.push(`${runner} lint:stylelint --fix`)
+    }
+
+    if (tools.includes("cspell")) {
+        scripts["lint:cspell"] = "cspell --no-progress --no-summary --unique '**'"
+        lintParts.push(`${runner} lint:cspell`)
+    }
+
+    if (tools.includes("knip")) {
+        scripts["lint:knip"] = "knip"
+        lintParts.push(`${runner} lint:knip`)
+    }
+
+    if (lintParts.length > 0) {
+        scripts.lint = lintParts.join(" && ")
+    }
+
+    if (fixParts.length > 0) {
+        scripts["lint:fix"] = fixParts.join(" && ")
+    }
+
+    return scripts
+}

package/src/cli/init.js

@@ -6,7 +6,9 @@ import * as clack from "@clack/prompts"
 
 import { generateCspellConfig } from "./generators/cspell.js"
 import { generateESLintConfig } from "./generators/eslint.js"
+import { generateKnipConfig } from "./generators/knip.js"
 import { generatePrettierConfig } from "./generators/prettier.js"
+import { generateScripts } from "./generators/scripts.js"
 import { generateStylelintConfig } from "./generators/stylelint.js"
 import {
     promptESLintOptions,
@@ -18,6 +20,7 @@ import {
 const TOOL_PACKAGES = {
     cspell: "cspell",
     eslint: "eslint",
+    knip: "knip",
     prettier: "prettier",
     stylelint: "stylelint",
 }
@@ -70,14 +73,13 @@ function getMissingPackages(tools) {
     return missing
 }
 
-async function installPackages(tools) {
+async function installPackages(tools, packageManager) {
     const missingPackages = getMissingPackages(tools)
 
     if (missingPackages.length === 0) {
         return
     }
 
-    const packageManager = detectPackageManager()
     const shouldInstall = await promptInstall(packageManager, missingPackages)
 
     if (!shouldInstall) {
@@ -111,14 +113,46 @@ async function writeConfigFile(filename, content) {
         if (!overwrite) {
             clack.log.info(`Skipped ${filename}`)
 
-            return false
+            return
         }
     }
 
     await writeFile(filename, content)
     clack.log.success(`Created ${filename}`)
+}
+
+async function updatePackageJsonScripts(tools, packageManager) {
+    const scripts = generateScripts(tools, packageManager)
+
+    if (Object.keys(scripts).length === 0) {
+        return
+    }
+
+    try {
+        const packageJsonContent = readFileSync("package.json", "utf8")
+        const packageJson = JSON.parse(packageJsonContent)
+
+        packageJson.scripts = {
+            ...packageJson.scripts,
+            ...scripts,
+        }
+
+        const sortedKeys = Object.keys(packageJson.scripts).sort((left, right) => {
+            return left.localeCompare(right)
+        })
+        const sortedScripts = {}
 
-    return true
+        for (const key of sortedKeys) {
+            sortedScripts[key] = packageJson.scripts[key]
+        }
+
+        packageJson.scripts = sortedScripts
+
+        await writeFile("package.json", `${JSON.stringify(packageJson, null, 4)}\n`)
+        clack.log.success("Added scripts to package.json")
+    } catch {
+        clack.log.error("Failed to update package.json scripts")
+    }
 }
 
 export async function runInit() {
@@ -130,7 +164,9 @@ export async function runInit() {
         eslintOptions = await promptESLintOptions()
     }
 
-    await installPackages(tools)
+    const packageManager = detectPackageManager()
+
+    await installPackages(tools, packageManager)
 
     const spinner = clack.spinner()
 
@@ -162,10 +198,18 @@ export async function runInit() {
         results.push({ content, filename: "cspell.config.js" })
     }
 
+    if (tools.includes("knip")) {
+        const content = generateKnipConfig()
+
+        results.push({ content, filename: "knip.config.ts" })
+    }
+
     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)
     }
+
+    await updatePackageJsonScripts(tools, packageManager)
 }

package/src/cli/prompts.js

@@ -16,6 +16,7 @@ export async function promptToolSelection() {
             { label: "Prettier", value: "prettier" },
             { label: "Stylelint", value: "stylelint" },
             { label: "CSpell", value: "cspell" },
+            { label: "Knip", value: "knip" },
         ],
         required: true,
     })
@@ -153,7 +154,7 @@ export async function promptESLintOptions() {
 
 export async function promptOverwrite(filename) {
     const overwrite = await clack.confirm({
-        initialValue: false,
+        initialValue: true,
         message: `${filename} already exists. Overwrite?`,
     })
 

package/src/cspell/configs/core.js

@@ -12,6 +12,7 @@ const config = {
             path: "./node_modules/@dvukovic/style-guide/cspell/base.txt",
         },
     ],
+    ignorePaths: ["TODO.md", "tsconfig.tsbuildinfo", "CHANGELOG.md"],
     useGitignore: true,
 }
 

package/src/cspell/index.js

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

package/src/eslint/rules/no-commented-out-code/no-commented-out-code.utils.js

@@ -1,4 +1,4 @@
-export function isExpressionOrIdentifierOrLiteral(node) {
+function isExpressionOrIdentifierOrLiteral(node) {
     if (node.type === "Identifier") {
         return true
     }

package/src/knip/configs/core.js

@@ -0,0 +1,14 @@
+/** @type {import("knip").KnipConfig} */
+const config = {
+    ignore: [],
+    ignoreDependencies: [
+        "cspell",
+        "eslint",
+        "prettier",
+        "stylelint",
+        "stylelint-no-unused-selectors",
+        "stylelint-order",
+    ],
+}
+
+export default config

package/src/knip/index.d.ts

@@ -0,0 +1,3 @@
+import type { KnipConfig } from "knip"
+
+export declare const core: KnipConfig

package/src/knip/index.js

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