@st1ggy/linter-config 7.2.2 → 7.3.0

package/docs/RULE_MAPPING.md

@@ -19,6 +19,7 @@ node scripts/inventory.mjs
 | Unicorn | `config.unicorn.js` | eslint-plugin-unicorn. |
 | SonarJS | `config.sonarjs.js` | eslint-plugin-sonarjs. |
 | React | `config.react.js` | React/JSX + hooks. |
+| SolidJS | `config.solid.js` | `eslint-plugin-solid` recommended for JS/JSX, TypeScript preset for TS/TSX, and JSX formatting. |
 | Next.js | `config.next.js` | `@next/eslint-plugin-next`. |
 | Svelte | `svelte-stack.js` | `eslint-plugin-svelte` flat recommended + TS parser options. |
 | Astro | `astro-stack.js` | `eslint-plugin-astro` recommended. |
@@ -27,6 +28,7 @@ Inventory rule counts (sample files in this repository):
 
 - `eslint-common`: effective rules on `src/examples/example.ts`
 - `eslint-react`: includes React layer on the same sample
+- `eslint-solid`: effective rules on `src/examples/example.solid.tsx`
 - `eslint-next`: Next layer on the same sample
 - `eslint-svelte`: effective rules on `src/examples/example.svelte`
 - `eslint-astro`: effective rules on `src/examples/example.astro`

package/index.d.ts

