@inradius/solid-wc-utils-config
v0.1.4
Published
Shared ESLint, Prettier, and Vitest configuration for Solid.js web component applications.
Maintainers
Readme
@inradius/solid-wc-utils-config
A shared base configuration for Solid.js Web Component applications.
Installation
npm install -D @inradius/solid-wc-utils-config eslint prettier typescript
# or
pnpm add -D @inradius/solid-wc-utils-config eslint prettier typescriptUsage
In your applications root eslint and prettier configuration files, import the shared configurations.
// eslint.config.ts
export { default } from '@inradius/solid-wc-utils-config/eslint';// prettier.config.ts
export { default } from '@inradius/solid-wc-utils-config/prettier';Extending the configurations
You can extend the shared configurations by importing and spreading them, as the configurations are TypeScript exported default objects.
// prettier.config.ts
import type { Config } from 'prettier';
import * as tailwindPlugin from 'prettier-plugin-tailwindcss';
import sharedConfig from '@inradius/solid-wc-utils-config/prettier';
const config: Config = {
...sharedConfig,
plugins: [tailwindPlugin],
};
export default config;Vitest
A shared Vitest base configuration is also available:
// vitest.config.ts
import { defineConfig, mergeConfig } from 'vitest/config';
import baseConfig from '@inradius/solid-wc-utils-config/vitest.base';
export default mergeConfig(baseConfig, defineConfig({
// your overrides here
}));What's included
All ESLint plugins are bundled as dependencies — consumers do not need to install them individually:
@eslint/jseslint-config-prettiereslint-import-resolver-typescripteslint-plugin-import-xeslint-plugin-perfectionisteslint-plugin-solidglobalstypescript-eslint
Note: The ESLint config includes
eslint-plugin-solid, making it opinionated toward Solid.js projects.
⚠️ ESLint 10 compatibility:
eslint-plugin-soliddepends on@typescript-eslint/[email protected], which does not yet support ESLint 10. This package pins its ESLint peer dependency to ^9.20.0 until upstream support lands. Track progress in eslint-plugin-solid and typescript-eslint.
Requirements
- Node.js
^20.19.0 || >=22 - ESLint
^9.20.0 - Prettier
^3.0.0 - TypeScript
^5.0.0
License
MIT
