Ray's Codestyle Config

Forked from antfu/eslint-config

Features

• Double quotes, with semicolons
• Use tabs for indent (Read more)
• Auto fix for formatting (Powered by Prettier)
• Supports TypeScript, Vue, React, Svelte, Solid, MDX, JSON, Yaml, Markdown, HTML out-of-box!
• Sorted imports, dangling commas for cleaner commit diff
• Autofix for syntax errors, e.g. automatically add async keyword when using await in a non-async function
• Focused on consistent code style, with custom rules to enforce style
• Reasonable defaults, best practices, only one-line of config
• Respects .gitignore by default
• ESLint Flat config, compose easily!
• Style principle: Consistent for reading, stable for diff. More automated style fixes is better.

[!IMPORTANT] The main branch is for v3.0, which rewrites to ESLint Flat config and requires ESLint v8.57.0 or v9.0.0+.

Usage

Install

pnpm add -D eslint prettier @so1ve/eslint-config @so1ve/prettier-config

Config eslint.config.mjs and prettier.config.mjs

// eslint.config.mjs
import { so1ve } from "@so1ve/eslint-config";

export default so1ve();

// prettier.config.mjs
export { default } from "@so1ve/prettier-config";

Note that .eslintignore no longer works in Flat config, see customization for more details.

Add script for package.json

For example:

{
	"scripts": {
		"lint": "eslint . && prettier . --check",
		"lint:fix": "eslint . --fix && prettier . --write"
	}
}

Config VS Code auto fix

Create .vscode/settings.json

{
	"editor.defaultFormatter": "esbenp.prettier-vscode",
	"editor.formatOnSave": true,
	"editor.codeActionsOnSave": {
		"source.fixAll.eslint": "explicit"
	},
	"eslint.validate": [
		"javascript",
		"typescript",
		"javascriptreact",
		"typescriptreact",
		"vue",
		"html",
		"markdown",
		"json",
		"jsonc",
		"json5",
		"toml",
		"yaml",
		"svelte",
		"github-actions-workflow"
	]
}

Customization

Since v1.0, we migrated to ESLint Flat config. It provides a much better organization and composition.

Normally you only need to import the so1ve preset:

// eslint.config.js
import { so1ve } from "@so1ve/eslint-config";

export default so1ve();

And that's it! Or you can configure each integration individually, for example:

// eslint.config.js
import { so1ve } from "@so1ve/eslint-config";

export default so1ve(
	{
		typescript: true,
		vue: true,
		solid: false,
		jsonc: false,
		yaml: false,
	},
	{
		// `.eslintignore` is no longer supported in Flat config, use `ignores` instead
		ignores: [
			"./fixtures",
			// ...globs
		],
	},
);

The so1ve factory function also accepts any number of arbitrary custom config overrides:

// eslint.config.js
import { so1ve } from "@so1ve/eslint-config";

export default so1ve(
	{
		// Configures for so1ve's config
	},

	// From the second arguments they are ESLint Flat Configs
	// you can have multiple configs
	{
		files: ["**/*.ts"],
		rules: {},
	},
	{
		rules: {},
	},
);

Going more advanced, you can also import fine-grained configs and compose them as you wish:

// eslint.config.js
import {
	comments,
	formatting,
	html,
	ignores,
	imports,
	javascript,
	jsonc,
	mdx,
	node,
	onlyError,
	promise,
	solid,
	sortImports,
	test,
	toml,
	typescript,
	unicorn,
	vue,
	yaml,
} from "@so1ve/eslint-config";

export default [
	...comments(),
	...formatting(),
	...html(),
	...ignores(),
	...imports(),
	...javascript(),
	...jsonc(),
	...mdx(),
	...node(),
	...onlyError(),
	...promise(),
	...solid(),
	...sortImports(),
	...test(),
	...toml(),
	...typescript(),
	...unicorn(),
	...vue(),
	...yaml(),
];

Check out the configs and factory for more details.

Thanks to sxzz/eslint-config and antfu/eslint-config for the inspiration and reference.

Plugins Renaming

Since flat config requires us to explicitly provide the plugin names (instead of mandatory convention from npm package name), we renamed some plugins to make overall scope more consistent and easier to write.

When you want to override rules, or disable them inline, you need to update to the new prefix:

-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+// eslint-disable-next-line ts/consistent-type-definitions
type foo = { bar: 2 }

Since v2.1.0, this preset will automatically rename the plugins also for your custom configs. You can use the original prefix to override the rules directly.

Rules Overrides

Certain rules would only be enabled in specific files, for example, ts/* rules would only be enabled in .ts files and vue/* rules would only be enabled in .vue files. If you want to override the rules, you need to specify the file extension:

// eslint.config.js
import { so1ve } from "@so1ve/eslint-config";

export default so1ve(
	{ vue: true, typescript: true },
	{
		// Remember to specify the file glob here, otherwise it might cause the vue plugin to handle non-vue files
		files: ["**/*.vue"],
		rules: {
			"vue/operator-linebreak": ["error", "before"],
		},
	},
	{
		// Without `files`, they are general rules for all files
		rules: {
			"style/semi": ["error", "never"],
		},
	},
);

We also provided a overrides options in each integration to make it easier:

// eslint.config.js
import { so1ve } from "@so1ve/eslint-config";

export default so1ve({
	vue: {
		overrides: {
			"vue/operator-linebreak": ["error", "before"],
		},
	},
	typescript: {
		overrides: {
			"ts/consistent-type-definitions": ["error", "interface"],
		},
	},
	yaml: {
		overrides: {
			// ...
		},
	},
});

Config Composer

Since v2.1.0, the factory function so1ve() returns a FlatConfigComposer object from eslint-flat-config-utils where you can chain the methods to compose the config even more flexibly.

// eslint.config.js
import { so1ve } from "@so1ve/eslint-config";

export default so1ve()
	// some configs before the main config
	.prepend()
	// overrides any named configs
	.override("so1ve/imports/rules", {
		rules: {
			"import/named": "off",
		},
	})
	// rename plugin prefixes
	.renamePlugins({
		"old-prefix": "new-prefix",
		// ...
	});
// ...

Type Aware Rules

Type Aware Rules are enabled by default.

License

MIT