[IMP] Add Prettier and ESLint with --fix

This commit includes: - Using https://prettier.io/ for supported file formats (these include CSS, SCSS, JS, HTML, MD, YAML and others; see website). - Configure ESLint using `eslint-config-prettier` and removing stylistic checks to avoid conflicts with Prettier. - Add `Promise` as a builtin for v13 (this was missed before, so I take this chance to add that). - Format properly `.travis.yml` so that when it gets merged downstream it gets less diffs when passed trhough Prettier. - Use `eslint --fix` so we get less warnings and more fixes. Some insights: - See OCA/web#1441 as an example of how a web repo looks after this change. - A beta XML Prettier plugin exists, which could be used in the future to autoformat XML files too! - But it's not usable for us right now, as you can see in prettier/plugin-xml#13 (comment) - Once that's fixed, we can use a configuration similar to prettier/plugin-xml#17 (comment) to integrate here.
Tecnativa · Nov 21, 2019 · f805338 · f805338
1 parent 7190b98
commit f805338
Show file tree

Hide file tree

Showing 4 changed files with 111 additions and 160 deletions.
diff --git a/sample_files/.travis.yml b/sample_files/.travis.yml
@@ -1,9 +1,9 @@
 language: python
 cache:
   directories:
-  - $HOME/.cache/pip
-  # Add cache for pre-commit on repo that uses it (mandatory for >= 13)
-  - $HOME/.cache/pre-commit
+    - $HOME/.cache/pip
+    # Add cache for pre-commit on repo that uses it (mandatory for >= 13)
+    - $HOME/.cache/pre-commit
 
 python:
   # For branches <= 10.0, put `- "2.7.13"`
@@ -20,7 +20,7 @@ addons:
 #    Search your sources alias here:
 #      https://github.com/travis-ci/apt-source-whitelist/blob/master/ubuntu.json
     packages:
-      - expect-dev  # provides unbuffer utility
+      - expect-dev # provides unbuffer utility
 #     Search your packages here:
 #       https://github.com/travis-ci/apt-package-whitelist/blob/master/ubuntu-precise
 #     For wkhtmltopdf, see the env section below
@@ -69,21 +69,21 @@ jobs:
 
 env:
   global:
-  - VERSION="10.0" TESTS="0" LINT_CHECK="0" MAKEPOT="0"
-  # Set this variable to some version existing as linux-generic build on
-  # https://github.com/wkhtmltopdf/wkhtmltopdf/releases
-  # if you need to install wkhtmltopdf
-  # - WKHTMLTOPDF_VERSION="0.12.5"
-  # Set the above to install a `wkhtmltopdf` version that is not the one provided
-  # by the `pov-wkhtmltopdf` repo.
-  - PHANTOMJS_VERSION="latest"
-  # The above line controls the PhantomJS version that is used for JS testing.
-  #   It is not necessary to include this value unless you are altering the default.
-  #   Use `OS` to skip the PhantomJS upgrade & use the system version instead.
-  - WEBSITE_REPO="1"
-  # Use the above line to install dependencies that are required for website repos:
-  # * SASS & Bootstrap-SASS
-  # * Compass
+    - VERSION="10.0" TESTS="0" LINT_CHECK="0" MAKEPOT="0"
+    # Set this variable to some version existing as linux-generic build on
+    # https://github.com/wkhtmltopdf/wkhtmltopdf/releases
+    # if you need to install wkhtmltopdf
+    # - WKHTMLTOPDF_VERSION="0.12.5"
+    # Set the above to install a `wkhtmltopdf` version that is not the one provided
+    # by the `pov-wkhtmltopdf` repo.
+    - PHANTOMJS_VERSION="latest"
+    # The above line controls the PhantomJS version that is used for JS testing.
+    #   It is not necessary to include this value unless you are altering the default.
+    #   Use `OS` to skip the PhantomJS upgrade & use the system version instead.
+    - WEBSITE_REPO="1"
+    # Use the above line to install dependencies that are required for website repos:
+    # * SASS & Bootstrap-SASS
+    # * Compass
 
 install:
   - git clone --depth=1 https://github.com/OCA/maintainer-quality-tools.git ${HOME}/maintainer-quality-tools

