chore: linting with black, flake8, stylelint, and eslint/prettier

Author: fdintino

.babelrc

@@ -1,6 +1,5 @@
 {
   "sourceType": "unambiguous",
-  "plugins": ["@babel/plugin-transform-runtime"],
   "presets": [
     ["@babel/env", {
       "loose": true,

.editorconfig

@@ -1,53 +1,29 @@
+/* eslint-disable */
 module.exports = {
-  'extends': [
-    'airbnb-base/legacy',
+  "extends": [
+    "plugin:prettier/recommended"
   ],
-  'parserOptions': {
-    'sourceType': 'module',
-    'ecmaVersion': 2017,
+  "parser": "@babel/eslint-parser",
+  "parserOptions": {
+    "sourceType": "module",
+    "ecmaVersion": 2018,
   },
-  'env': {
-    'node': true,
-    'es6': true,
-  },
-  "rules": {
-    // The one assertion of personal preference: no spaces before parentheses
-    // of anonymous functions
-    'space-before-function-paren': ['error', {
-      anonymous: 'never',
-      named: 'never',
-      asyncArrow: 'always',
-    }],
-    // Temporarily disabled rules
-    //
-    // no-use-before-define is a good rule, but it would make the diff for
-    // linting the code even more inscrutible than it already is.
-    'no-use-before-define': 'off',
-    // Relax some rules
-    'no-cond-assign': ['error', 'except-parens'],
-    'no-unused-vars': ['error', {
-      'args': 'none',
-    }],
-    // Disable some overly-strict airbnb style rules
-    'no-underscore-dangle': 'off',
-    'no-param-reassign': 'off',
-    'class-methods-use-this': 'off',
-    'function-paren-newline': 'off',
-    'no-plusplus': 'off',
-    'object-curly-spacing': 'off',
-    'no-multi-assign': 'off',
-    'no-else-return': 'off',
-    // While technically useless from the point of view of the regex parser,
-    // escaping characters inside character classes is more consistent. I
-    // would say that they make the regular expression more readable, if the
-    // idea of readable regular expressions wasn't absurd on its face.
-    'no-useless-escape': 'off',
-    // I'm inclined to reverse this rule to be ['error', 'always'], but not just yet
-    // IE 8 is a thing of the past and trailing commas are useful.
-    'comma-dangle': 'off',
-  },
-  'globals': {
-    'django': false,
-    'grappelli': false
+  "env": {
+    "es6": true,
+    "browser": true
   },
+  "overrides": [
+    {
+      "files": ["webpack.config.js"],
+      "env": {
+        "node": true
+      },
+    },
+  ],
+  "ignorePatterns": [
+    "nested_admin/static/nested_admin/dist/",
+    "node_modules/",
+    ".tox",
+    "venv*"
+  ],
 };

.eslintrc.js

@@ -64,7 +64,7 @@ jobs:
       uses: actions/cache@v2
       with:
         path: nested_admin/tests/static
-        key: test-dist-${{ hashFiles('package-lock.json', '.github/workflows/test.yml', 'webpack.config.js', 'package.json', '.*rc*', 'frontend/**') }}
+        key: test-dist-${{ hashFiles('package-lock.json', '.github/workflows/test.yml', 'webpack.config.js', 'package.json', '.*rc*', 'nested_admin/static/nested_admin/src/**/*.*s') }}
 
     - name: Cache node_modules
       id: cache-node_modules
@@ -73,19 +73,20 @@ jobs:
         path: node_modules
         key: node_modules-${{ hashFiles('package-lock.json') }}
 
-    - name: Setup nodejs 14
-      if: steps.cache-test-dist.outputs.cache-hit != 'true' || steps.cache-node_modules.outputs.cache-hit != 'true'
-      uses: actions/setup-node@v2
+    - name: Setup nodejs
+      if: steps.cache-test-dist.outputs.cache-hit != 'true'
+      uses: actions/setup-node@v3
       with:
-        node-version: '14'
+        node-version: '16'
+        cache: 'npm'
 
     - name: npm ci
-      if: steps.cache-test-dist.outputs.cache-hit != 'true' || steps.cache-node_modules.outputs.cache-hit != 'true'
+      if: steps.cache-test-dist.outputs.cache-hit != 'true' && steps.cache-node_modules.outputs.cache-hit != 'true'
       run: |
         npm ci || npm ci || npm ci
 
     - name: Build instrumented static files
-      if: steps.cache-test-dist.outputs.cache-hit != 'true' || steps.cache-node_modules.outputs.cache-hit != 'true'
+      if: steps.cache-test-dist.outputs.cache-hit != 'true'
       run: |
         npm run build
 
@@ -115,6 +116,76 @@ jobs:
       env:
         CODECOV_NAME: ${{ github.workflow }}
 
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        tool: ["flake8", "black", "eslint", "stylelint"]
+        include:
+          - tool: flake8
+            language: python
+          - tool: black
+            language: python
+          - tool: eslint
+            language: javascript
+          - tool: stylelint
+            language: javascript
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/setup-python@v2
+      if: matrix.language == 'python'
+      with:
+        python-version: 3.9
+
+    - name: Cache node_modules
+      if: matrix.language == 'javascript'
+      id: cache-node_modules
+      uses: actions/cache@v2
+      with:
+        path: node_modules
+        key: node_modules-${{ hashFiles('package-lock.json') }}-lint
+        restore-keys: |
+          node_modules-${{ hashFiles('package-lock.json') }}
+
+    - name: Setup nodejs
+      if: matrix.language == 'javascript'
+      uses: actions/setup-node@v3
+      with:
+        node-version: '16'
+        cache: 'npm'
+
+    - name: npm ci
+      if: matrix.language == 'javascript' && steps.cache-node_modules.outputs.cache-hit != 'true'
+      run: |
+        npm ci || npm ci || npm ci
+
+    - name: Run black
+      if: matrix.tool == 'black'
+      uses: psf/black@stable
+      with:
+        src: "nested_admin docs setup.py"
+        version: "22.8.0"
+
+    - name: Install flake8
+      if: matrix.tool == 'flake8'
+      run: pip install flake8
+
+    - name: Run flake8
+      if: matrix.tool == 'flake8'
+      uses: suo/flake8-github-action@releases/v1
+      with:
+        checkName: 'lint'
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Run ${{ matrix.tool }}
+      if: matrix.language == 'javascript'
+      run: |
+        npm run lint:${{ matrix.tool }}
+
   report:
     if: always()
     needs: build
@@ -126,16 +197,15 @@ jobs:
           name: junit-reports
 
       - name: Publish tests report
-        uses: mikepenz/action-junit-report@5703ba1461f35871cde0208140d737d3e1eef38f
+        uses: mikepenz/action-junit-report@1a91e26932fb7ba410a31fab1f09266a96d29971
         with:
           report_paths: ./*.xml
-          github_token: ${{ secrets.GITHUB_TOKEN }}
           require_tests: true
           fail_on_failure: true
           check_name: Test Report
 
   success:
-    needs: report
+    needs: [lint, report]
     runs-on: ubuntu-latest
     name: Test Successful
     steps:

.github/workflows/test.yml

@@ -0,0 +1 @@
+16

.nvmrc

@@ -0,0 +1,8 @@
+/nested_admin/tests/static
+/nested_admin/static/nested_admin/dist
+node_modules
+venv
+.tox
+**/*.js
+**/*.html
+**/*.xml

.stylelintignore

@@ -0,0 +1,10 @@
+{
+  "extends": [
+    "stylelint-config-recommended-scss",
+    "stylelint-prettier/recommended"
+  ],
+  "overrides": [{
+    "files": ["**/*.scss"],
+    "customSyntax": "postcss-scss"
+  }]
+}

.stylelintrc

@@ -4,11 +4,11 @@
 from datetime import datetime
 
 
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
-os.environ['DJANGO_SETTINGS_MODULE'] = 'nested_admin.tests.settings'
+os.environ["DJANGO_SETTINGS_MODULE"] = "nested_admin.tests.settings"
 
 
 import django  # noqa
@@ -19,63 +19,80 @@
     django.setup()
 
 
-project = 'django-nested-admin'
-copyright = '%d, The Atlantic' % datetime.now().year
-author = 'The Atlantic'
+project = "django-nested-admin"
+copyright = "%d, The Atlantic" % datetime.now().year
+author = "The Atlantic"
 
 release = pkg_resources.get_distribution(project).version
-version = '.'.join(release.split('.')[:2])
+version = ".".join(release.split(".")[:2])
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.mathjax',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
 ]
 
 
 def setup(app):
-    app.add_stylesheet('nested_admin.css')
+    app.add_stylesheet("nested_admin.css")
 
 
-templates_path = ['_templates']
-source_suffix = '.rst'
-master_doc = 'index'
+templates_path = ["_templates"]
+source_suffix = ".rst"
+master_doc = "index"
 language = None
 
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 add_function_parentheses = True
 add_module_names = False
-pygments_style = 'trac'
+pygments_style = "trac"
 todo_include_todos = False
 
-html_theme = 'default'
-html_static_path = ['_static']
-html_last_updated_fmt = '%b %d, %Y'
+html_theme = "default"
+html_static_path = ["_static"]
+html_last_updated_fmt = "%b %d, %Y"
 html_show_sphinx = False
 
-htmlhelp_basename = 'django-nested-admindoc'
+htmlhelp_basename = "django-nested-admindoc"
 
 latex_elements = {}
 latex_documents = [
-    (master_doc, 'django-nested-admin.tex', 'django-nested-admin Documentation',
-     'The Atlantic', 'manual'),
+    (
+        master_doc,
+        "django-nested-admin.tex",
+        "django-nested-admin Documentation",
+        "The Atlantic",
+        "manual",
+    ),
 ]
 
 man_pages = [
-    (master_doc, 'django-nested-admin', 'django-nested-admin Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "django-nested-admin",
+        "django-nested-admin Documentation",
+        [author],
+        1,
+    )
 ]
 
 texinfo_documents = [
-    (master_doc, 'django-nested-admin', 'django-nested-admin Documentation',
-     author, 'django-nested-admin', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "django-nested-admin",
+        "django-nested-admin Documentation",
+        author,
+        "django-nested-admin",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
-    extensions.insert(0, 'readthedocs_ext.readthedocs')
+    extensions.insert(0, "readthedocs_ext.readthedocs")
 
     import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
+
+    html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]