Merge pull request #2 from duckduckgo:prettier-tweaks

Changes to support Prettier

README.md

@@ -0,0 +1,38 @@
+# DDG shared eslint configuration
+
+This is a shared eslint configuration used across several DDG projects.
+
+## How to set up your project with this config
+
+- This config is meant to be used with ESLint 9+ AND Prettier, so make sure you are using those in your project.
+- add a dev NPM dependency: `github:duckduckgo/eslint-config#<GIT_COMMIT_OR_TAG>`
+- in your `eslint.config.js`, import this config and put it in the configuration array. You probably want it after other "recommended" configs, and before project-specific rules.
+
+  ```js
+  import someConfig from "some-other-config-you-use";
+  import ddgConfig from '@duckduckgo/eslint-config'
+  export default [
+      someConfig,
+      ...ddgConfig,
+      {
+          rules: {
+              // your project-specific rules here
+          },
+      }
+  ];
+  ```
+
+## Prettier is required
+This config disables ESLint formatting rules (through `eslint-config-prettier`), so you are expected to rely on Prettier to do the formatting. Make sure you have Prettier set up in your project.
+
+## ESLint plugins
+This config **already includes** the following plugins, so you don't need to install them explicitly:
+- `eslint-plugin-n`
+- `eslint-plugin-import`
+- `eslint-plugin-promise`
+- `eslint-config-prettier`
+
+It also includes **recommended** configuration from `@eslint/js` (but not for other plugins).
+
+## TypeScript
+This config does not include TypeScript-specific rules, and does not depend on `typescript-eslint`. The reason for that is that typescript plugin disables some standard JS rules, and this would mess things up for pure-JS projects. If you are using TypeScript, you can add `typescript-eslint` to your project and configure it separately. You can check existing DDG projects for examples.

index.js

@@ -2,9 +2,11 @@ import nodePlugin from "eslint-plugin-n";
 import importPlugin from 'eslint-plugin-import';
 import promisePlugin from 'eslint-plugin-promise';
 import js from '@eslint/js';
+import eslintConfigPrettier from "eslint-config-prettier";
 
 export default [
     js.configs.recommended,
+    eslintConfigPrettier,
 
     {
         plugins: {
@@ -14,8 +16,6 @@ export default [
         },
 
         rules: {
-            "indent": ["error", 4],
-
             // revised rules from "standard"
             "no-var": "warn",
             "object-shorthand": [
@@ -46,10 +46,6 @@ export default [
                     "ignoreGlobals": true
                 }
             ],
-            "curly": [
-                "error",
-                "multi-line"
-            ],
             "default-case-last": "error",
             "dot-notation": [
                 "error",
@@ -92,32 +88,6 @@ export default [
                 }
             ],
             "no-lone-blocks": "error",
-            "no-mixed-operators": [
-                "error",
-                {
-                    "groups": [
-                        [
-                            "==",
-                            "!=",
-                            "===",
-                            "!==",
-                            ">",
-                            ">=",
-                            "<",
-                            "<="
-                        ],
-                        [
-                            "&&",
-                            "||"
-                        ],
-                        [
-                            "in",
-                            "instanceof"
-                        ]
-                    ],
-                    "allowSamePrecedence": true
-                }
-            ],
             "no-multi-str": "error",
             "no-new": "error",
             "no-new-func": "error",
@@ -191,10 +161,6 @@ export default [
                     "disallowRedundantWrapping": true
                 }
             ],
-            "quote-props": [
-                "error",
-                "as-needed"
-            ],
             "spaced-comment": [
                 "error",
                 "always",

package.json

@@ -14,6 +14,7 @@
     },
     "dependencies": {
         "@eslint/js": "^9.13.0",
+        "eslint-config-prettier": "^9.1.0",
         "eslint-plugin-import": "^2.31.0",
         "eslint-plugin-n": "^17.11.1",
         "eslint-plugin-promise": "^7.1.0"