Add eslint and typescript checking 2

.github/workflows/check-base-branch-before-merge.yml

@@ -0,0 +1,34 @@
+name: Check Base Branch Before Merge
+
+on:
+  pull_request_review:
+    types: [submitted]
+
+jobs:
+  check-base-branch-before-merge:
+    if: github.event.review.state == 'APPROVED'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check base branch
+        run: |
+          git fetch origin --prune
+
+          CURRENT_BRANCH=${{ github.event.pull_request.head.ref }}
+          TARGET_BRANCH="${{ github.event.pull_request.base.ref }}"
+
+          COMMON_ANCESTOR=$(git merge-base origin/$CURRENT_BRANCH origin/$TARGET_BRANCH)
+          COMMITS_BEHIND=$(git rev-list --count origin/$TARGET_BRANCH ^$COMMON_ANCESTOR)
+
+          if [ "$COMMITS_BEHIND" -eq 0 ]; then
+            echo "Your branch is up-to-date with the target branch."
+          elif [ "$COMMITS_BEHIND" -eq 1 ]; then
+            echo "Your branch is 1 commit behind the target branch."
+            exit 1
+          else
+            echo "Your branch is $COMMITS_BEHIND commits behind the target branch."
+            exit 1
+          fi

.github/workflows/main.yml

@@ -0,0 +1,156 @@
+name: CI
+
+on: 
+  # push: -- just run on PRs for now
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  check-base-branch:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check base branch
+        run: |
+          git fetch origin --prune
+
+          CURRENT_BRANCH=${{ github.event.pull_request.head.ref }}
+          TARGET_BRANCH="${{ github.event.pull_request.base.ref }}"
+
+          COMMON_ANCESTOR=$(git merge-base origin/$CURRENT_BRANCH origin/$TARGET_BRANCH)
+          COMMITS_BEHIND=$(git rev-list --count origin/$TARGET_BRANCH ^$COMMON_ANCESTOR)
+
+          if [ "$COMMITS_BEHIND" -eq 0 ]; then
+            echo "Your branch is up-to-date with the target branch."
+          elif [ "$COMMITS_BEHIND" -eq 1 ]; then
+            echo "Your branch is 1 commit behind the target branch."
+            exit 1
+          else
+            echo "Your branch is $COMMITS_BEHIND commits behind the target branch."
+            exit 1
+          fi
+
+  build:
+    needs: [check-base-branch]
+
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgis/postgis:13-3.0
+        env:
+          POSTGRES_PASSWORD: postgis
+          POSTGRES_DB: ${{ github.event.repository.name }}
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+
+      - name: Install Java, GDAL, and other system dependencies
+        run: |
+          sudo apt update
+          sudo apt-get install libxml2-dev libpq-dev openjdk-8-jdk libgdal-dev libxslt-dev
+          echo Postgres and ES dependencies installed
+
+      - name: Install python packages
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install -r ${{ github.event.repository.name }}/install/requirements.txt
+          pip install -r ${{ github.event.repository.name }}/install/requirements_dev.txt
+          echo Python packages installed
+
+      - uses: ankane/setup-elasticsearch@v1
+        with:
+          elasticsearch-version: 8
+
+      - name: Check for missing migrations
+        run: |
+          python manage.py makemigrations --check
+
+      - name: Run unit tests
+        run: |
+          python -W default::DeprecationWarning -m coverage run manage.py test tests --pattern="*.py" --settings="tests.test_settings"
+
+      - name: Generate report coverage
+        run: |
+          coverage json
+
+      - name: Upload coverage report as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.json
+          overwrite: true
+
+  check-coverage:
+    needs: [check-base-branch, build]
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x' # Use the latest available version
+          check-latest: true
+
+      - name: Download coverage report artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report
+          path: .
+
+      - name: Report coverage
+        run: |
+          cat coverage.json
+
+      - name: Retrieve baseline coverage
+        run: |
+          git fetch origin ${{ github.event.pull_request.base.ref }}:${{ github.event.pull_request.base.ref }}
+
+          if ! git show ${{ github.event.pull_request.base.ref }}:coverage.json > /dev/null; then
+            echo "Error: coverage.json does not exist in the branch."
+            exit 1
+          fi
+
+          baseline_coverage=$(git show ${{ github.event.pull_request.base.ref }}:coverage.json | grep -o '"totals": {[^}]*' | grep -o '"percent_covered": [0-9.]*' | awk -F ': ' '{print $2}')
+          echo "$baseline_coverage" > .coverage_baseline
+
+      - name: Compare coverage with baseline
+        if: github.event_name == 'pull_request'
+        run: |
+          current_coverage=$(cat coverage.json | grep -o '"totals": {[^}]*' | grep -o '"percent_covered": [0-9.]*' | awk -F ': ' '{print $2}')
+          baseline_coverage=$(cat .coverage_baseline)
+
+          # Compare current coverage with baseline coverage using floating-point comparison
+          if awk -v current="$current_coverage" -v baseline="$baseline_coverage" 'BEGIN { exit (current < baseline) ? 0 : 1 }'; then
+            echo "Coverage decreased from $baseline_coverage% to $current_coverage%"
+            exit 1
+          else
+            echo "$baseline_coverage% == $current_coverage%, Coverage didn't decrease. Committing new coverage.json."
+
+            git config user.name github-actions
+            git config user.email [email protected]
+
+            git add -f coverage.json
+            git commit -m "automatically update coverage.json"
+            git push -f origin HEAD:${{ github.head_ref }}
+          fi

