Add linting tools configuration for backend (Ruff) and frontend (ESLint/Prettier)

Co-authored-by: lstein <111189+lstein@users.noreply.github.com>

Author: Copilot

.github/copilot-instructions.md

@@ -42,13 +42,15 @@ PhotoMapAI/
 - Prefer f-strings for string formatting
 - Use pathlib.Path for file path operations instead of os.path
 - Import organization: standard library → third-party → local imports
+- Python files must pass ruff check
 
 #### JavaScript
 - Use ES6 modules with explicit imports/exports
 - Use const/let instead of var
 - Use descriptive function and variable names
 - Add comments for complex logic, especially in event handlers
 - Follow existing file structure: one module per file with clear responsibilities
+- JavaScript files must pass `npm lint` and `npm run format:check`
 
 ### Testing
 

.github/workflows/deploy.yml

@@ -2,43 +2,61 @@ name: Deploy Release
 
 on:
   workflow_dispatch:
-  release:
+  release: 
     types: [published]
+
 jobs:
-  tag-release:
+  tag-release: 
     runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.get_version.outputs.version }}
+      tag:  ${{ steps.get_version.outputs.tag }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v5
-        with:
+        with: 
           python-version: '3.12'
 
       - name: Extract version from pyproject.toml
         id: get_version
         run: |
           VERSION=$(python -c "
-          try:
+          try: 
               import tomllib
               with open('pyproject.toml', 'rb') as f:
                   data = tomllib.load(f)
               print(data['project']['version'])
           except Exception as e:
+              import sys
               print(f'Error reading version: {e}', file=sys.stderr)
               exit(1)
           ")
           echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "tag=v$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Check if tag exists
+        id: check_tag
+        run: |
+          if git ls-remote --tags origin | grep -q "refs/tags/v${{ steps.get_version.outputs.version }}"; then
+            echo "Tag already exists"
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "Tag does not exist"
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
 
       - name: Tag the release
+        if: steps.check_tag.outputs.exists == 'false'
         run: |
           git config user.name "github-actions"
           git config user.email "github-actions@github.com"
           git tag v${{ steps.get_version.outputs.version }}
           git push origin v${{ steps.get_version.outputs.version }}
 
-  deploy-pypi:
+  deploy-pypi: 
     needs: tag-release
     uses: ./.github/workflows/deploy-pypi.yml
     secrets:
@@ -56,5 +74,7 @@ jobs:
     uses: ./.github/workflows/deploy-pyinstaller.yml
 
   upload-release:
-    needs: [deploy-pypi, deploy-dockerhub, deploy-pyinstaller]
+    needs: [tag-release, deploy-pypi, deploy-dockerhub, deploy-pyinstaller]
     uses: ./.github/workflows/upload-artifacts.yml
+    with:
+      tag_name: ${{ needs.tag-release.outputs.tag }}

.github/workflows/lint.yml

@@ -0,0 +1,56 @@
+name: Lint Code
+
+on:
+  push:
+    branches: [ master, main ]
+  pull_request:
+    branches: [ master, main ]
+
+permissions:
+  contents: read
+
+jobs:
+  backend-lint:
+    name: Backend Linting (Ruff)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[development]
+
+      - name: Run Ruff
+        run: |
+          ruff check photomap tests
+
+  frontend-lint:
+    name: Frontend Linting (ESLint & Prettier)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint
+
+      - name: Run Prettier check
+        run: npm run format:check

.github/workflows/upload-artifacts.yml

@@ -1,14 +1,19 @@
 name: Upload Release Artifacts
 
 on:
-    workflow_call:
+  workflow_call: 
+    inputs:
+      tag_name: 
+        required: true
+        type: string
+
 jobs:
-  upload-release:
+  upload-release: 
     runs-on: ubuntu-latest
     steps:
       - name: Download CPU installer package artifacts
         uses: actions/download-artifact@v4
-        with:
+        with: 
           pattern: "*-cpu-*"
           path: artifacts
 
@@ -18,6 +23,7 @@ jobs:
       - name: Upload artifacts to GitHub Release
         uses: softprops/action-gh-release@v2
         with:
+          tag_name: ${{ inputs.tag_name }}
           files: artifacts/*-cpu-*/*
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.prettierignore

@@ -0,0 +1,9 @@
+node_modules
+dist
+build
+coverage
+.pytest_cache
+__pycache__
+*.min.js
+package-lock.json
+*.pyc

.prettierrc

@@ -0,0 +1,10 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": false,
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "arrowParens": "always",
+  "endOfLine": "lf"
+}

Makefile

@@ -11,6 +11,9 @@ help:
 	@echo "docker-demo      Build the Docker demo site image."
 	@echo "docs             Serve the mkdocs site with live reload."
 	@echo "deploy-docs      Deploy the mkdocs site to GitHub pages."
+	@echo "backend-lint     Run Python backend linting with Ruff."
+	@echo "frontend-lint    Run JavaScript frontend linting with ESLint and Prettier."
+	@echo "lint             Run both backend and frontend linting."
 
 # Run the unit tests
 test:
@@ -48,3 +51,26 @@ docs:
 
 deploy-docs:
 	mkdocs gh-deploy
+
+# Run backend linting with Ruff
+# fix with ruff check photomap tests photomap --fix
+.PHONY: backend-lint
+backend-lint:
+	@echo "Running Ruff on Python backend..."
+	ruff check photomap tests photomap
+
+# Run frontend linting with ESLint and Prettier
+# Fix with npm run lint:fix
+#          npm run format
+.PHONY: frontend-lint
+frontend-lint:
+	@echo "Installing npm dependencies if needed..."
+	npm install
+	@echo "Running ESLint on JavaScript frontend..."
+	npm run lint
+	@echo "Running Prettier check on JavaScript frontend..."
+	npm run format:check
+
+# Run both backend and frontend linting
+.PHONY: lint
+lint: backend-lint frontend-lint

eslint.config.js

@@ -0,0 +1,105 @@
+export default [
+  {
+    ignores: [
+      '**/node_modules/**',
+      '**/dist/**',
+      '**/build/**',
+      '**/.pytest_cache/**',
+      '**/__pycache__/**',
+      '**/coverage/**',
+    ],
+  },
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      globals: {
+        // Browser globals
+        window: 'readonly',
+        document: 'readonly',
+        console: 'readonly',
+        localStorage: 'readonly',
+        sessionStorage: 'readonly',
+        fetch: 'readonly',
+        FormData: 'readonly',
+        URLSearchParams: 'readonly',
+        URL: 'readonly',
+        setTimeout: 'readonly',
+        clearTimeout: 'readonly',
+        setInterval: 'readonly',
+        clearInterval: 'readonly',
+        alert: 'readonly',
+        confirm: 'readonly',
+        prompt: 'readonly',
+        CustomEvent: 'readonly',
+        Event: 'readonly',
+        MouseEvent: 'readonly',
+        KeyboardEvent: 'readonly',
+        TouchEvent: 'readonly',
+        ResizeObserver: 'readonly',
+        IntersectionObserver: 'readonly',
+        MutationObserver: 'readonly',
+        HTMLElement: 'readonly',
+        Element: 'readonly',
+        Node: 'readonly',
+        NodeList: 'readonly',
+        Blob: 'readonly',
+        File: 'readonly',
+        FileReader: 'readonly',
+        Image: 'readonly',
+        navigator: 'readonly',
+        performance: 'readonly',
+        requestAnimationFrame: 'readonly',
+        getComputedStyle: 'readonly',
+        // Plotly global (used in umap.js)
+        Plotly: 'readonly',
+        // Swiper global (used in swiper.js)
+        Swiper: 'readonly',
+      },
+    },
+    rules: {
+      // Possible errors
+      'no-console': 'off',
+      'no-debugger': 'warn',
+      'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+      'no-undef': 'error',
+      
+      // Best practices
+      'eqeqeq': ['error', 'always'],
+      'curly': ['error', 'all'],
+      'no-eval': 'error',
+      'no-implied-eval': 'error',
+      'no-with': 'error',
+      'no-new-func': 'error',
+      
+      // ES6+
+      'prefer-const': 'warn',
+      'no-var': 'warn',
+      'prefer-arrow-callback': 'warn',
+      'arrow-spacing': 'error',
+      
+      // Style (mostly handled by Prettier, but some logical style rules)
+      // Note: quotes handled by Prettier, semi retained for logical consistency
+      'semi': ['error', 'always'],
+    },
+  },
+  {
+    files: ['tests/**/*.js', '**/*.test.js'],
+    languageOptions: {
+      globals: {
+        // Jest globals
+        describe: 'readonly',
+        it: 'readonly',
+        test: 'readonly',
+        expect: 'readonly',
+        beforeEach: 'readonly',
+        afterEach: 'readonly',
+        beforeAll: 'readonly',
+        afterAll: 'readonly',
+        jest: 'readonly',
+        global: 'readonly',
+      },
+    },
+  },
+];