@antfu/eslint-config 2.2.0 → 2.2.1

package/README.md

@@ -120,6 +120,7 @@ Add the following settings to your `.vscode/settings.json`:
   // Silent the stylistic rules in you IDE, but still auto fix them
   "eslint.rules.customizations": [
     { "rule": "style/*", "severity": "off" },
+    { "rule": "prettier/*", "severity": "off" },
     { "rule": "*-indent", "severity": "off" },
     { "rule": "*-spacing", "severity": "off" },
     { "rule": "*-spaces", "severity": "off" },
@@ -313,7 +314,7 @@ export default antfu(
 )
 ```
 
-We also provided a `overrides` options to make it easier:
+We also provided an `overrides` options to make it easier:
 
 ```js
 // eslint.config.js
@@ -337,33 +338,6 @@ export default antfu({
 
 We provide some optional configs for specific use cases, that we don't include their dependencies by default.
 
-#### Prettier
-
-ESLint is mainly forced on JavaScript. It can support other languages with custom parsers, but that requires a lot of effort to rule parsers and rules to build ecosystems around them. For example, ESLint does not handle CSS and HTML at this moment. It has been a shame for a long time. But since Prettier supports wider range of languages, why don't we use Prettier for them?
-
-> [!WARNING]
-> This is experiemental :)
-
-To enable Prettier support, you need to explicitly turn it on and specify the languages you want to handle:
-
-```js
-// eslint.config.js
-import antfu from '@antfu/eslint-config'
-
-export default antfu({
-  prettier: {
-    css: true, // Let Prettier handles CSS, LESS, SCSS, etc
-    html: true, // Let Prettier handles HTML
-  }
-})
-```
-
-Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
-
-```bash
-npm i -D eslint-plugin-prettier prettier
-```
-
 #### React
 
 To enable React support  you need to explicitly turn it on:

package/dist/cli.cjs

@@ -46,7 +46,7 @@ var import_parse_gitignore = __toESM(require("parse-gitignore"), 1);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "2.2.0";
+var version = "2.2.1";
 var devDependencies = {
   "@antfu/eslint-config": "workspace:*",
   "@antfu/eslint-plugin-prettier": "^5.0.1-1",
@@ -99,6 +99,7 @@ var vscodeSettingsString = `
   // Silent the stylistic rules in you IDE, but still auto fix them
   "eslint.rules.customizations": [
     { "rule": "style/*", "severity": "off" },
+    { "rule": "prettier/*", "severity": "off" },
     { "rule": "*-indent", "severity": "off" },
     { "rule": "*-spacing", "severity": "off" },
     { "rule": "*-spaces", "severity": "off" },

package/dist/cli.js

@@ -17,7 +17,7 @@ import parse from "parse-gitignore";
 import c from "picocolors";
 
 // package.json
-var version = "2.2.0";
+var version = "2.2.1";
 var devDependencies = {
   "@antfu/eslint-config": "workspace:*",
   "@antfu/eslint-plugin-prettier": "^5.0.1-1",
@@ -70,6 +70,7 @@ var vscodeSettingsString = `
   // Silent the stylistic rules in you IDE, but still auto fix them
   "eslint.rules.customizations": [
     { "rule": "style/*", "severity": "off" },
+    { "rule": "prettier/*", "severity": "off" },
     { "rule": "*-indent", "severity": "off" },
     { "rule": "*-spacing", "severity": "off" },
     { "rule": "*-spaces", "severity": "off" },

package/dist/index.cjs

@@ -759,6 +759,7 @@ async function stylistic(options = {}) {
 
 // src/configs/prettier.ts
 async function prettier(options = {}, stylistic2 = {}) {
+  console.warn("@antfu/eslint-config: `prettier` option is deprecated, please do not use it anymore. We will find better formatters to support that in the future.");
   await ensurePackages([
     "@antfu/eslint-plugin-prettier"
   ]);

package/dist/index.d.cts

@@ -349,6 +349,9 @@ declare function node(): Promise<FlatConfigItem[]>;
  */
 declare function perfectionist(): Promise<FlatConfigItem[]>;
 
+/**
+ * @deprecated
+ */
 declare function prettier(options?: OptionsPrettier, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
 
 declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsFiles): Promise<FlatConfigItem[]>;

package/dist/index.d.ts

@@ -349,6 +349,9 @@ declare function node(): Promise<FlatConfigItem[]>;
  */
 declare function perfectionist(): Promise<FlatConfigItem[]>;
 
+/**
+ * @deprecated
+ */
 declare function prettier(options?: OptionsPrettier, stylistic?: StylisticConfig): Promise<FlatConfigItem[]>;
 
 declare function react(options?: OptionsHasTypeScript & OptionsOverrides & OptionsFiles): Promise<FlatConfigItem[]>;

package/dist/index.js

@@ -673,6 +673,7 @@ async function stylistic(options = {}) {
 
 // src/configs/prettier.ts
 async function prettier(options = {}, stylistic2 = {}) {
+  console.warn("@antfu/eslint-config: `prettier` option is deprecated, please do not use it anymore. We will find better formatters to support that in the future.");
   await ensurePackages([
     "@antfu/eslint-plugin-prettier"
   ]);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antfu/eslint-config",
   "type": "module",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "packageManager": "pnpm@8.11.0",
   "description": "Anthony's ESLint config",
   "author": "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)",
@@ -110,7 +110,7 @@
     "tsup": "^8.0.1",
     "typescript": "^5.3.2",
     "vitest": "^0.34.6",
-    "@antfu/eslint-config": "2.2.0"
+    "@antfu/eslint-config": "2.2.1"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"