Update .pre-commit-config and apply ruff-format and eslint rules

Author: jochenklar

.pre-commit-config.yaml

@@ -1,12 +1,37 @@
-exclude: assets\/
-
 repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: 3e8a8703264a2f4a69428a0aa4dcb512790b2c8c  # frozen: v6.0.0
     hooks:
       - id: check-ast
       - id: check-json
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
       - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: c60c980e561ed3e73101667fe8365c609d19a438  # frozen: v0.15.9
+    hooks:
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    rev: d72e5408a82df0b0cb6b9c878fb8cb4e947c1859  # frozen: v10.2.0
+    hooks:
+      - id: eslint
+        args: [--fix, --color]
+        additional_dependencies:
+          - eslint@9.39.4
+          - eslint-plugin-react@7.37.5
+          - eslint-plugin-simple-import-sort@12.1.1
+          - react@18.3.1
+
+  - repo: https://github.com/crate-ci/typos
+    rev: f06b85043a5ab470afbb0a5592456e733243983a  # frozen: v1
+    hooks:
+    - id: typos

.ruff.toml

@@ -0,0 +1,47 @@
+target-version = "py310"
+line-length = 120
+
+[lint]
+select = [
+    "B",    # flake8-bugbear
+    "C4",   # flake8-comprehensions
+    "E",    # pycodestyle
+    "F",    # pyflakes
+    "I",    # isort
+    "PGH",  # pygrep-hooks
+    "RUF",  # ruff
+    "UP",   # pyupgrade
+    "W",    # pycodestyle
+    "YTT",  # flake8-2020
+]
+
+[format]
+quote-style = "single"
+
+[lint.isort]
+known-first-party = [
+    "isimip_data"
+]
+section-order = [
+  "future",
+  "standard-library",
+  "pytest",
+  "django",
+  "rest_framework",
+  "third-party",
+  "first-party",
+  "local-folder"
+]
+
+[lint.isort.sections]
+pytest = ["pytest"]
+django = ["django"]
+rest_framework = ["rest_framework"]
+
+[lint.per-file-ignores]
+"config/settings/*.py" = [
+  "F401",
+  "F403",
+  "F405",
+  "F821",
+]

README.md