.gitignore

@@ -1,16 +1,19 @@
 *.pyc
 *.log
-*.DS_Store
 arches_rdm_example_project/logs
 arches_rdm_example_project/export_deliverables
 arches_rdm_example_project/cantaloupe/*
 arches_rdm_example_project/staticfiles
 arches_rdm_example_project/media/packages
 arches_rdm_example_project/media/node_modules
-arches_rdm_example_project/media/build/*
+arches_rdm_example_project/media/build/
 arches_rdm_example_project/uploadedfiles/*
 arches_rdm_example_project/settings_local.py
 arches_rdm_example_project/webpack/webpack-stats.json
 arches_rdm_example_project/webpack/webpack-user-config.js
 .vscode/
+.coverage
+coverage.*
+*.egg-info
+.DS_STORE
 CACHE

arches_rdm_example_project/.eslintrc.js

@@ -1,16 +1,23 @@
 module.exports = {
     "extends": [
-        "eslint:recommended"
+        "eslint:recommended",
+        'plugin:@typescript-eslint/recommended',
+        'plugin:vue/vue3-recommended',
     ],
+    "root": true,
     "env": {
         "browser": true,
         "es6": true,
         "node": true
     },
+    "parser": "vue-eslint-parser",
     "parserOptions": {
         "ecmaVersion": 11,
         "sourceType": "module",
-        "requireConfigFile": false
+        "requireConfigFile": false,
+        "parser": {
+            "ts": "@typescript-eslint/parser"
+        }
     },
     "globals": {
         "define": false,
@@ -25,20 +32,33 @@ module.exports = {
         "URLSearchParams": false,
         "fetch": false
     },
-    "ignorePatterns": [".eslintrc.js", "**/media/plugins/*"],
     "rules": {
         "semi": ["error", "always"],
-        "indent": ["error", 4],
-        "space-before-function-paren": ["error", "never"],
-        "no-extra-boolean-cast": 0, // 0=silence, 1=warning, 2=error
-        // allow async-await
-        'generator-star-spacing': 'off',
-        // allow debugger during development
-        'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
-        'no-unused-vars': [1, {
-            argsIgnorePattern: '^_'
-        }],
-        "camelcase": [1, {"properties": "always"}],
-    }
+    },
+    "overrides": [
+        {
+            "files": [ "*.vue" ],
+            "rules": {
+                "vue/html-indent": [2, 4],
+                "vue/this-in-template": "off"
+            }
+        },
+        {
+            "files": [ "*.js" ],
+            "rules": {
+                "indent": ["error", 4],
+                "space-before-function-paren": ["error", "never"],
+                "no-extra-boolean-cast": 0, // 0=silence, 1=warning, 2=error
+                // allow async-await
+                'generator-star-spacing': 'off',
+                // allow debugger during development
+                'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+                'no-unused-vars': [1, {
+                    argsIgnorePattern: '^_'
+                }],
+                "camelcase": [1, {"properties": "always"}],
+            }
+        }
+    ]
 };
 

arches_rdm_example_project/gettext.config.js

@@ -0,0 +1,43 @@
+
+module.exports = {
+    input: {
+      path: "./src", // only files in this directory are considered for extraction
+      include: ["**/*.vue"], // glob patterns to select files for extraction
+      exclude: [], // glob patterns to exclude files from extraction
+      jsExtractorOpts:[ // custom extractor keyword. default empty.
+          {
+            keyword: "__", // only extractor default keyword such as $gettext,use keyword to custom
+            options: {    // see https://github.com/lukasgeiter/gettext-extractor
+              content: {
+                replaceNewLines: "\n",
+              },
+              arguments: {
+                text: 0,
+              },
+            },
+          },
+          {
+            keyword: "_n", // $ngettext
+            options: {
+              content: {
+                replaceNewLines: "\n",
+              },
+              arguments: {
+                text: 0,
+                textPlural: 1,
+              },
+            },
+          },
+        ],
+        compileTemplate: false, // do not compile <template> tag when its lang is not html
+      },
+      output: {
+        path: "./locale", // output path of all created files
+        potPath: "./messages.pot", // relative to output.path, so by default "./src/language/messages.pot"
+        jsonPath: "./", // relative to output.path, so by default "./src/language/translations.json"
+        locales: ["en"],
+        flat: false, // don't create subdirectories for locales
+        linguas: false, // create a LINGUAS file
+        splitJson: true, // create separate json files for each locale. If used, jsonPath must end with a directory, not a file
+      },
+};