diff --git a/sample_files/pre-commit-13.0/.eslintrc b/sample_files/pre-commit-13.0/.eslintrc
@@ -1,10 +1,12 @@
 {
+  "extends": ["prettier"],
   "globals": {
     "$": false,
     "_": false,
     "fuzzy": false,
     "jQuery": false,
     "moment": false,
+    "Promise": false,
     "odoo": false,
     "openerp": false,
     "self": false
@@ -21,7 +23,6 @@
     "no-catch-shadow": "warn",
     "no-class-assign": "warn",
     "no-cond-assign": "warn",
-    "no-confusing-arrow": "warn",
     "no-console": "off",
     "no-const-assign": "warn",
     "no-constant-condition": "warn",
@@ -47,10 +48,7 @@
     "no-extra-bind": "warn",
     "no-extra-boolean-cast": "warn",
     "no-extra-label": "warn",
-    "no-extra-parens": "warn",
-    "no-extra-semi": "warn",
     "no-fallthrough": "warn",
-    "no-floating-decimal": "warn",
     "no-func-assign": "warn",
     "no-implicit-coercion": ["warn", {
       "allow": ["~"]
@@ -61,20 +59,15 @@
     "no-inner-declarations": "warn",
     "no-invalid-regexp": "warn",
     "no-invalid-this": "off",
-    "no-irregular-whitespace": "warn",
     "no-iterator": "warn",
     "no-label-var": "warn",
     "no-labels": "warn",
     "no-lone-blocks": "warn",
     "no-lonely-if": "warn",
     "no-loop-func": "off",
     "no-magic-numbers": "off",
-    "no-mixed-operators": "warn",
     "no-mixed-requires": "warn",
-    "no-mixed-spaces-and-tabs": "warn",
-    "no-multi-spaces": "warn",
     "no-multi-str": "warn",
-    "no-multiple-empty-lines": "warn",
     "no-native-reassign": "warn",
     "no-negated-condition": "warn",
     "no-negated-in-lhs": "warn",
@@ -108,19 +101,14 @@
     "no-sequences": "warn",
     "no-shadow": "warn",
     "no-shadow-restricted-names": "warn",
-    "no-whitespace-before-property": "warn",
-    "no-spaced-func": "warn",
     "no-sparse-arrays": "warn",
     "no-sync": "warn",
-    "no-tabs": "warn",
     "no-ternary": "off",
-    "no-trailing-spaces": "warn",
     "no-this-before-super": "warn",
     "no-throw-literal": "warn",
     "no-undef": "warn",
     "no-undef-init": "warn",
     "no-undefined": "off",
-    "no-unexpected-multiline": "warn",
     "no-underscore-dangle": "off",
     "no-unmodified-loop-condition": "warn",
     "no-unneeded-ternary": "warn",
@@ -140,115 +128,56 @@
     "no-var": "off",
     "no-warning-comments": "off",
     "no-with": "warn",
-    "array-bracket-spacing": "off",
     "array-callback-return": "warn",
-    "arrow-body-style": "warn",
-    "arrow-parens": "warn",
-    "arrow-spacing": "off",
     "accessor-pairs": "warn",
     "block-scoped-var": "off",
-    "block-spacing": ["warn", "always"],
-    "brace-style": "warn",
     "callback-return": "warn",
     "camelcase": "off",
     "capitalized-comments": ["warn", "always", {
       "ignoreConsecutiveComments": true,
       "ignoreInlineComments": true
     }],
-    "comma-dangle": ["warn", "always-multiline"],
-    "comma-spacing": ["warn", {
-      "before": false,
-      "after": true
-    }],
-    "comma-style": "warn",
     "complexity": [
       "warn",
       15
     ],
-    "computed-property-spacing": "off",
     "consistent-return": "off",
     "consistent-this": "off",
     "constructor-super": "warn",
-    "curly": "warn",
     "default-case": "off",
-    "dot-location": ["warn", "property"],
     "dot-notation": "warn",
-    "eol-last": "warn",
     "eqeqeq": "warn",
     "func-names": "off",
-    "func-style": "off",
-    "generator-star-spacing": "off",
     "global-require": "warn",
     "guard-for-in": "off",
     "handle-callback-err": "warn",
     "id-blacklist": "warn",
     "id-length": "off",
     "id-match": "warn",
-    "indent": "warn",
     "init-declarations": "warn",
-    "jsx-quotes": "warn",
-    "key-spacing": "off",
-    "keyword-spacing": "warn",
-    "linebreak-style": [
-      "warn",
-      "unix"
-    ],
-    "lines-around-comment": "warn",
     "max-depth": "warn",
-    "max-len": ["warn", {
-      "code": 88,
-      "ignorePattern": "odoo\\.define\\(",
-      "tabWidth": 4
-    }],
     "max-lines": "off",
     "max-nested-callbacks": "warn",
     "max-params": "off",
     "max-statements": "off",
     "max-statements-per-line": "warn",
-    "multiline-ternary": "off",
     "new-cap": "off",
-    "new-parens": "warn",
     "newline-after-var": "off",
     "newline-before-return": "off",
-    "newline-per-chained-call": "off",
-    "object-curly-newline": ["warn", { "consistent": true }],
-    "object-curly-spacing": ["warn", "never"],
-    "object-property-newline": ["warn", {
-      "allowAllPropertiesOnSameLine": true
-    }],
     "object-shorthand": "off",
     "one-var": "off",
-    "one-var-declaration-per-line": "off",
     "operator-assignment": "warn",
-    "operator-linebreak": "warn",
-    "padded-blocks": "off",
-    "prefer-arrow-callback": "off",
     "prefer-const": "warn",
     "prefer-reflect": "off",
     "prefer-rest-params": "off",
     "prefer-spread": "off",
     "prefer-template": "off",
-    "quote-props": "off",
-    "quotes": "off",
     "radix": "warn",
     "require-yield": "warn",
-    "rest-spread-spacing": "off",
-    "semi": [
-      "warn",
-      "always"
-    ],
-    "semi-spacing": "warn",
     "sort-imports": "warn",
     "sort-vars": "off",
-    "space-before-blocks": "warn",
-    "space-before-function-paren": "warn",
-    "space-in-parens": "off",
-    "space-infix-ops": "off",
-    "space-unary-ops": "off",
     "spaced-comment": ["warn", "always"],
     "strict": ["warn", "function"],
-    "template-curly-spacing": "off",
-    "unicode-bom": "warn",
     "use-isnan": "warn",
     "valid-jsdoc": ["warn", {
       "prefer": {
@@ -280,12 +209,9 @@
     }],
     "valid-typeof": "warn",
     "vars-on-top": "off",
-    "wrap-iife": "warn",
-    "wrap-regex": "warn",
-    "yield-star-spacing": "off",
     "yoda": "warn"
   },
   "parserOptions": {
-      "ecmaVersion": 2017
+    "ecmaVersion": 2017
   }
 }