@@ -9,6 +9,7 @@ declare module '@st1ggy/linter-config' {
 
   export const eslintCommon: Linter.Config[]
   export const eslintReact: Linter.Config[]
+  export const eslintSolid: Linter.Config[]
   export const eslintNext: Linter.Config[]
   export const eslintSvelte: Linter.Config[]
   export const eslintAstro: Linter.Config[]
@@ -36,6 +37,14 @@ declare module '@st1ggy/linter-config/eslint-react' {
   export default config
 }
 
+declare module '@st1ggy/linter-config/eslint-solid' {
+  import type { Linter } from 'eslint'
+
+  const config: Linter.Config[]
+
+  export default config
+}
+
 declare module '@st1ggy/linter-config/eslint-svelte' {
   import type { Linter } from 'eslint'
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@st1ggy/linter-config",
-  "version": "7.2.2",
+  "version": "7.3.0",
   "description": "ESLint, Prettier, and Stylelint shareable configs (sources under src/).",
   "private": false,
   "repository": {
@@ -73,6 +73,11 @@
       "import": "./src/eslint/eslint.config.react.js",
       "default": "./src/eslint/eslint.config.react.js"
     },
+    "./eslint-solid": {
+      "types": "./index.d.ts",
+      "import": "./src/eslint/eslint.config.solid.js",
+      "default": "./src/eslint/eslint.config.solid.js"
+    },
     "./eslint-svelte": {
       "types": "./index.d.ts",
       "import": "./src/eslint/eslint-svelte.config.js",
@@ -140,6 +145,7 @@
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-solid": "^0.18.0",
     "eslint-plugin-svelte": "^3.22.0",
     "next": "^16.3.0",
     "prettier": "^3.9.6",
@@ -165,6 +171,9 @@
     "eslint-plugin-react-hooks": {
       "optional": true
     },
+    "eslint-plugin-solid": {
+      "optional": true
+    },
     "eslint-plugin-svelte": {
       "optional": true
     },
@@ -202,9 +211,11 @@
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-solid": "^0.18.0",
     "eslint-plugin-svelte": "^3.22.0",
     "prettier-plugin-astro": "^0.14.1",
     "prettier-plugin-svelte": "^4.1.1",
+    "solid-js": "^1.9.15",
     "svelte": "^5.56.8"
   }
 }

package/scripts/README.md

@@ -19,6 +19,7 @@ Direct CLI (paths from repo root — same entry as published **`@st1ggy/linter-c
 
 ```bash
 node ./scripts/linter-init.mjs init --react
+node ./scripts/linter-init.mjs init --solid --dir ./my-solid-app
 node ./scripts/linter-init.mjs migrate --svelte --dir ./my-app
 node ./scripts/linter-init.mjs init --astro
 ```
@@ -30,6 +31,7 @@ The CLI is published under the name **`@st1ggy/linter-config`** (see [`package.j
 ```bash
 npx @st1ggy/linter-config init --common
 npx @st1ggy/linter-config init --next
+npx @st1ggy/linter-config init --solid
 npm exec @st1ggy/linter-config -- migrate --svelte
 ```
 
@@ -39,8 +41,10 @@ npm exec @st1ggy/linter-config -- migrate --svelte
 npx --yes @st1ggy/linter-config init --astro
 ```
 
-- **Stack (optional, default common):** `--common` | `--react` | `--next` | `--svelte` | `--astro` (at most one).
+- **Stack (optional, default common):** `--common` | `--react` | `--solid` | `--next` | `--svelte` | `--astro` (at most one).
 - **`--skip-install`:** only write wrapper files; do not run npm/pnpm/yarn/bun.
 - Every CLI command opens an interactive wizard. `init` creates missing wrappers; `migrate` can remove selected legacy configs and replaces wrappers.
 
 Shell shortcuts in this folder (`init-common.sh`, etc.) call **`node …/linter-init.mjs`** (same script as the published **`@st1ggy/linter-config`** CLI) with the matching stack; pass **`--skip-install`** through when needed.
+
+For SolidJS, `init-solid.sh` selects `eslint-solid`, `prettier-common`, and `stylelint-scss`, and installs `eslint-plugin-solid` alongside `@st1ggy/linter-config`.

package/scripts/init-solid.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+# See init-common.sh — same as npx @st1ggy/linter-config, stack --solid.
+set -euo pipefail
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+exec node "${SCRIPT_DIR}/linter-init.mjs" init --solid "$@"

package/scripts/inventory.mjs

@@ -26,6 +26,11 @@ const flatConfigPresets = [
     module: 'src/eslint/eslint.config.react.js',
     sampleFile: 'src/examples/example.ts',
   },
+  {
+    id: 'eslint-solid',
+    module: 'src/eslint/eslint.config.solid.js',
+    sampleFile: 'src/examples/example.solid.tsx',
+  },
   {
     id: 'eslint-next',
     module: 'src/eslint/eslint.config.next.js',

package/scripts/linter-init-core.mjs

@@ -6,7 +6,7 @@ import path from 'node:path'
 
 export const PACKAGE = '@st1ggy/linter-config'
 
-export const STACK_KEYS = ['common', 'react', 'next', 'svelte', 'astro']
+export const STACK_KEYS = ['common', 'react', 'solid', 'next', 'svelte', 'astro']
 
 export const STACKS = {
   common: {
@@ -21,6 +21,12 @@ export const STACKS = {
     stylelint: 'stylelint-scss',
     packages: ['eslint-plugin-react', 'eslint-plugin-react-hooks'],
   },
+  solid: {
+    eslint: 'eslint-solid',
+    prettier: 'prettier-common',
+    stylelint: 'stylelint-scss',
+    packages: ['eslint-plugin-solid'],
+  },
   next: {
     eslint: 'eslint-next',
     prettier: 'prettier-common',
@@ -50,6 +56,10 @@ export const STACK_CHOICES = [
     value: 'react',
     name: 'react — React + hooks on top of common',
   },
+  {
+    value: 'solid',
+    name: 'solid — SolidJS + reactivity rules on top of common',
+  },
   {
     value: 'next',
     name: 'next — Next.js App Router on top of react',
@@ -260,7 +270,7 @@ Unless --skip-install: if package.json exists, runs the detected package manager
 ${PACKAGE} and the selected stack's integration plugins.
 
 Stack (at most one; default: common):
-  --common | --react | --next | --svelte | --astro
+  --common | --react | --solid | --next | --svelte | --astro
 
 Options:
   --dir, -d       Target directory (default: current working directory).
@@ -271,6 +281,7 @@ Examples (after: npm i -D ${PACKAGE}):
   npx ${PACKAGE}
   npx ${PACKAGE} init
   npx ${PACKAGE} init --react
+  npx ${PACKAGE} init --solid
   npx ${PACKAGE} migrate --svelte --dir ./apps/web
   npx ${PACKAGE} init --astro
   npm exec ${PACKAGE} -- init --common

package/scripts/linter-init.mjs

@@ -34,6 +34,7 @@ function parseArgv(argv) {
       'biome',
       'common',
       'react',
+      'solid',
       'next',
       'svelte',
       'astro',
@@ -59,6 +60,7 @@ function argvToValues(argv) {
     biome: Boolean(argv.biome),
     common: Boolean(argv.common),
     react: Boolean(argv.react),
+    solid: Boolean(argv.solid),
     next: Boolean(argv.next),
     svelte: Boolean(argv.svelte),
     astro: Boolean(argv.astro),

package/scripts/solid-config.test.mjs

@@ -0,0 +1,134 @@
+/* eslint-disable unicorn/no-incorrect-template-string-interpolation -- Fixtures contain literal JSX expressions. */
+
+import { ESLint } from 'eslint'
+import assert from 'node:assert/strict'
+import { mkdtempSync, readFileSync, realpathSync, rmSync, writeFileSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import path from 'node:path'
+import test from 'node:test'
+
+import solidConfig from '@st1ggy/linter-config/eslint-solid'
+
+import prettierConfig from '../src/prettier/prettier.config.common.js'
+
+import { resolveStackKey, run, stackPackages } from './linter-init-core.mjs'
+
+function createProject(context) {
+  const prefix = path.join(tmpdir(), 'linter-solid-')
+  const directory = realpathSync(mkdtempSync(prefix))
+
+  context.after(() => rmSync(directory, { recursive: true, force: true }))
+  writeFileSync(
+    path.join(directory, 'tsconfig.json'),
+    JSON.stringify({ compilerOptions: { allowJs: true, jsx: 'preserve', noEmit: true }, include: ['*.jsx', '*.tsx'] }),
+  )
+  writeFileSync(path.join(directory, '.prettierrc.json'), JSON.stringify(prettierConfig))
+
+  return directory
+}
+
+async function lintSource(context, extension, source) {
+  const directory = createProject(context)
+  const filePath = path.join(directory, `component.${extension}`)
+
+  writeFileSync(filePath, source)
+  const eslint = new ESLint({
+    cwd: directory,
+    overrideConfigFile: true,
+    overrideConfig: [...solidConfig, { languageOptions: { parserOptions: { tsconfigRootDir: directory } } }],
+  })
+  const [result] = await eslint.lintFiles([filePath])
+
+  assert.equal(result.fatalErrorCount, 0, JSON.stringify(result.messages))
+
+  return result.messages
+}
+
+test('Solid preset is available through both public exports', async () => {
+  const { eslintSolid } = await import('@st1ggy/linter-config')
+
+  assert.equal(eslintSolid, solidConfig)
+})
+
+for (const extension of ['jsx', 'tsx']) {
+  const annotation = extension === 'tsx' ? ': { name: string }' : ''
+
+  test(`Solid preset accepts reactive props in ${extension}`, async (context) => {
+    const messages = await lintSource(
+      context,
+      extension,
+      `export const Greeting = (props${annotation}) => <p>{props.name}</p>\n`,
+    )
+
+    assert.deepEqual(messages, [])
+  })
+
+  test(`Solid preset reports destructured props in ${extension}`, async (context) => {
+    const messages = await lintSource(
+      context,
+      extension,
+      `export const Greeting = ({ name }${annotation}) => <p>{name}</p>\n`,
+    )
+
+    assert.ok(messages.some((message) => message.ruleId === 'solid/no-destructure' && message.severity === 2))
+  })
+
+  test(`Solid preset reports lost reactivity in ${extension}`, async (context) => {
+    const messages = await lintSource(
+      context,
+      extension,
+      `export const Greeting = (props${annotation}) => {
+  const name = props.name
+
+  return <p>{name}</p>
+}
+`,
+    )
+
+    assert.ok(messages.some((message) => message.ruleId === 'solid/reactivity' && message.severity === 1))
+  })
+
+  test(`Solid preset recognizes components used in ${extension}`, async (context) => {
+    const messages = await lintSource(
+      context,
+      extension,
+      'const Greeting = () => <p>Hello</p>\n\nexport const App = () => <Greeting />\n',
+    )
+
+    assert.deepEqual(messages, [])
+  })
+}
+
+test('Solid stack generates wrappers, preserves them on init and replaces them on migrate', (context) => {
+  const directory = createProject(context)
+  const expected = {
+    'eslint.config.js': "export { default } from '@st1ggy/linter-config/eslint-solid';\n",
+    'prettier.config.js': "export { default } from '@st1ggy/linter-config/prettier-common';\n",
+    'stylelint.config.js': "export { default } from '@st1ggy/linter-config/stylelint-scss';\n",
+  }
+
+  run('init', directory, 'solid', { quiet: true })
+
+  for (const [file, content] of Object.entries(expected)) {
+    assert.equal(readFileSync(path.join(directory, file), 'utf8'), content)
+    writeFileSync(path.join(directory, file), '// existing config\n')
+  }
+
+  run('init', directory, 'solid', { quiet: true })
+
+  for (const file of Object.keys(expected)) {
+    assert.equal(readFileSync(path.join(directory, file), 'utf8'), '// existing config\n')
+  }
+
+  run('migrate', directory, 'solid', { quiet: true })
+
+  for (const [file, content] of Object.entries(expected)) {
+    assert.equal(readFileSync(path.join(directory, file), 'utf8'), content)
+  }
+})
+
+test('Solid stack selects its integration plugin and rejects conflicting flags', () => {
+  assert.equal(resolveStackKey({ solid: true }), 'solid')
+  assert.deepEqual(stackPackages('solid'), ['@st1ggy/linter-config', 'eslint-plugin-solid'])
+  assert.throws(() => resolveStackKey({ solid: true, react: true }), /Pick at most one stack flag/)
+})

package/src/eslint/configs/config.solid.js

@@ -0,0 +1,36 @@
+import { defineConfig } from 'eslint/config'
+import solidPlugin from 'eslint-plugin-solid'
+
+export default defineConfig([
+  {
+    ...solidPlugin.configs['flat/recommended'],
+    files: ['**/*.{js,jsx,mjs,cjs}'],
+  },
+  {
+    ...solidPlugin.configs['flat/typescript'],
+    files: ['**/*.{ts,tsx,mts,cts}'],
+  },
+  {
+    files: ['**/*.{jsx,tsx}'],
+    rules: {
+      'solid/self-closing-comp': 'error',
+      '@stylistic/jsx-closing-bracket-location': 'error',
+      '@stylistic/jsx-closing-tag-location': 'error',
+      '@stylistic/jsx-curly-brace-presence': ['error', { props: 'never', children: 'never' }],
+      '@stylistic/jsx-curly-newline': ['error', { multiline: 'consistent', singleline: 'forbid' }],
+      '@stylistic/jsx-curly-spacing': [
+        'error',
+        {
+          when: 'never',
+          attributes: { allowMultiline: false },
+          children: false,
+        },
+      ],
+      '@stylistic/jsx-equals-spacing': ['error', 'never'],
+      '@stylistic/jsx-first-prop-new-line': ['error', 'multiline'],
+      '@stylistic/jsx-max-props-per-line': ['error', { when: 'multiline' }],
+      '@stylistic/no-multi-spaces': 'error',
+      '@stylistic/jsx-tag-spacing': 'error',
+    },
+  },
+])

package/src/eslint/eslint.config.solid.js

@@ -0,0 +1,4 @@
+import solidConfig from './configs/config.solid.js'
+import commonConfig from './eslint.config.common.js'
+
+export default [...commonConfig, ...solidConfig]

package/src/examples/example.solid.tsx

@@ -0,0 +1,3 @@
+/** @jsxImportSource solid-js */
+
+export const Greeting = (props: { name: string }) => <p>{props.name}</p>

package/src/index.js

@@ -1,5 +1,6 @@
 export { default as eslintCommon } from './eslint/eslint.config.common.js'
 export { default as eslintReact } from './eslint/eslint.config.react.js'
+export { default as eslintSolid } from './eslint/eslint.config.solid.js'
 export { default as eslintNext } from './eslint/eslint.config.next.js'
 export { default as eslintSvelte } from './eslint/eslint-svelte.config.js'
 export { default as eslintAstro } from './eslint/eslint.config.astro.js'