arches_rdm_example_project/install/requirements.txt

@@ -1 +1 @@
-arches~=7.5.0a1
+arches~=7.5.0a1

arches_rdm_example_project/install/requirements_dev.txt

@@ -0,0 +1,5 @@
+livereload
+sst
+coverage
+sauceclient
+django-silk==5.1.0

arches_rdm_example_project/nodemon.json

@@ -0,0 +1,5 @@
+{
+    "events": {
+      "start": "clear"
+    }
+}

arches_rdm_example_project/package.json

@@ -1,17 +1,27 @@
 {
     "name": "arches_rdm_example_project",
+    "license": "AGPL-3.0-only",
     "scripts": {
-        "build_production": "./media/node_modules/.bin/cross-env NODE_PATH=./media/node_modules NODE_OPTIONS=--max-old-space-size=2048 NODE_ENV=production ./media/node_modules/.bin/webpack --config webpack/webpack.config.prod.js",
-        "build_development": "./media/node_modules/.bin/cross-env NODE_PATH=./media/node_modules NODE_OPTIONS=--max-old-space-size=2048 ./media/node_modules/.bin/webpack --config webpack/webpack.config.dev.js",
-        "build_test": "./media/node_modules/.bin/cross-env NODE_PATH=./media/node_modules NODE_OPTIONS=--max-old-space-size=2048 ./media/node_modules/.bin/webpack --config webpack/webpack.config.dev.js --env test=true",
+        "build_development": "yarn eslint:check && yarn typescript:check && ./media/node_modules/.bin/cross-env NODE_PATH=./media/node_modules NODE_OPTIONS=--max-old-space-size=2048 ./media/node_modules/.bin/webpack --config webpack/webpack.config.dev.js",
+        "build_production": "yarn eslint:check && yarn typescript:check && ./media/node_modules/.bin/cross-env NODE_PATH=./media/node_modules NODE_OPTIONS=--max-old-space-size=2048 NODE_ENV=production ./media/node_modules/.bin/webpack --config webpack/webpack.config.prod.js",
+        "build_test": "yarn eslint:check && yarn typescript:check && ./media/node_modules/.bin/cross-env NODE_PATH=./media/node_modules NODE_OPTIONS=--max-old-space-size=2048 ./media/node_modules/.bin/webpack --config webpack/webpack.config.dev.js --env test=true",
+        "eslint:check": "./media/node_modules/.bin/eslint ./src --resolve-plugins-relative-to ./media --ext .vue,.ts --parser ./media/node_modules/vue-eslint-parser/index.js",
+        "eslint:watch": "./media/node_modules/.bin/nodemon --watch ./src --ext ts,vue --exec yarn --silent eslint:check",
+        "gettext:extract": "./media/node_modules/.bin/vue-gettext-extract",
+        "gettext:compile": "./media/node_modules/.bin/vue-gettext-compile",
+        "typescript:check": "./media/node_modules/.bin/vue-tsc --noEmit",
+        "typescript:watch": "./media/node_modules/.bin/vue-tsc --watch --noEmit",
         "start": "./media/node_modules/.bin/cross-env NODE_PATH=./media/node_modules NODE_OPTIONS=--max-old-space-size=2048 ./media/node_modules/.bin/webpack serve --config webpack/webpack.config.dev.js"
     },
     "devDependencies": {
-        "arches-dev-dependencies": "archesproject/arches-dev-dependencies#dev/7.5.x"
+        "arches-dev-dependencies": "archesproject/arches-dev-dependencies#dev/7.6.x"
     },
     "dependencies": {
-        "arches": "archesproject/arches#dev/7.5.x",
-        "arches_rdm": "archesproject/arches-rdm#main"
+        "arches": "archesproject/arches#dev/7.6.x",
+        "arches_rdm": "archesproject/arches-rdm"
     },
-    "nodeModulesPaths": {}
-}
+    "nodeModulesPaths": {},
+    "resolutions": {
+        "node-gyp": "^10.0.0"
+    }
+}