feat(config): export only the Prettier-compatible config

BREAKING CHANGE: now exports only the recommended config, Prettier-compatible. There is no reason to have separate config since it no longer mandates Prettier usage.

Author: thibaudcolas

.gitignore

@@ -88,5 +88,4 @@ lib64
 # -------------------------------------------------
 # Your own project's ignores
 # -------------------------------------------------
-src/prettier.json
-src/recommended.json
+src/*.json

README.md

@@ -27,22 +27,13 @@ module.exports = {
 
 ### With Prettier
 
-This ESLint plugin comes with a built-in Prettier-compatible config. First, install Prettier:
+This recommended config is Prettier-compatible. First, install Prettier:
 
 ```sh
 npm install --save-dev prettier
 ```
 
-Switch to the Prettier config:
-
-```js
-module.exports = {
-  // https://github.com/thibaudcolas/eslint-plugin-cookbook
-  extends: "plugin:@thibaudcolas/cookbook/prettier",
-};
-```
-
-Then, to configure Prettier itself, create a `prettier.config.js` file in the root of your project with:
+Then, to configure Prettier itself, create a `prettier.config.js` file in the root of your project. You can use the following to get started:
 
 ```js
 // https://github.com/thibaudcolas/eslint-plugin-cookbook

src/__snapshots__/base.test.js.snap

@@ -11,6 +11,9 @@ Object {
   },
   "extends": Array [
     "airbnb",
+    "prettier",
+    "prettier/flowtype",
+    "prettier/react",
   ],
   "rules": Object {
     "arrow-body-style": Array [

src/__snapshots__/semver.test.js.snap

@@ -1,135 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`semver - should those tests break, consider releasing a new major version of the package custom config 1`] = `
-Object {
-  "env": Object {
-    "browser": true,
-    "commonjs": true,
-    "es6": true,
-    "jest": true,
-    "node": true,
-  },
-  "extends": Array [
-    "airbnb",
-  ],
-  "rules": Object {
-    "arrow-body-style": Array [
-      0,
-    ],
-    "eol-last": Array [
-      1,
-    ],
-    "id-length": Array [
-      0,
-    ],
-    "import/no-extraneous-dependencies": Array [
-      2,
-      Object {
-        "devDependencies": true,
-        "optionalDependencies": false,
-        "peerDependencies": false,
-      },
-    ],
-    "import/prefer-default-export": Array [
-      0,
-    ],
-    "indent": Array [
-      2,
-      4,
-    ],
-    "jsx-a11y/label-has-for": Array [
-      0,
-    ],
-    "jsx-quotes": Array [
-      1,
-      "prefer-double",
-    ],
-    "max-len": Array [
-      1,
-      120,
-      4,
-      Object {
-        "ignoreUrls": true,
-      },
-    ],
-    "no-console": Array [
-      1,
-      Object {
-        "allow": Array [
-          "warn",
-          "error",
-          "time",
-          "timeEnd",
-        ],
-      },
-    ],
-    "no-multi-spaces": Array [
-      0,
-    ],
-    "no-new": Array [
-      1,
-    ],
-    "no-param-reassign": Array [
-      2,
-      Object {
-        "props": false,
-      },
-    ],
-    "no-plusplus": Array [
-      0,
-    ],
-    "no-warning-comments": Array [
-      1,
-      Object {
-        "location": "start",
-        "terms": Array [
-          "todo",
-          "fixme",
-          "xxx",
-        ],
-      },
-    ],
-    "object-shorthand": Array [
-      2,
-      "methods",
-    ],
-    "react/forbid-prop-types": Array [
-      2,
-      Object {
-        "forbid": Array [
-          "any",
-        ],
-      },
-    ],
-    "react/jsx-boolean-value": Array [
-      0,
-    ],
-    "react/jsx-filename-extension": Array [
-      2,
-      Object {
-        "extensions": Array [
-          ".js",
-        ],
-      },
-    ],
-    "react/jsx-indent": Array [
-      2,
-      4,
-    ],
-    "react/jsx-indent-props": Array [
-      2,
-      4,
-    ],
-    "react/jsx-no-bind": Array [
-      0,
-    ],
-    "react/sort-comp": Array [
-      0,
-    ],
-  },
-}
-`;
-
 exports[`semver - should those tests break, consider releasing a new major version of the package dependencies 1`] = `
 Object {
   "eslint-plugin-import": "^2.14.0",

src/base.js

@@ -1,5 +1,5 @@
 module.exports = {
-  extends: ["airbnb"],
+  extends: ["airbnb", "prettier", "prettier/flowtype", "prettier/react"],
 
   rules: {
     indent: [2, 4],

src/base.test.js

@@ -11,7 +11,7 @@ describe("config", () => {
     });
 
     expect(cli.executeOnText("var foo\n")).toMatchObject({
-      errorCount: 3,
+      errorCount: 2,
       warningCount: 0,
     });
   });

src/buildConfigs.js

@@ -13,13 +13,6 @@ const base = require("./base");
 
 const configs = {
   recommended: base,
-  prettier: {
-    extends: base.extends.concat([
-      "prettier",
-      "prettier/flowtype",
-      "prettier/react",
-    ]),
-  },
 };
 
 Object.keys(configs).forEach((name) => {

src/buildConfigs.test.js

@@ -29,16 +29,4 @@ describe("buildConfigs", () => {
       errorCount: 4,
     });
   });
-
-  it("prettier is valid", () => {
-    const cli = new CLIEngine({
-      baseConfig: convertRefs(require("./prettier.json")),
-    });
-
-    expect(
-      cli.executeOnText("import test from 'potato'; var foo;", "foo.js"),
-    ).toMatchObject({
-      errorCount: 4,
-    });
-  });
 });

src/index.js

@@ -1,11 +1,9 @@
 const { getPrefixedPluginRules } = require("./plugins");
 const recommended = require("./recommended.json");
-const prettier = require("./prettier.json");
 
 module.exports = {
   configs: {
     recommended: recommended,
-    prettier: prettier,
   },
   rules: getPrefixedPluginRules(),
 };

src/semver.test.js

@@ -1,5 +1,4 @@
 const pkg = require("../package.json");
-const config = require("./base");
 
 describe("semver - should those tests break, consider releasing a new major version of the package", () => {
   it("dependencies", () => {
@@ -19,8 +18,4 @@ describe("semver - should those tests break, consider releasing a new major vers
       }, {});
     expect(devDependencies).toMatchSnapshot();
   });
-
-  it("custom config", () => {
-    expect(config).toMatchSnapshot();
-  });
 });