@@ -121,7 +121,7 @@ The definition YAML files however can be changed without touching the JavaScript
 ...
 ```
 
-Here `1850soc` only applies to the givem set of sectors and only to `ISIMIP3b`, while `histsoc` is used both in `ISIMIP3a` and `ISIMIP3b` and in every sector. Some attributes (e.g. `frequency` in `definitions/variable`) can have objects as value, which the are evaluated for the particular sector.
+Here `1850soc` only applies to the given set of sectors and only to `ISIMIP3b`, while `histsoc` is used both in `ISIMIP3a` and `ISIMIP3b` and in every sector. Some attributes (e.g. `frequency` in `definitions/variable`) can have objects as value, which the are evaluated for the particular sector.
 
 In order to add a new sector, the following steps need to be taken:
 

app/js/components/Pattern.jsx

@@ -17,7 +17,7 @@ const Pattern = () => {
       .replaceAll('\\d{4}', '')                         // remove \d{4} etc.
       .replaceAll('\?P', '')                            // remove ?P
       .replaceAll('?', '')                              // remove ?
-      .replaceAll('(<', '<').replaceAll('>)', '>')      // remove parentesis around (< ... >)
+      .replaceAll('(<', '<').replaceAll('>)', '>')      // remove parentheses around (< ... >)
       .replaceAll(/>_/g, '>@').replaceAll(/_</g, '@<')  // replace underscore between identifiers with @
       .replaceAll('_', '-')                             // replace remaining _ with -
       .replaceAll('@', '_')                             // replace @ with _

app/js/utils/filter.js

@@ -1,15 +1,19 @@
 export const filterRows = (config, rows, group3) => {
   if (Array.isArray(rows)) {
     return rows.filter(row => {
-        if (row.simulation_rounds === undefined || row.simulation_rounds.includes(config.simulation_round)) {
-            if (row.products === undefined || row.products.filter(product => config.products.includes(product)).length) {
-                if (row.sectors === undefined || config.sectors.length == 0 || row.sectors.filter(sector => config.sectors.includes(sector)).length) {
-                    return true
-                }
-            }
+      if (row.simulation_rounds === undefined || row.simulation_rounds.includes(config.simulation_round)) {
+        if (row.products === undefined || row.products.filter(product => config.products.includes(product)).length) {
+          if (
+            row.sectors === undefined ||
+            config.sectors.length == 0 ||
+            row.sectors.filter(sector => config.sectors.includes(sector)).length
+          ) {
+            return true
+          }
         }
+      }
 
-        return false
+      return false
     }).filter(row => {
       return row.hidden != true
     }).filter(row => {
@@ -34,7 +38,7 @@ export const filterField = (config, field) => {
       } else if (config.sectors.length == 1) {
         return (typeof field[config.sectors[0]] === 'undefined') ? field.other : field[config.sectors[0]]
       } else {
-        return Object.fromEntries(Object.entries(field).filter(([sector, value]) => {
+        return Object.fromEntries(Object.entries(field).filter((sector) => {
           if (sector == 'other') {
             // add the "other" entry only if there is a sector in the config which is not in the field
             return config.sectors.filter(s => !Object.keys(field).includes(s)).length > 0

app/js/utils/location.js

@@ -23,13 +23,19 @@ const parseLocation = () => {
     }
 
     const simulation_round = first(tokens)
-    if (definitions.simulation_round.map((simulation_round) => simulation_round.specifier)
-                                    .includes(simulation_round)) {
+    if (
+      definitions.simulation_round
+        .map((simulation_round) => simulation_round.specifier)
+        .includes(simulation_round)
+    ) {
       config.simulation_round = simulation_round
     }
 
     const sectors = tokens.slice(1)
-    if (definitions.sector.some((sector) => sectors.includes(sector.specifier))) {
+    if (
+      definitions.sector
+        .some((sector) => sectors.includes(sector.specifier))
+    ) {
       config.sectors = sectors
     }
 
@@ -99,4 +105,4 @@ const buildPath = (config) => {
   return path
 }
 
-export { parseLocation, updateLocation, parseAnchor, updateAnchor, buildPath }
+export { buildPath, parseAnchor, parseLocation, updateAnchor, updateLocation }

app/js/utils/ls.js

@@ -5,23 +5,35 @@ const getConfig = () => {
   const definitions = window.initialState.definitions
 
   const simulation_round = ls.get('simulation_round')
-  if (definitions.simulation_round.map((simulation_round) => simulation_round.specifier)
-                                  .includes(simulation_round)) {
+  if (
+    definitions.simulation_round
+      .map((simulation_round) => simulation_round.specifier)
+      .includes(simulation_round)
+  ) {
     config.simulation_round = simulation_round
   }
 
   const sectors = ls.get('sectors') ? JSON.parse(ls.get('sectors')) : []
-  if (definitions.sector.some((sector) => sectors.includes(sector.specifier))) {
+  if (
+    definitions.sector
+      .some((sector) => sectors.includes(sector.specifier))
+  ) {
     config.sectors = sectors
   }
 
   const experiments = ls.get('experiments') ? JSON.parse(ls.get('experiments')) : []
-  if (definitions.experiments.some((experiment) => experiments.includes(experiment.specifier))) {
+  if (
+    definitions.experiments
+      .some((experiment) => experiments.includes(experiment.specifier))
+  ) {
     config.experiments = experiments
   }
 
   const groups = ls.get('groups') ? JSON.parse(ls.get('groups')) : []
-  if (definitions.group.some((group) => groups.includes(group.specifier))) {
+  if (
+    definitions.group
+      .some((group) => groups.includes(group.specifier))
+  ) {
     config.groups = groups
   }
 

build/csvtables.py

@@ -1,9 +1,10 @@
 from pathlib import Path
 
-from utils import filter_row, filter_rows, read_definitions, write_csv, setup_logs
+from utils import filter_row, filter_rows, read_definitions, setup_logs, write_csv
 
 setup_logs()
 
+
 def main():
     definitions = read_definitions()
 
@@ -23,8 +24,17 @@ def main():
             )
 
             variable_definitions = []
-            variable_fieldnames = ['group', 'specifier', 'long_name', 'units', 'resolution', 'frequency',
-                                   'valid_min', 'valid_max', 'comment']
+            variable_fieldnames = [
+                'group',
+                'specifier',
+                'long_name',
+                'units',
+                'resolution',
+                'frequency',
+                'valid_min',
+                'valid_max',
+                'comment',
+            ]
             for row in filter_rows(definitions['variable'], simulation_round, 'OutputData', sector=sector):
                 variable_definitions.append(filter_row(row, simulation_round, 'OutputData', sector=sector))
 
@@ -34,5 +44,5 @@ def main():
             write_csv(output_path, variable_definitions, variable_fieldnames)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()

build/definitions.py

@@ -1,9 +1,10 @@
 from pathlib import Path
 
-from utils import filter_row, filter_rows, get_commit_hash, read_definitions, write_json, setup_logs
+from utils import filter_row, filter_rows, get_commit_hash, read_definitions, setup_logs, write_json
 
 setup_logs()
 
+
 def main():
     definitions = read_definitions()
 
@@ -16,36 +17,46 @@ def main():
         for product in products:
             if product.endswith('InputData'):
                 for category in categories:
-                    output_path = Path('output').joinpath('definitions') \
-                                                .joinpath(simulation_round).joinpath(product).joinpath(category) \
-                                                .with_suffix('.json')
-
-                    output_definitions = {
-                        'commit': get_commit_hash()
-                    }
+                    output_path = (
+                        Path('output')
+                        .joinpath('definitions')
+                        .joinpath(simulation_round)
+                        .joinpath(product)
+                        .joinpath(category)
+                        .with_suffix('.json')
+                    )
+
+                    output_definitions = {'commit': get_commit_hash()}
                     for definition_name, rows in definitions.items():
                         output_definitions[definition_name] = []
                         for row in filter_rows(rows, simulation_round, product, category=category):
-                            output_definitions[definition_name].append(filter_row(row, simulation_round, product, category=category))
+                            output_definitions[definition_name].append(
+                                filter_row(row, simulation_round, product, category=category)
+                            )
 
                     write_json(output_path, output_definitions)
 
             else:
                 for sector in sectors:
-                    output_path = Path('output').joinpath('definitions') \
-                                                .joinpath(simulation_round).joinpath(product).joinpath(sector) \
-                                                .with_suffix('.json')
-
-                    output_definitions = {
-                        'commit': get_commit_hash()
-                    }
+                    output_path = (
+                        Path('output')
+                        .joinpath('definitions')
+                        .joinpath(simulation_round)
+                        .joinpath(product)
+                        .joinpath(sector)
+                        .with_suffix('.json')
+                    )
+
+                    output_definitions = {'commit': get_commit_hash()}
                     for definition_name, rows in definitions.items():
                         output_definitions[definition_name] = []
                         for row in filter_rows(rows, simulation_round, product, sector=sector):
-                            output_definitions[definition_name].append(filter_row(row, simulation_round, product, sector=sector))
+                            output_definitions[definition_name].append(
+                                filter_row(row, simulation_round, product, sector=sector)
+                            )
 
                     write_json(output_path, output_definitions)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()

build/glossary.py

@@ -4,10 +4,11 @@
 
 setup_logs()
 
+
 def main():
     glossary = {
         'commit': get_commit_hash(),
-        'terms': {}
+        'terms': {},
     }
 
     for identifier, rows in read_definitions().items():
@@ -24,5 +25,5 @@ def main():
     write_json(glossary_path, glossary)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     main()