@coderwyd/eslint-config 1.0.10 → 1.1.0-beta.0

package/README.md

@@ -0,0 +1,132 @@
+# @coderwyd/eslint-config
+
+[![release status](https://github.com/coderwyd/eslint-config/actions/workflows/release.yml/badge.svg)](https://github.com/coderwyd/eslint-config/actions/workflows/release.yml)
+[![npm](https://img.shields.io/npm/v/@coderwyd/eslint-config.svg)](https://npmjs.org/package/@coderwyd/eslint-config)
+[![downloads](https://img.shields.io/npm/dm/@coderwyd/eslint-config.svg)](https://npmjs.org/package/@coderwyd/eslint-config)
+
+## Feature
+
+- Single quotes, no semi
+- Auto fix for formatting (aimed to be used standalone **without** Prettier)
+- Designed to work with TypeScript, Vue out-of-box
+- Lint also for json, yaml, markdown
+- Sorted imports, dangling commas
+- Reasonable defaults, best practices, only one-line of config
+
+## Usage
+
+### Install
+
+```bash
+pnpm add -D eslint @coderwyd/eslint-config # JavaScript, TypeScript and Vue 3
+# Or yarn add eslint @coderwyd/eslint-config -D / npm install eslint @coderwyd/eslint-config -D
+pnpm add -D @coderwyd/eslint-config-basic # JavaScript only
+pnpm add -D @coderwyd/eslint-config-ts # JavaScript and TypeScript
+pnpm add -D @coderwyd/eslint-config-react # JavaScript, TypeScript and React
+pnpm add -D @coderwyd/eslint-config-vue # JavaScript, TypeScript and Vue 3
+```
+
+### Config `.eslintrc`
+
+```json
+{
+  "extends": "@coderwyd"
+}
+```
+
+> You don't need `.eslintignore` normally as it has been provided by the preset.
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+### VS Code support (auto fix)
+
+Add the following settings to your `settings.json`:
+
+```jsonc
+{
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true,
+    "source.organizeImports": false
+  },
+
+  // The following is optional.
+  // It's better to put under project setting `.vscode/settings.json`
+  // to avoid conflicts with working with different eslint configs
+  // that does not support all formats.
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact", "vue", "html", "markdown", "json", "jsonc", "yaml"]
+}
+```
+
+### TypeScript Aware Rules
+
+Type aware rules are enabled when a `tsconfig.eslint.json` is found in the project root, which will introduce some stricter rules into your project. If you want to enable it while have no `tsconfig.eslint.json` in the project root, you can change tsconfig name by modifying `ESLINT_TSCONFIG` env.
+
+```js
+// .eslintrc.js
+const process = require('node:process')
+
+process.env.ESLINT_TSCONFIG = 'tsconfig.json'
+
+module.exports = {
+  extends: '@coderwyd',
+}
+```
+
+### Lint Staged
+
+If you want to apply lint and auto-fix before every commit, you can add the following to your `package.json`:
+
+```json
+{
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
+}
+```
+
+and then
+
+```bash
+npm i -D lint-staged simple-git-hooks
+```
+
+## FAQ
+
+### Customization rules
+
+add you like rules to your .eslintrc file.
+
+<!-- eslint-skip -->
+
+```jsonc
+{
+  "extends": "@coderwyd",
+  "rules": {
+    // your rules...
+  }
+}
+```
+
+## Thanks
+
+This project is based on [@antfu/eslint-config](https://github.com/antfu/eslint-config)
+
+## License
+
+[MIT](./LICENSE) License &copy; 2019-PRESENT [Donny Wang](https://github.com/coderwyd)

package/dist/index.d.ts

@@ -0,0 +1,154 @@
+import { FlatESLintConfigItem } from 'eslint-define-config';
+export { default as pluginAntfu } from 'eslint-plugin-antfu';
+export { default as pluginComments } from 'eslint-plugin-eslint-comments';
+export { default as pluginImport } from 'eslint-plugin-i';
+export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
+export { default as pluginJsonc } from 'eslint-plugin-jsonc';
+export { default as pluginMarkdown } from 'eslint-plugin-markdown';
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginStylisticJs } from '@stylistic/eslint-plugin-js';
+export { default as pluginStylisticTs } from '@stylistic/eslint-plugin-ts';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginVue } from 'eslint-plugin-vue';
+export { default as pluginYml } from 'eslint-plugin-yml';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as pluginReact } from 'eslint-plugin-react';
+export { default as pluginReactHooks } from 'eslint-plugin-react-hooks';
+export { default as parserTs } from '@typescript-eslint/parser';
+export { default as parserVue } from 'vue-eslint-parser';
+export { default as parserYml } from 'yaml-eslint-parser';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+
+interface OptionsComponentExts {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptWithLanguageServer {
+    tsconfigPath: string;
+    tsconfigRootDir?: string;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsConfig {
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypeScriptWithLanguageServer;
+    /**
+     * Enable test support.
+     *
+     * @default true
+     */
+    test?: boolean;
+    /**
+     * Enable Vue support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    vue?: boolean;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean;
+    /**
+     * Enable YAML support.
+     *
+     * @default true
+     */
+    yaml?: boolean;
+    /**
+     * Enable Markdown support.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean;
+    /**
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
+     */
+    isInEditor?: boolean;
+}
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+declare function coderwyd(options?: OptionsConfig, ...userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+
+declare const comments: FlatESLintConfigItem[];
+
+declare const ignores: FlatESLintConfigItem[];
+
+declare const imports: FlatESLintConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+declare const jsdoc: FlatESLintConfigItem[];
+
+declare const jsonc: FlatESLintConfigItem[];
+
+declare function markdown(options?: OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const node: FlatESLintConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortPackageJson: FlatESLintConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortTsconfig: FlatESLintConfigItem[];
+
+declare const javascriptStylistic: FlatESLintConfigItem[];
+declare const typescriptStylistic: FlatESLintConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts): FlatESLintConfigItem[];
+declare function typescriptWithLanguageServer(options: OptionsTypeScriptWithLanguageServer & OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const unicorn: FlatESLintConfigItem[];
+
+declare function getVueVersion(): number;
+declare function vue(options?: OptionsHasTypeScript): FlatESLintConfigItem[];
+
+declare const yml: FlatESLintConfigItem[];
+
+declare function test(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+declare function react(options?: OptionsHasTypeScript): FlatESLintConfigItem[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+declare function renameRules(rules: Record<string, any>, from: string, to: string): {
+    [k: string]: any;
+};
+
+export { OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsTypeScriptWithLanguageServer, coderwyd, combine, comments, coderwyd as default, getVueVersion, ignores, imports, javascript, javascriptStylistic, jsdoc, jsonc, markdown, node, react, renameRules, sortPackageJson, sortTsconfig, test, typescript, typescriptStylistic, typescriptWithLanguageServer, unicorn, vue, yml };