Bump webpack from 5.101.0 to 5.101.3 in the webpack group

Bumps the webpack group with 1 update: [webpack](https://github.com/webpack/webpack).


Updates `webpack` from 5.101.0 to 5.101.3
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](https://github.com/webpack/webpack/compare/v5.101.0...v5.101.3)

---
updated-dependencies:
- dependency-name: webpack
  dependency-version: 5.101.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: webpack
...

Signed-off-by: dependabot[bot] <support@github.com>

.eslintrc.json

@@ -11,7 +11,12 @@
     "eslint-plugin-jsonc",
     "eslint-plugin-rxjs",
     "eslint-plugin-simple-import-sort",
-    "eslint-plugin-import-newlines"
+    "eslint-plugin-import-newlines",
+    "dspace-angular-ts",
+    "dspace-angular-html"
+  ],
+  "ignorePatterns": [
+    "lint/test/fixture"
   ],
   "overrides": [
     {
@@ -21,7 +26,8 @@
       "parserOptions": {
         "project": [
           "./tsconfig.json",
-          "./cypress/tsconfig.json"
+          "./cypress/tsconfig.json",
+          "./lint/tsconfig.json"
         ],
         "createDefaultProgram": true
       },
@@ -38,7 +44,10 @@
           "error",
           2,
           {
-            "SwitchCase": 1
+            "SwitchCase": 1,
+            "ignoredNodes": [
+              "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
+            ]
           }
         ],
         "max-classes-per-file": [
@@ -155,6 +164,7 @@
         "@angular-eslint/no-output-native": "warn",
         "@angular-eslint/no-output-on-prefix": "warn",
         "@angular-eslint/no-conflicting-lifecycle": "warn",
+        "@angular-eslint/use-lifecycle-interface": "error",
 
         "@typescript-eslint/no-inferrable-types":[
           "error",
@@ -212,6 +222,15 @@
         "@typescript-eslint/no-unsafe-return": "off",
         "@typescript-eslint/restrict-template-expressions": "off",
         "@typescript-eslint/require-await": "off",
+        "@typescript-eslint/no-base-to-string": [
+          "error",
+          {
+            "ignoredTypeNames": [
+              "ResourceType",
+              "Error"
+            ]
+          }
+        ],
 
         "deprecation/deprecation": "warn",
 
@@ -238,7 +257,12 @@
           "method"
         ],
 
-        "rxjs/no-nested-subscribe": "off"     // todo: go over _all_ cases
+        "rxjs/no-nested-subscribe": "off",     // todo: go over _all_ cases
+
+        // Custom DSpace Angular rules
+        "dspace-angular-ts/themed-component-classes": "error",
+        "dspace-angular-ts/themed-component-selectors": "error",
+        "dspace-angular-ts/themed-component-usages": "error"
       }
     },
     {
@@ -253,7 +277,10 @@
         "createDefaultProgram": true
       },
       "rules": {
-        "prefer-const": "off"
+        "prefer-const": "off",
+
+        // Custom DSpace Angular rules
+        "dspace-angular-ts/themed-component-usages": "error"
       }
     },
     {
@@ -262,17 +289,25 @@
       ],
       "extends": [
         "plugin:@angular-eslint/template/recommended"
-      ]
+      ],
+      "rules": {
+        // Custom DSpace Angular rules
+        "dspace-angular-html/themed-component-usages": "error",
+        "dspace-angular-html/no-disabled-attribute-on-button": "error"
+      }
     },
     {
       "files": [
         "*.json5"
       ],
       "extends": [
-        "plugin:jsonc/recommended-with-jsonc"
+        "plugin:jsonc/recommended-with-json5"
       ],
       "rules": {
-        "no-irregular-whitespace": "error",
+        // The ESLint core no-irregular-whitespace rule doesn't work well in JSON
+        // See: https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-irregular-whitespace.html
+        "no-irregular-whitespace": "off",
+        "jsonc/no-irregular-whitespace": "error",
         "no-trailing-spaces": "error",
         "jsonc/comma-dangle": [
           "error",

.gitattributes

@@ -13,4 +13,7 @@
 *.css eol=lf
 *.scss eol=lf
 *.html eol=lf
-*.svg eol=lf
+*.svg eol=lf
+
+# Generated documentation should have LF line endings to reduce git noise
+docs/lint/**/*.md eol=lf

.github/workflows/build.yml

@@ -7,7 +7,8 @@ name: Build
 on: [push, pull_request]
 
 permissions:
-  contents: read  #  to fetch code (actions/checkout)
+  contents: read  # to fetch code (actions/checkout)
+  packages: read  # to fetch private images from GitHub Container Registry (GHCR)
 
 jobs:
   tests:
@@ -28,6 +29,8 @@ jobs:
       DSPACE_CACHE_SERVERSIDE_ANONYMOUSCACHE_MAX: 0
       # Tell Cypress to run e2e tests using the same UI URL
       CYPRESS_BASE_URL: http://127.0.0.1:4000
+      # Disable the cookie consent banner in e2e tests to avoid errors because of elements hidden by it
+      DSPACE_INFO_ENABLECOOKIECONSENTPOPUP: false
       # When Chrome version is specified, we pin to a specific version of Chrome
       # Comment this out to use the latest release
       #CHROME_VERSION: "90.0.4430.212-1"
@@ -35,6 +38,9 @@ jobs:
       NODE_OPTIONS: '--max-old-space-size=4096'
       # Project name to use when running "docker compose" prior to e2e tests
       COMPOSE_PROJECT_NAME: 'ci'
+      # Docker Registry to use for Docker compose scripts below.
+      # We use GitHub's Container Registry to avoid aggressive rate limits at DockerHub.
+      DOCKER_REGISTRY: ghcr.io
     strategy:
       # Create a matrix of Node versions to test against (in parallel)
       matrix:
@@ -74,7 +80,7 @@ jobs:
         id: yarn-cache-dir-path
         run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
       - name: Cache Yarn dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           # Cache entire Yarn cache directory (see previous step)
           path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
@@ -85,8 +91,14 @@ jobs:
       - name: Install Yarn dependencies
         run: yarn install --frozen-lockfile
 
+      - name: Build lint plugins
+        run: yarn run build:lint
+
+      - name: Run lint plugin tests
+        run: yarn run test:lint:nobuild
+
       - name: Run lint
-        run: yarn run lint --quiet
+        run: yarn run lint:nobuild --quiet
 
       - name: Check for circular dependencies
         run: yarn run check-circ-deps
@@ -101,13 +113,21 @@ jobs:
       # so that it can be shared with the 'codecov' job (see below)
       # NOTE: Angular CLI only supports code coverage for specs. See https://github.com/angular/angular-cli/issues/6286
       - name: Upload code coverage report to Artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: matrix.node-version == '18.x'
         with:
-          name: dspace-angular coverage report
+          name: coverage-report-${{ matrix.node-version }}
           path: 'coverage/dspace-angular/lcov.info'
           retention-days: 14
 
+      # Login to our Docker registry, so that we can access private Docker images using "docker compose" below.
+      - name: Login to ${{ env.DOCKER_REGISTRY }}
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.DOCKER_REGISTRY }}
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
       # Using "docker compose" start backend using CI configuration
       # and load assetstore from a cached copy
       - name: Start DSpace REST Backend via Docker (for e2e tests)
@@ -135,19 +155,19 @@ jobs:
       # Cypress always creates a video of all e2e tests (whether they succeeded or failed)
       # Save those in an Artifact
       - name: Upload e2e test videos to Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: e2e-test-videos
+          name: e2e-test-videos-${{ matrix.node-version }}
           path: cypress/videos
 
       # If e2e tests fail, Cypress creates a screenshot of what happened
       # Save those in an Artifact
       - name: Upload e2e test failure screenshots to Artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: failure()
         with:
-          name: e2e-test-screenshots
+          name: e2e-test-screenshots-${{ matrix.node-version }}
           path: cypress/screenshots
 
       - name: Stop app (in case it stays up after e2e tests)
@@ -172,12 +192,115 @@ jobs:
       # Get homepage and verify that the <meta name="title"> tag includes "DSpace".
       # If it does, then SSR is working, as this tag is created by our MetadataService.
       # This step also prints entire HTML of homepage for easier debugging if grep fails.
-      - name: Verify SSR (server-side rendering)
+      - name: Verify SSR (server-side rendering) on Homepage
         run: |
           result=$(wget -O- -q http://127.0.0.1:4000/home)
           echo "$result"
           echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep DSpace
 
+      # Get a specific community in our test data and verify that the "<h1>" tag includes "Publications" (the community name).
+      # If it does, then SSR is working.
+      - name: Verify SSR on a Community page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/communities/0958c910-2037-42a9-81c7-dca80e3892b4)
+          echo "$result"
+          echo "$result" | grep -oE "<h1 [^>]*>[^><]*</h1>" | grep Publications
+
+      # Get a specific collection in our test data and verify that the "<h1>" tag includes "Articles" (the collection name).
+      # If it does, then SSR is working.
+      - name: Verify SSR on a Collection page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/collections/282164f5-d325-4740-8dd1-fa4d6d3e7200)
+          echo "$result"
+          echo "$result" | grep -oE "<h1 [^>]*>[^><]*</h1>" | grep Articles
+
+      # Get a specific publication in our test data and verify that the <meta name="title"> tag includes
+      # the title of this publication. If it does, then SSR is working.
+      - name: Verify SSR on a Publication page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/publication/6160810f-1e53-40db-81ef-f6621a727398)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "An Economic Model of Mortality Salience"
+
+      # Get a specific person in our test data and verify that the <meta name="title"> tag includes
+      # the name of the person. If it does, then SSR is working.
+      - name: Verify SSR on a Person page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/person/b1b2c768-bda1-448a-a073-fc541e8b24d9)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Simmons, Cameron"
+
+      # Get a specific project in our test data and verify that the <meta name="title"> tag includes
+      # the name of the project. If it does, then SSR is working.
+      - name: Verify SSR on a Project page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/project/46ccb608-a74c-4bf6-bc7a-e29cc7defea9)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "University Research Fellowship"
+
+      # Get a specific orgunit in our test data and verify that the <meta name="title"> tag includes
+      # the name of the orgunit. If it does, then SSR is working.
+      - name: Verify SSR on an OrgUnit page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/orgunit/9851674d-bd9a-467b-8d84-068deb568ccf)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Law and Development"
+
+      # Get a specific journal in our test data and verify that the <meta name="title"> tag includes
+      # the name of the journal. If it does, then SSR is working.
+      - name: Verify SSR on a Journal page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/journal/d4af6c3e-53d0-4757-81eb-566f3b45d63a)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Environmental &amp; Architectural Phenomenology"
+
+      # Get a specific journal volume in our test data and verify that the <meta name="title"> tag includes
+      # the name of the volume. If it does, then SSR is working.
+      - name: Verify SSR on a Journal Volume page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/journalvolume/07c6249f-4bf7-494d-9ce3-6ffdb2aed538)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Environmental &amp; Architectural Phenomenology Volume 28 (2017)"
+
+      # Get a specific journal issue in our test data and verify that the <meta name="title"> tag includes
+      # the name of the issue. If it does, then SSR is working.
+      - name: Verify SSR on a Journal Issue page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/journalissue/44c29473-5de2-48fa-b005-e5029aa1a50b)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Environmental &amp; Architectural Phenomenology Vol. 28, No. 1"
+
+      # Verify 301 Handle redirect behavior
+      # Note: /handle/123456789/260 is the same test Publication used by our e2e tests
+      - name: Verify 301 redirect from '/handle' URLs
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/handle/123456789/260 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          [[ "$result" -eq "301" ]]
+
+      # Verify 403 error code behavior
+      - name: Verify 403 error code from '/403'
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/403 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          [[ "$result" -eq "403" ]]
+
+      # Verify 404 error code behavior
+      - name: Verify 404 error code from '/404' and on invalid pages
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/404 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          result2=$(wget --server-response --quiet http://127.0.0.1:4000/invalidurl 2>&1 | head -1 | awk '{print $2}')
+          echo "$result2"
+          [[ "$result" -eq "404" && "$result2" -eq "404" ]]
+
+      # Verify 500 error code behavior
+      - name: Verify 500 error code from '/500'
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/500 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          [[ "$result" -eq "500" ]]
+
       - name: Stop running app
         run: kill -9 $(lsof -t -i:4000)
 
@@ -197,7 +320,7 @@ jobs:
 
       # Download artifacts from previous 'tests' job
       - name: Download coverage artifacts
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
 
       # Now attempt upload to Codecov using its action.
       # NOTE: We use a retry action to retry the Codecov upload if it fails the first time.
@@ -207,11 +330,12 @@ jobs:
       - name: Upload coverage to Codecov.io
         uses: Wandalen/wretry.action@v1.3.0
         with:
-          action: codecov/codecov-action@v3
+          action: codecov/codecov-action@v4
           # Ensure codecov-action throws an error when it fails to upload
           # This allows us to auto-restart the action if an error is thrown
           with: |
             fail_ci_if_error: true
+            token: ${{ secrets.CODECOV_TOKEN }}
           # Try re-running action 5 times max
           attempt_limit: 5
           # Run again in 30 seconds

.github/workflows/codescan.yml

@@ -40,14 +40,14 @@ jobs:
       # Initializes the CodeQL tools for scanning.
       # https://github.com/github/codeql-action
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: javascript
 
       # Autobuild attempts to build any compiled languages
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v2
+        uses: github/codeql-action/autobuild@v3
 
       # Perform GitHub Code Scanning.
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/docker.yml

@@ -16,7 +16,8 @@ on:
   pull_request:
 
 permissions:
-  contents: read  #  to fetch code (actions/checkout)
+  contents: read  # to fetch code (actions/checkout)
+  packages: write # to write images to GitHub Container Registry (GHCR)
 
 jobs:
   #############################################################
@@ -28,7 +29,7 @@ jobs:
     # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
     uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@main
     with:
-      build_id: dspace-angular
+      build_id: dspace-angular-dev
       image_name: dspace/dspace-angular
       dockerfile_path: ./Dockerfile
     secrets:

.github/workflows/issue_opened.yml

@@ -16,7 +16,7 @@ jobs:
       # Only add to project board if issue is flagged as "needs triage" or has no labels
       # NOTE: By default we flag new issues as "needs triage" in our issue template
       if: (contains(github.event.issue.labels.*.name, 'needs triage') || join(github.event.issue.labels.*.name) == '')
-      uses: actions/add-to-project@v0.5.0
+      uses: actions/add-to-project@v1.0.0
       # Note, the authentication token below is an ORG level Secret. 
       # It must be created/recreated manually via a personal access token with admin:org, project, public_repo permissions
       # See: https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token

.github/workflows/pull_request_opened.yml

@@ -21,4 +21,4 @@ jobs:
     # Assign the PR to whomever created it. This is useful for visualizing assignments on project boards
     # See https://github.com/toshimaru/auto-author-assign
     - name: Assign PR to creator
-      uses: toshimaru/auto-author-assign@v2.0.1
+      uses: toshimaru/auto-author-assign@v2.1.0

.gitignore

@@ -1,4 +1,5 @@
 /.angular/cache
+/.nx
 /__build__
 /__server_build__
 /node_modules

Dockerfile

@@ -1,7 +1,7 @@
 # This image will be published as dspace/dspace-angular
 # See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
 
-FROM node:18-alpine
+FROM docker.io/node:18-alpine
 
 # Ensure Python and other build tools are available
 # These are needed to install some node modules, especially on linux/arm64
@@ -24,5 +24,5 @@ ENV NODE_OPTIONS="--max_old_space_size=4096"
 # Listen / accept connections from all IP addresses.
 # NOTE: At this time it is only possible to run Docker container in Production mode
 # if you have a public URL. See https://github.com/DSpace/dspace-angular/issues/1485
-ENV NODE_ENV development
+ENV NODE_ENV=development
 CMD yarn serve --host 0.0.0.0

Dockerfile.dist

@@ -2,9 +2,9 @@
 # See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
 
 # Test build:
-# docker build -f Dockerfile.dist -t dspace/dspace-angular:latest-dist .
+# docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-8_x-dist .
 
-FROM node:18-alpine as build
+FROM docker.io/node:18-alpine AS build
 
 # Ensure Python and other build tools are available
 # These are needed to install some node modules, especially on linux/arm64
@@ -26,6 +26,6 @@ COPY --chown=node:node docker/dspace-ui.json /app/dspace-ui.json
 
 WORKDIR /app
 USER node
-ENV NODE_ENV production
+ENV NODE_ENV=production
 EXPOSE 4000
 CMD pm2-runtime start dspace-ui.json --json

README.md

@@ -35,7 +35,7 @@ https://wiki.lyrasis.org/display/DSDOC7x/Installing+DSpace
 Quick start
 -----------
 
-**Ensure you're running [Node](https://nodejs.org) `v16.x` or `v18.x`, [npm](https://www.npmjs.com/) >= `v5.x` and [yarn](https://yarnpkg.com) == `v1.x`**
+**Ensure you're running [Node](https://nodejs.org) `v18.x` or `v20.x`, [npm](https://www.npmjs.com/) >= `v10.x` and [yarn](https://yarnpkg.com) == `v1.x`**
 
 ```bash
 # clone the repo
@@ -90,7 +90,7 @@ Requirements
 ------------
 
 -	[Node.js](https://nodejs.org) and [yarn](https://yarnpkg.com)
--	Ensure you're running node `v16.x` or `v18.x` and yarn == `v1.x`
+-	Ensure you're running node `v18.x` or `v20.x` and yarn == `v1.x`
 
 If you have [`nvm`](https://github.com/creationix/nvm#install-script) or [`nvm-windows`](https://github.com/coreybutler/nvm-windows) installed, which is highly recommended, you can run `nvm install --lts && nvm use` to install and start using the latest Node LTS.
 

angular.json

@@ -30,7 +30,6 @@
               "lodash",
               "jwt-decode",
               "uuid",
-              "webfontloader",
               "zone.js"
             ],
             "outputPath": "dist/browser",
@@ -109,22 +108,22 @@
         "serve": {
           "builder": "@angular-builders/custom-webpack:dev-server",
           "options": {
-            "browserTarget": "dspace-angular:build",
+            "buildTarget": "dspace-angular:build",
             "port": 4000
           },
           "configurations": {
             "development": {
-              "browserTarget": "dspace-angular:build:development"
+              "buildTarget": "dspace-angular:build:development"
             },
             "production": {
-              "browserTarget": "dspace-angular:build:production"
+              "buildTarget": "dspace-angular:build:production"
             }
           }
         },
         "extract-i18n": {
           "builder": "@angular-devkit/build-angular:extract-i18n",
           "options": {
-            "browserTarget": "dspace-angular:build"
+            "buildTarget": "dspace-angular:build"
           }
         },
         "test": {
@@ -217,23 +216,23 @@
           }
         },
         "serve-ssr": {
-          "builder": "@nguniversal/builders:ssr-dev-server",
+          "builder": "@angular-devkit/build-angular:ssr-dev-server",
           "options": {
-            "browserTarget": "dspace-angular:build",
+            "buildTarget": "dspace-angular:build",
             "serverTarget": "dspace-angular:server",
             "port": 4000
           },
           "configurations": {
             "production": {
-              "browserTarget": "dspace-angular:build:production",
+              "buildTarget": "dspace-angular:build:production",
               "serverTarget": "dspace-angular:server:production"
             }
           }
         },
         "prerender": {
-          "builder": "@nguniversal/builders:prerender",
+          "builder": "@angular-devkit/build-angular:prerender",
           "options": {
-            "browserTarget": "dspace-angular:build:production",
+            "buildTarget": "dspace-angular:build:production",
             "serverTarget": "dspace-angular:server:production",
             "routes": [
               "/"
@@ -266,6 +265,8 @@
           "options": {
             "lintFilePatterns": [
               "src/**/*.ts",
+              "cypress/**/*.ts",
+              "lint/**/*.ts",
               "src/**/*.html",
               "src/**/*.json5"
             ]

config/config.example.yml

@@ -1,7 +1,7 @@
 # NOTE: will log all redux actions and transfers in console
 debug: false
 
-# Angular Universal server settings
+# Angular User Inteface settings
 # NOTE: these settings define where Node.js will start your UI application. Therefore, these
 # "ui" settings usually specify a localhost port/URL which is later proxied to a public URL (using Apache or similar)
 ui:
@@ -17,12 +17,51 @@ ui:
   # Trust X-FORWARDED-* headers from proxies (default = true)
   useProxies: true
 
-universal:
-  # Whether to inline "critical" styles into the server-side rendered HTML.
-  # Determining which styles are critical is a relatively expensive operation;
-  # this option can be disabled to boost server performance at the expense of
-  # loading smoothness.
-  inlineCriticalCss: true
+# Angular Server Side Rendering (SSR) settings
+ssr:
+  # Whether to tell Angular to inline "critical" styles into the server-side rendered HTML.
+  # Determining which styles are critical is a relatively expensive operation; this option is
+  # disabled (false) by default to boost server performance at the expense of loading smoothness.
+  inlineCriticalCss: false
+  # Patterns to be run as regexes against the path of the page to check if SSR is allowed.
+  # If the path match any of the regexes it will be served directly in CSR.
+  # By default, excludes community and collection browse, global browse, global search, community list, statistics and various administrative tools.
+  excludePathPatterns:
+    - pattern: "^/communities/[a-f0-9-]{36}/browse(/.*)?$"
+      flag: "i"
+    - pattern: "^/collections/[a-f0-9-]{36}/browse(/.*)?$"
+      flag: "i"
+    - pattern: "^/browse/"
+    - pattern: "^/search$"
+    - pattern: "^/community-list$"
+    - pattern: "^/admin/"
+    - pattern: "^/processes/?"
+    - pattern: "^/notifications/"
+    - pattern: "^/statistics/?"
+    - pattern: "^/access-control/"
+    - pattern: "^/health$"
+
+  # Whether to enable rendering of Search component on SSR.
+  # If set to true the component will be included in the HTML returned from the server side rendering.
+  # If set to false the component will not be included in the HTML returned from the server side rendering.
+  enableSearchComponent: false
+  # Whether to enable rendering of Browse component on SSR.
+  # If set to true the component will be included in the HTML returned from the server side rendering.
+  # If set to false the component will not be included in the HTML returned from the server side rendering.
+  enableBrowseComponent: false
+  # Enable state transfer from the server-side application to the client-side application.
+  # Defaults to true.
+  # Note: When using an external application cache layer, it's recommended not to transfer the state to avoid caching it.
+  # Disabling it ensures that dynamic state information is not inadvertently cached, which can improve security and
+  # ensure that users always use the most up-to-date state.
+  transferState: true
+  # When a different REST base URL is used for the server-side application, the generated state contains references to
+  # REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
+  # Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
+  replaceRestUrl: true
+  # Enable request performance profiling data collection and printing the results in the server console.
+  # Defaults to false. Enabling in production is NOT recommended
+  #enablePerformanceProfiler: false
 
 # The REST API server settings
 # NOTE: these settings define which (publicly available) REST API to use. They are usually
@@ -33,6 +72,9 @@ rest:
   port: 443
   # NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
   nameSpace: /server
+  # Provide a different REST url to be used during SSR execution. It must contain the whole url including protocol, server port and
+  # server namespace (uncomment to use it).
+  #ssrBaseUrl: http://localhost:8080/server
 
 # Caching settings
 cache:
@@ -202,6 +244,12 @@ languages:
   - code: en
     label: English
     active: true
+  - code: ar
+    label: العربية
+    active: true
+  - code: bn
+    label: বাংলা
+    active: true
   - code: ca
     label: Català
     active: true
@@ -211,24 +259,36 @@ languages:
   - code: de
     label: Deutsch
     active: true
+  - code: el
+    label: Ελληνικά
+    active: true
   - code: es
     label: Español
     active: true
+  - code: fi
+    label: Suomi
+    active: true
   - code: fr
     label: Français
     active: true
   - code: gd
     label: Gàidhlig
     active: true
-  - code: it
-    label: Italiano
-    active: true
-  - code: lv
-    label: Latviešu
+  - code: hi
+    label: हिंदी
     active: true
   - code: hu
     label: Magyar
     active: true
+  - code: it
+    label: Italiano
+    active: true
+  - code: kk
+    label: Қазақ
+    active: true
+  - code: lv
+    label: Latviešu
+    active: true
   - code: nl
     label: Nederlands
     active: true
@@ -244,8 +304,8 @@ languages:
   - code: sr-lat
     label: Srpski (lat)
     active: true
-  - code: fi
-    label: Suomi
+  - code: sr-cyr
+    label: Српски
     active: true
   - code: sv
     label: Svenska
@@ -253,27 +313,12 @@ languages:
   - code: tr
     label: Türkçe
     active: true
-  - code: vi
-    label: Tiếng Việt
-    active: true
-  - code: kk
-    label: Қазақ
-    active: true
-  - code: bn
-    label: বাংলা
-    active: true
-  - code: hi
-    label: हिंदी
-    active: true
-  - code: el
-    label: Ελληνικά
-    active: true
-  - code: sr-cyr
-    label: Српски
-    active: true
   - code: uk
     label: Yкраї́нська
     active: true
+  - code: vi
+    label: Tiếng Việt
+    active: true
 
 
 # Browse-By Pages
@@ -322,12 +367,20 @@ item:
 
 # Community Page Config
 community:
+  # Default tab to be shown when browsing a Community. Valid values are: comcols, search, or browse_<field>
+  # <field> must be any of the configured "browse by" fields, e.g., dateissued, author, title, or subject
+  # When the default tab is not the 'search' tab, the search tab is moved to the last position
+  defaultBrowseTab: search
   # Search tab config
   searchSection:
     showSidebar: true
 
 # Collection Page Config
 collection:
+  # Default tab to be shown when browsing a Collection. Valid values are: search, or browse_<field>
+  # <field> must be any of the configured "browse by" fields, e.g., dateissued, author, title, or subject
+  # When the default tab is not the 'search' tab, the search tab is moved to the last position
+  defaultBrowseTab: search
   # Search tab config
   searchSection:
     showSidebar: true
@@ -407,10 +460,11 @@ mediaViewer:
 
 # Whether the end user agreement is required before users use the repository.
 # If enabled, the user will be required to accept the agreement before they can use the repository.
-# And whether the privacy statement should exist or not.
+# And whether the privacy statement/COAR notify support page should exist or not.
 info:
   enableEndUserAgreement: true
   enablePrivacyStatement: true
+  enableCOARNotifySupport: true
 
 # Whether to enable Markdown (https://commonmark.org/) and MathJax (https://www.mathjax.org/)
 # display in supported metadata fields. By default, only dc.description.abstract is supported.
@@ -444,6 +498,12 @@ search:
     enabled: false
     # List of filters to enable in "Advanced Search" dropdown
     filter: [ 'title', 'author', 'subject', 'entityType' ]
+  #
+  # Number used to render n UI elements called loading skeletons that act as placeholders.
+  # These elements indicate that some content will be loaded in their stead.
+  # Since we don't know how many filters will be loaded before we receive a response from the server we use this parameter for the skeletons count.
+  # e.g. If we set 5 then 5 loading skeletons will be visualized before the actual filters are retrieved.
+  defaultFiltersCount: 5
 
 
 # Notify metrics
@@ -499,6 +559,21 @@ notifyMetrics:
     description: 'admin-notify-dashboard.NOTIFY.outgoing.delivered.description'
 
 
+# Live Region configuration
+# Live Region as defined by w3c, https://www.w3.org/TR/wai-aria-1.1/#terms:
+# Live regions are perceivable regions of a web page that are typically updated as a
+# result of an external event when user focus may be elsewhere.
+#
+# The DSpace live region is a component present at the bottom of all pages that is invisible by default, but is useful
+# for screen readers. Any message pushed to the live region will be announced by the screen reader. These messages
+# usually contain information about changes on the page that might not be in focus.
+liveRegion:
+  # The duration after which messages disappear from the live region in milliseconds
+  messageTimeOutDurationMs: 30000
+  # The visibility of the live region. Setting this to true is only useful for debugging purposes.
+  isVisible: false
 
-
-
+# Configuration for storing accessibility settings, used by the AccessibilitySettingsService
+accessibility:
+  # The duration in days after which the accessibility settings cookie expires
+  cookieExpirationDuration: 7

cypress.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from 'cypress';
 
 export default defineConfig({
+  video: true,
   videosFolder: 'cypress/videos',
   screenshotsFolder: 'cypress/screenshots',
   fixturesFolder: 'cypress/fixtures',
@@ -18,6 +19,7 @@ export default defineConfig({
 
     // Admin account used for administrative tests
     DSPACE_TEST_ADMIN_USER: 'dspacedemo+admin@gmail.com',
+    DSPACE_TEST_ADMIN_USER_UUID: '335647b6-8a52-4ecb-a8c1-7ebabb199bda',
     DSPACE_TEST_ADMIN_PASSWORD: 'dspace',
     // Community/collection/publication used for view/edit tests
     DSPACE_TEST_COMMUNITY: '0958c910-2037-42a9-81c7-dca80e3892b4',
@@ -33,6 +35,8 @@ export default defineConfig({
     // Account used to test basic submission process
     DSPACE_TEST_SUBMIT_USER: 'dspacedemo+submit@gmail.com',
     DSPACE_TEST_SUBMIT_USER_PASSWORD: 'dspace',
+    // Administrator users group
+    DSPACE_ADMINISTRATOR_GROUP: 'e59f5659-bff9-451e-b28f-439e7bd467e4'
   },
   e2e: {
     // Setup our plugins for e2e tests

cypress/e2e/admin-add-new-modals.cy.ts

@@ -0,0 +1,54 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Add New Modals', () => {
+  beforeEach(() => {
+    // Must login as an Admin for sidebar to appear
+    cy.visit('/login');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('Add new Community modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-new-title').should('be.visible');
+    cy.get('#admin-menu-section-new-title').click();
+
+    cy.get('a[data-test="menu.section.new_community"]').click();
+
+    // Analyze <ds-create-community-parent-selector> for accessibility
+    testA11y('ds-create-community-parent-selector');
+  });
+
+  it('Add new Collection modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-new-title').should('be.visible');
+    cy.get('#admin-menu-section-new-title').click();
+
+    cy.get('a[data-test="menu.section.new_collection"]').click();
+
+    // Analyze <ds-create-collection-parent-selector> for accessibility
+    testA11y('ds-create-collection-parent-selector');
+  });
+
+  it('Add new Item modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-new-title').should('be.visible');
+    cy.get('#admin-menu-section-new-title').click();
+
+    cy.get('a[data-test="menu.section.new_item"]').click();
+
+    // Analyze <ds-create-item-parent-selector> for accessibility
+    testA11y('ds-create-item-parent-selector');
+  });
+});

cypress/e2e/admin-curation-tasks.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Curation Tasks', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/curation-tasks');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Page must first be visible
+    cy.get('ds-admin-curation-task').should('be.visible');
+    // Analyze <ds-admin-curation-task> for accessibility issues
+    testA11y('ds-admin-curation-task');
+  });
+});

cypress/e2e/admin-edit-modals.cy.ts

@@ -0,0 +1,54 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Edit Modals', () => {
+  beforeEach(() => {
+    // Must login as an Admin for sidebar to appear
+    cy.visit('/login');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('Edit Community modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-edit-title').should('be.visible');
+    cy.get('#admin-menu-section-edit-title').click();
+
+    cy.get('a[data-test="menu.section.edit_community"]').click();
+
+    // Analyze <ds-edit-community-selector> for accessibility
+    testA11y('ds-edit-community-selector');
+  });
+
+  it('Edit Collection modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-edit-title').should('be.visible');
+    cy.get('#admin-menu-section-edit-title').click();
+
+    cy.get('a[data-test="menu.section.edit_collection"]').click();
+
+    // Analyze <ds-edit-collection-selector> for accessibility
+    testA11y('ds-edit-collection-selector');
+  });
+
+  it('Edit Item modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-edit-title').should('be.visible');
+    cy.get('#admin-menu-section-edit-title').click();
+
+    cy.get('a[data-test="menu.section.edit_item"]').click();
+
+    // Analyze <ds-edit-item-selector> for accessibility
+    testA11y('ds-edit-item-selector');
+  });
+});

cypress/e2e/admin-export-modals.cy.ts

@@ -0,0 +1,39 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Export Modals', () => {
+  beforeEach(() => {
+    // Must login as an Admin for sidebar to appear
+    cy.visit('/login');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('Export metadata modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-export-title').should('be.visible');
+    cy.get('#admin-menu-section-export-title').click();
+
+    cy.get('a[data-test="menu.section.export_metadata"]').click();
+
+    // Analyze <ds-export-metadata-selector> for accessibility
+    testA11y('ds-export-metadata-selector');
+  });
+
+  it('Export batch modal should pass accessibility tests', () => {
+    // Pin the sidebar open
+    cy.get('#sidebar-collapse-toggle').trigger('mouseover');
+    cy.get('#sidebar-collapse-toggle').click();
+
+    // Click on entry of menu
+    cy.get('#admin-menu-section-export-title').should('be.visible');
+    cy.get('#admin-menu-section-export-title').click();
+
+    cy.get('a[data-test="menu.section.export_batch"]').click();
+
+    // Analyze <ds-export-batch-selector> for accessibility
+    testA11y('ds-export-batch-selector');
+  });
+});

cypress/e2e/admin-notifications-publication-claim-page.cy.ts

@@ -0,0 +1,17 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Notifications Publication Claim Page', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/notifications/publication-claim');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+
+    //Page must first be visible
+    cy.get('ds-admin-notifications-publication-claim-page').should('be.visible');
+    // Analyze <ds-admin-notifications-publication-claim-page> for accessibility issues
+    testA11y('ds-admin-notifications-publication-claim-page');
+  });
+});

cypress/e2e/admin-search-page.cy.ts

@@ -0,0 +1,21 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Search Page', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/search');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    //Page must first be visible
+    cy.get('ds-admin-search-page').should('be.visible');
+    // At least one search result should be displayed
+    cy.get('[data-test="list-object"]').should('be.visible');
+    // Click each filter toggle to open *every* filter
+    // (As we want to scan filter section for accessibility issues as well)
+    cy.get('[data-test="filter-toggle"]').click({ multiple: true });
+    // Analyze <ds-admin-search-page> for accessibility issues
+    testA11y('ds-admin-search-page');
+  });
+});

cypress/e2e/admin-workflow-page.cy.ts

@@ -0,0 +1,21 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Admin Workflow Page', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/workflow');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Page must first be visible
+    cy.get('ds-admin-workflow-page').should('be.visible');
+    // At least one search result should be displayed
+    cy.get('[data-test="list-object"]').should('be.visible');
+    // Click each filter toggle to open *every* filter
+    // (As we want to scan filter section for accessibility issues as well)
+    cy.get('[data-test="filter-toggle"]').click({ multiple: true });
+    // Analyze <ds-admin-workflow-page> for accessibility issues
+    testA11y('ds-admin-workflow-page');
+  });
+});

cypress/e2e/batch-import-page.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Batch Import Page', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see processes
+    cy.visit('/admin/batch-import');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Batch import form must first be visible
+    cy.get('ds-batch-import-page').should('be.visible');
+    // Analyze <ds-batch-import-page> for accessibility issues
+    testA11y('ds-batch-import-page');
+  });
+});

cypress/e2e/bitstreams-format.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Bitstreams Formats', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/registries/bitstream-formats');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Page must first be visible
+    cy.get('ds-bitstream-formats').should('be.visible');
+    // Analyze <ds-bitstream-formats> for accessibility issues
+    testA11y('ds-bitstream-formats');
+  });
+});

cypress/e2e/bulk-access.cy.ts

@@ -0,0 +1,31 @@
+import { testA11y } from 'cypress/support/utils';
+import { Options } from 'cypress-axe';
+
+describe('Bulk Access', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/access-control/bulk-access');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Page must first be visible
+    cy.get('ds-bulk-access').should('be.visible');
+    // At least one search result should be displayed
+    cy.get('[data-test="list-object"]').should('be.visible');
+    // Click each filter toggle to open *every* filter
+    // (As we want to scan filter section for accessibility issues as well)
+    cy.get('[data-test="filter-toggle"]').click({ multiple: true });
+    // Analyze <ds-bulk-access> for accessibility issues
+    testA11y('ds-bulk-access', {
+      rules: {
+        // All panels are accordians & fail "aria-required-children" and "nested-interactive".
+        // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+        'aria-required-children': { enabled: false },
+        'nested-interactive': { enabled: false },
+        // Card titles fail this test currently
+        'heading-order': { enabled: false },
+      },
+    } as Options);
+  });
+});

cypress/e2e/collection-create.cy.ts

@@ -0,0 +1,13 @@
+beforeEach(() => {
+  cy.visit('/collections/create?parent='.concat(Cypress.env('DSPACE_TEST_COMMUNITY')));
+  cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+it('should show loading component while saving', () => {
+  const title = 'Test Collection Title';
+  cy.get('#title').type(title);
+
+  cy.get('button[type="submit"]').click();
+
+  cy.get('ds-loading').should('be.visible');
+});

cypress/e2e/community-create.cy.ts

@@ -0,0 +1,13 @@
+beforeEach(() => {
+  cy.visit('/communities/create');
+  cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+it('should show loading component while saving', () => {
+  const title = 'Test Community Title';
+  cy.get('#title').type(title);
+
+  cy.get('button[type="submit"]').click();
+
+  cy.get('ds-loading').should('be.visible');
+});

cypress/e2e/create-eperson.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Create Eperson', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/access-control/epeople/create');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Form must first be visible
+    cy.get('ds-eperson-form').should('be.visible');
+    // Analyze <ds-eperson-form> for accessibility issues
+    testA11y('ds-eperson-form');
+  });
+});

cypress/e2e/create-group.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Create Group', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/access-control/groups/create');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Form must first be visible
+    cy.get('ds-group-form').should('be.visible');
+    // Analyze <ds-group-form> for accessibility issues
+    testA11y('ds-group-form');
+  });
+});

cypress/e2e/edit-eperson.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Edit Eperson', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/access-control/epeople/'.concat(Cypress.env('DSPACE_TEST_ADMIN_USER_UUID')).concat('/edit'));
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Form must first be visible
+    cy.get('ds-eperson-form').should('be.visible');
+    // Analyze <ds-eperson-form> for accessibility issues
+    testA11y('ds-eperson-form');
+  });
+});

cypress/e2e/edit-group.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Edit Group', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/access-control/groups/'.concat(Cypress.env('DSPACE_ADMINISTRATOR_GROUP')).concat('/edit'));
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Form must first be visible
+    cy.get('ds-group-form').should('be.visible');
+    // Analyze <ds-group-form> for accessibility issues
+    testA11y('ds-group-form');
+  });
+});

cypress/e2e/end-user-agreement.cy.ts

@@ -0,0 +1,13 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('End User Agreement', () => {
+  it('should pass accessibility tests', () => {
+    cy.visit('/info/end-user-agreement');
+
+    // Page must first be visible
+    cy.get('ds-end-user-agreement').should('be.visible');
+
+    // Analyze <ds-end-user-agreement> for accessibility
+    testA11y('ds-end-user-agreement');
+  });
+});

cypress/e2e/epeople-registry.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Epeople registry', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/access-control/epeople');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Epeople registry page must first be visible
+    cy.get('ds-epeople-registry').should('be.visible');
+    // Analyze <ds-epeople-registry> for accessibility issues
+    testA11y('ds-epeople-registry');
+  });
+});

cypress/e2e/feedback.cy.ts

@@ -0,0 +1,13 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Feedback', () => {
+  it('should pass accessibility tests', () => {
+    cy.visit('/info/feedback');
+
+    // Page must first be visible
+    cy.get('ds-feedback').should('be.visible');
+
+    // Analyze <ds-feedback> for accessibility
+    testA11y('ds-feedback');
+  });
+});

cypress/e2e/groups-registry.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Groups registry', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/access-control/groups');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Epeople registry page must first be visible
+    cy.get('ds-groups-registry').should('be.visible');
+    // Analyze <ds-groups-registry> for accessibility issues
+    testA11y('ds-groups-registry');
+  });
+});

cypress/e2e/header.cy.ts

@@ -10,4 +10,29 @@ describe('Header', () => {
     // Analyze <ds-header> for accessibility
     testA11y('ds-header');
   });
+
+  it('should allow for changing language to German (for example)', () => {
+    cy.visit('/');
+
+    // Click the language switcher (globe) in header
+    cy.get('button[data-test="lang-switch"]').click();
+    // Click on the "Deusch" language in dropdown
+    cy.get('#language-menu-list div[role="option"]').contains('Deutsch').click();
+
+    // HTML "lang" attribute should switch to "de"
+    cy.get('html').invoke('attr', 'lang').should('eq', 'de');
+
+    // Login menu should now be in German
+    cy.get('[data-test="login-menu"]').contains('Anmelden');
+
+    // Change back to English from language switcher
+    cy.get('button[data-test="lang-switch"]').click();
+    cy.get('#language-menu-list div[role="option"]').contains('English').click();
+
+    // HTML "lang" attribute should switch to "en"
+    cy.get('html').invoke('attr', 'lang').should('eq', 'en');
+
+    // Login menu should now be in English
+    cy.get('[data-test="login-menu"]').contains('Log In');
+  });
 });

cypress/e2e/health-page.cy.ts

@@ -0,0 +1,62 @@
+import { testA11y } from 'cypress/support/utils';
+import { Options } from 'cypress-axe';
+
+
+beforeEach(() => {
+  // Must login as an Admin to see the page
+  cy.visit('/health');
+  cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+});
+
+describe('Health Page > Status Tab', () => {
+  it('should pass accessibility tests', () => {
+    cy.intercept('GET', '/server/actuator/health').as('status');
+    cy.wait('@status');
+
+    cy.get('a[data-test="health-page.status-tab"]').click();
+    // Page must first be visible
+    cy.get('ds-health-page').should('be.visible');
+    cy.get('ds-health-panel').should('be.visible');
+
+    // wait for all the ds-health-info-component components to be rendered
+    cy.get('div[role="tabpanel"]').each(($panel: HTMLDivElement) => {
+      cy.wrap($panel).find('ds-health-component').should('be.visible');
+    });
+    // Analyze <ds-health-page> for accessibility issues
+    testA11y('ds-health-page', {
+      rules: {
+        // All panels are accordians & fail "aria-required-children" and "nested-interactive".
+        // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+        'aria-required-children': { enabled: false },
+        'nested-interactive': { enabled: false },
+      },
+    } as Options);
+  });
+});
+
+describe('Health Page > Info Tab', () => {
+  it('should pass accessibility tests', () => {
+    cy.intercept('GET', '/server/actuator/info').as('info');
+    cy.wait('@info');
+
+    cy.get('a[data-test="health-page.info-tab"]').click();
+    // Page must first be visible
+    cy.get('ds-health-page').should('be.visible');
+    cy.get('ds-health-info').should('be.visible');
+
+    // wait for all the ds-health-info-component components to be rendered
+    cy.get('div[role="tabpanel"]').each(($panel: HTMLDivElement) => {
+      cy.wrap($panel).find('ds-health-info-component').should('be.visible');
+    });
+
+    // Analyze <ds-health-info> for accessibility issues
+    testA11y('ds-health-info', {
+      rules: {
+        // All panels are accordions & fail "aria-required-children" and "nested-interactive".
+        // Seem to require updating ng-bootstrap and https://github.com/DSpace/dspace-angular/issues/2216
+        'aria-required-children': { enabled: false },
+        'nested-interactive': { enabled: false },
+      },
+    } as Options);
+  });
+});

cypress/e2e/item-edit.cy.ts

@@ -13,11 +13,21 @@ beforeEach(() => {
 
 describe('Edit Item > Edit Metadata tab', () => {
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="metadata"]').should('be.visible');
     cy.get('a[data-test="metadata"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="metadata"]').should('be.visible');
+    cy.get('a[data-test="metadata"]').should('have.class', 'active');
+
     // <ds-edit-item-page> tag must be loaded
     cy.get('ds-edit-item-page').should('be.visible');
 
+    // wait for all the ds-dso-edit-metadata-value components to be rendered
+    cy.get('ds-dso-edit-metadata-value div[role="row"]').each(($row: HTMLDivElement) => {
+      cy.wrap($row).find('div[role="cell"]').should('be.visible');
+    });
+
     // Analyze <ds-edit-item-page> for accessibility issues
     testA11y('ds-edit-item-page');
   });
@@ -26,8 +36,13 @@ describe('Edit Item > Edit Metadata tab', () => {
 describe('Edit Item > Status tab', () => {
 
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="status"]').should('be.visible');
     cy.get('a[data-test="status"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="status"]').should('be.visible');
+    cy.get('a[data-test="status"]').should('have.class', 'active');
+
     // <ds-item-status> tag must be loaded
     cy.get('ds-item-status').should('be.visible');
 
@@ -39,8 +54,13 @@ describe('Edit Item > Status tab', () => {
 describe('Edit Item > Bitstreams tab', () => {
 
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="bitstreams"]').should('be.visible');
     cy.get('a[data-test="bitstreams"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="bitstreams"]').should('be.visible');
+    cy.get('a[data-test="bitstreams"]').should('have.class', 'active');
+
     // <ds-item-bitstreams> tag must be loaded
     cy.get('ds-item-bitstreams').should('be.visible');
 
@@ -63,8 +83,13 @@ describe('Edit Item > Bitstreams tab', () => {
 describe('Edit Item > Curate tab', () => {
 
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="curate"]').should('be.visible');
     cy.get('a[data-test="curate"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="curate"]').should('be.visible');
+    cy.get('a[data-test="curate"]').should('have.class', 'active');
+
     // <ds-item-curate> tag must be loaded
     cy.get('ds-item-curate').should('be.visible');
 
@@ -76,8 +101,13 @@ describe('Edit Item > Curate tab', () => {
 describe('Edit Item > Relationships tab', () => {
 
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="relationships"]').should('be.visible');
     cy.get('a[data-test="relationships"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="relationships"]').should('be.visible');
+    cy.get('a[data-test="relationships"]').should('have.class', 'active');
+
     // <ds-item-relationships> tag must be loaded
     cy.get('ds-item-relationships').should('be.visible');
 
@@ -89,8 +119,13 @@ describe('Edit Item > Relationships tab', () => {
 describe('Edit Item > Version History tab', () => {
 
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="versionhistory"]').should('be.visible');
     cy.get('a[data-test="versionhistory"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="versionhistory"]').should('be.visible');
+    cy.get('a[data-test="versionhistory"]').should('have.class', 'active');
+
     // <ds-item-version-history> tag must be loaded
     cy.get('ds-item-version-history').should('be.visible');
 
@@ -102,8 +137,13 @@ describe('Edit Item > Version History tab', () => {
 describe('Edit Item > Access Control tab', () => {
 
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="access-control"]').should('be.visible');
     cy.get('a[data-test="access-control"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="access-control"]').should('be.visible');
+    cy.get('a[data-test="access-control"]').should('have.class', 'active');
+
     // <ds-item-access-control> tag must be loaded
     cy.get('ds-item-access-control').should('be.visible');
 
@@ -115,8 +155,13 @@ describe('Edit Item > Access Control tab', () => {
 describe('Edit Item > Collection Mapper tab', () => {
 
   it('should pass accessibility tests', () => {
+    cy.get('a[data-test="mapper"]').should('be.visible');
     cy.get('a[data-test="mapper"]').click();
 
+    // Our selected tab should be both visible & active
+    cy.get('a[data-test="mapper"]').should('be.visible');
+    cy.get('a[data-test="mapper"]').should('have.class', 'active');
+
     // <ds-item-collection-mapper> tag must be loaded
     cy.get('ds-item-collection-mapper').should('be.visible');
 

cypress/e2e/item-template.cy.ts

@@ -0,0 +1,15 @@
+const ADD_TEMPLATE_ITEM_PAGE = '/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION')).concat('/itemtemplate');
+
+describe('Item Template', () => {
+  beforeEach(() => {
+    cy.visit(ADD_TEMPLATE_ITEM_PAGE);
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should load properly', () => {
+    cy.contains('.ds-header-row .lbl-cell', 'Field', { timeout: 10000 }).should('exist').should('be.visible');
+    cy.contains('.ds-header-row b', 'Value', { timeout: 10000 }).should('exist').should('be.visible');
+    cy.contains('.ds-header-row b', 'Lang', { timeout: 10000 }).should('exist').should('be.visible');
+    cy.contains('.ds-header-row b', 'Edit', { timeout: 10000 }).should('exist').should('be.visible');
+  });
+});

cypress/e2e/login-modal.cy.ts

@@ -3,31 +3,31 @@ import { testA11y } from 'cypress/support/utils';
 const page = {
   openLoginMenu() {
     // Click the "Log In" dropdown menu in header
-    cy.get('ds-themed-header [data-test="login-menu"]').click();
+    cy.get('[data-test="login-menu"]').click();
   },
   openUserMenu() {
     // Once logged in, click the User menu in header
-    cy.get('ds-themed-header [data-test="user-menu"]').click();
+    cy.get('[data-test="user-menu"]').click();
   },
   submitLoginAndPasswordByPressingButton(email, password) {
     // Enter email
-    cy.get('ds-themed-header [data-test="email"]').type(email);
+    cy.get('[data-test="email"]').type(email);
     // Enter password
-    cy.get('ds-themed-header [data-test="password"]').type(password);
+    cy.get('[data-test="password"]').type(password);
     // Click login button
-    cy.get('ds-themed-header [data-test="login-button"]').click();
+    cy.get('[data-test="login-button"]').click();
   },
   submitLoginAndPasswordByPressingEnter(email, password) {
     // In opened Login modal, fill out email & password, then click Enter
-    cy.get('ds-themed-header [data-test="email"]').type(email);
-    cy.get('ds-themed-header [data-test="password"]').type(password);
-    cy.get('ds-themed-header [data-test="password"]').type('{enter}');
+    cy.get('[data-test="email"]').type(email);
+    cy.get('[data-test="password"]').type(password);
+    cy.get('[data-test="password"]').type('{enter}');
   },
   submitLogoutByPressingButton() {
     // This is the POST command that will actually log us out
     cy.intercept('POST', '/server/api/authn/logout').as('logout');
     // Click logout button
-    cy.get('ds-themed-header [data-test="logout-button"]').click();
+    cy.get('[data-test="logout-button"]').click();
     // Wait until above POST command responds before continuing
     // (This ensures next action waits until logout completes)
     cy.wait('@logout');
@@ -67,7 +67,7 @@ describe('Login Modal', () => {
 
     // Login, and the <ds-log-in> tag should no longer exist
     page.submitLoginAndPasswordByPressingEnter(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
-    cy.get('.form-login').should('not.exist');
+    cy.get('ds-log-in').should('not.exist');
 
     // Verify we are still on homepage
     cy.url().should('include', '/home');
@@ -102,10 +102,10 @@ describe('Login Modal', () => {
     page.openLoginMenu();
 
     // Registration link should be visible
-    cy.get('ds-themed-header [data-test="register"]').should('be.visible');
+    cy.get('ds-header [data-test="register"]').should('be.visible');
 
     // Click registration link & you should go to registration page
-    cy.get('ds-themed-header [data-test="register"]').click();
+    cy.get('ds-header [data-test="register"]').click();
     cy.location('pathname').should('eq', '/register');
     cy.get('ds-register-email').should('exist');
 
@@ -119,10 +119,10 @@ describe('Login Modal', () => {
     page.openLoginMenu();
 
     // Forgot password link should be visible
-    cy.get('ds-themed-header [data-test="forgot"]').should('be.visible');
+    cy.get('ds-header [data-test="forgot"]').should('be.visible');
 
     // Click link & you should go to Forgot Password page
-    cy.get('ds-themed-header [data-test="forgot"]').click();
+    cy.get('ds-header [data-test="forgot"]').click();
     cy.location('pathname').should('eq', '/forgot');
     cy.get('ds-forgot-email').should('exist');
 

cypress/e2e/metadata-import-page.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Metadata Import Page', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/metadata-import');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Metadata import form must first be visible
+    cy.get('ds-metadata-import-page').should('be.visible');
+    // Analyze <ds-metadata-import-page> for accessibility issues
+    testA11y('ds-metadata-import-page');
+  });
+});

cypress/e2e/metadata-registry.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Metadata Registry', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/registries/metadata');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Page must first be visible
+    cy.get('ds-metadata-registry').should('be.visible');
+    // Analyze <ds-metadata-registry> for accessibility issues
+    testA11y('ds-metadata-registry');
+  });
+});

cypress/e2e/metadata-schema.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Metadata Schema', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/registries/metadata/dc');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Page must first be visible
+    cy.get('ds-metadata-schema').should('be.visible');
+    // Analyze <ds-metadata-schema> for accessibility issues
+    testA11y('ds-metadata-schema');
+  });
+});

cypress/e2e/new-process.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('New Process', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/processes/new');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Process form must first be visible
+    cy.get('ds-new-process').should('be.visible');
+    // Analyze <ds-new-process> for accessibility issues
+    testA11y('ds-new-process');
+  });
+});

cypress/e2e/privacy.cy.ts

@@ -0,0 +1,13 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Privacy', () => {
+  it('should pass accessibility tests', () => {
+    cy.visit('/info/privacy');
+
+    // Page must first be visible
+    cy.get('ds-privacy').should('be.visible');
+
+    // Analyze <ds-privacy> for accessibility
+    testA11y('ds-privacy');
+  });
+});

cypress/e2e/processes-overview.cy.ts

@@ -0,0 +1,17 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Processes Overview', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/processes');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+
+    // Process overview must first be visible
+    cy.get('ds-process-overview').should('be.visible');
+    // Analyze <ds-process-overview> for accessibility issues
+    testA11y('ds-process-overview');
+  });
+});

cypress/e2e/profile-page.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Profile page', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/profile');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Process form must first be visible
+    cy.get('ds-profile-page').should('be.visible');
+    // Analyze <ds-profile-page> for accessibility issues
+    testA11y('ds-profile-page');
+  });
+});

cypress/e2e/quality-assurance-source-page.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('Quality Assurance Source Page', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/notifications/quality-assurance');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Source page must first be visible
+    cy.get('ds-quality-assurance-source-page-component').should('be.visible');
+    // Analyze <ds-quality-assurance-source-page-component> for accessibility issues
+    testA11y('ds-quality-assurance-source-page-component');
+  });
+});

cypress/e2e/search-navbar.cy.ts

@@ -1,15 +1,15 @@
 const page = {
   fillOutQueryInNavBar(query) {
     // Click the magnifying glass
-    cy.get('ds-themed-header [data-test="header-search-icon"]').click();
+    cy.get('ds-header [data-test="header-search-icon"]').click();
     // Fill out a query in input that appears
-    cy.get('ds-themed-header [data-test="header-search-box"]').type(query);
+    cy.get('ds-header [data-test="header-search-box"]').type(query);
   },
   submitQueryByPressingEnter() {
-    cy.get('ds-themed-header [data-test="header-search-box"]').type('{enter}');
+    cy.get('ds-header [data-test="header-search-box"]').type('{enter}');
   },
   submitQueryByPressingIcon() {
-    cy.get('ds-themed-header [data-test="header-search-icon"]').click();
+    cy.get('ds-header [data-test="header-search-icon"]').click();
   },
 };
 

cypress/e2e/submission.cy.ts

@@ -137,7 +137,7 @@ describe('New Submission page', () => {
 
     // Upload our DSpace logo via drag & drop onto submission form
     // cy.get('div#section_upload')
-    cy.get('div.ds-document-drop-zone').selectFile('src/assets/images/dspace-logo.png', {
+    cy.get('div.ds-document-drop-zone').selectFile('src/assets/images/dspace-logo.svg', {
       action: 'drag-drop',
     });
 

cypress/e2e/system-wide-alert.cy.ts

@@ -0,0 +1,16 @@
+import { testA11y } from 'cypress/support/utils';
+
+describe('System Wide Alert', () => {
+  beforeEach(() => {
+    // Must login as an Admin to see the page
+    cy.visit('/admin/system-wide-alert');
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should pass accessibility tests', () => {
+    // Page must first be visible
+    cy.get('ds-system-wide-alert-form').should('be.visible');
+    // Analyze <ds-system-wide-alert-form> for accessibility issues
+    testA11y('ds-system-wide-alert-form');
+  });
+});

cypress/support/commands.ts

@@ -101,11 +101,11 @@ Cypress.Commands.add('login', login);
  */
 function loginViaForm(email: string, password: string): void {
   // Enter email
-  cy.get('ds-log-in [data-test="email"]').type(email);
+  cy.get('[data-test="email"]').type(email);
   // Enter password
-  cy.get('ds-log-in [data-test="password"]').type(password);
+  cy.get('[data-test="password"]').type(password);
   // Click login button
-  cy.get('ds-log-in [data-test="login-button"]').click();
+  cy.get('[data-test="login-button"]').click();
 }
 // Add as a Cypress command (i.e. assign to 'cy.loginViaForm')
 Cypress.Commands.add('loginViaForm', loginViaForm);

cypress/tsconfig.json

@@ -4,10 +4,11 @@
     "**/*.ts"
   ],
   "compilerOptions": {
+    "sourceMap": false,
     "types": [
       "cypress",
       "cypress-axe",
       "node"
     ]
   }
-}
+}

docker/README.md

@@ -20,17 +20,17 @@ the Docker compose scripts in this 'docker' folder.
 
 ### Dockerfile
 
-This Dockerfile is used to build a *development* DSpace 7 Angular UI image, published as 'dspace/dspace-angular'
+This Dockerfile is used to build a *development* DSpace Angular UI image, published as 'dspace/dspace-angular'
 
 ```
-docker build -t dspace/dspace-angular:latest .
+docker build -t dspace/dspace-angular:dspace-8_x .
 ```
 
 This image is built *automatically* after each commit is made to the `main` branch.
 
 Admins to our DockerHub repo can manually publish with the following command.
 ```
-docker push dspace/dspace-angular:latest
+docker push dspace/dspace-angular:dspace-8_x
 ```
 
 ### Dockerfile.dist
@@ -39,18 +39,18 @@ The `Dockerfile.dist` is used to generate a *production* build and runtime envir
 
 ```bash
 # build the latest image
-docker build -f Dockerfile.dist -t dspace/dspace-angular:latest-dist .
+docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-8_x-dist .
 ```
 
 A default/demo version of this image is built *automatically*.
 
 ## 'docker' directory
 - docker-compose.yml
-  - Starts DSpace Angular with Docker Compose from the current branch.  This file assumes that a DSpace 7 REST instance will also be started in Docker.
+  - Starts DSpace Angular with Docker Compose from the current branch.  This file assumes that a DSpace REST instance will also be started in Docker.
 - docker-compose-rest.yml
-  - Runs a published instance of the DSpace 7 REST API - persists data in Docker volumes
+  - Runs a published instance of the DSpace REST API - persists data in Docker volumes
 - docker-compose-ci.yml
-  - Runs a published instance of the DSpace 7 REST API for CI testing.  The database is re-populated from a SQL dump on each startup.
+  - Runs a published instance of the DSpace REST API for CI testing.  The database is re-populated from a SQL dump on each startup.
 - cli.yml
   - Docker compose file that provides a DSpace CLI container to work with a running DSpace REST container.
 - cli.assetstore.yml
@@ -59,19 +59,19 @@ A default/demo version of this image is built *automatically*.
 
 ## To refresh / pull DSpace images from Dockerhub
 ```
-docker-compose -f docker/docker-compose.yml pull
+docker compose -f docker/docker-compose.yml pull
 ```
 
 ## To build DSpace images using code in your branch
 ```
-docker-compose -f docker/docker-compose.yml build
+docker compose -f docker/docker-compose.yml build
 ```
 
 ## To start DSpace (REST and Angular) from your branch
 
 This command provides a quick way to start both the frontend & backend from this single codebase
 ```
-docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
+docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
 ```
 
 Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
@@ -86,14 +86,14 @@ _The system will be started in 2 steps. Each step shares the same docker network
 
 From 'DSpace/DSpace' clone (build first as needed):
 ```
-docker-compose -p d7 up -d
+docker compose -p d8 up -d
 ```
 
 NOTE: More detailed instructions on starting the backend via Docker can be found in the [Docker Compose instructions for the Backend](https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/README.md).
 
 From 'DSpace/dspace-angular' clone (build first as needed)
 ```
-docker-compose -p d7 -f docker/docker-compose.yml up -d
+docker compose -p d8 -f docker/docker-compose.yml up -d
 ```
 
 At this point, you should be able to access the UI from http://localhost:4000,
@@ -105,21 +105,21 @@ This allows you to run the Angular UI in *production* mode, pointing it at the d
 (https://demo.dspace.org/server/ or https://sandbox.dspace.org/server/).
 
 ```
-docker-compose -f docker/docker-compose-dist.yml pull
-docker-compose -f docker/docker-compose-dist.yml build
-docker-compose -p d7 -f docker/docker-compose-dist.yml up -d
+docker compose -f docker/docker-compose-dist.yml pull
+docker compose -f docker/docker-compose-dist.yml build
+docker compose -p d8 -f docker/docker-compose-dist.yml up -d
 ```
 
 ## Ingest test data from AIPDIR
 
 Create an administrator
 ```
-docker-compose -p d7 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
+docker compose -p d8 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
 ```
 
 Load content from AIP files
 ```
-docker-compose -p d7 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
+docker compose -p d8 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
 ```
 
 ## Alternative Ingest - Use Entities dataset
@@ -127,12 +127,12 @@ _Delete your docker volumes or use a unique project (-p) name_
 
 Start DSpace with Database Content from a database dump
 ```
-docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
+docker compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
 ```
 
 Load assetstore content and trigger a re-index of the repository
 ```
-docker-compose -p d7 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
+docker compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
 ```
 
 ## End to end testing of the REST API (runs in GitHub Actions CI).
@@ -140,5 +140,5 @@ _In this instance, only the REST api runs in Docker using the Entities dataset.
 
 This command is only really useful for testing our Continuous Integration process.
 ```
-docker-compose -p d7ci -f docker/docker-compose-ci.yml up -d
+docker compose -p d8ci -f docker/docker-compose-ci.yml up -d
 ```

docker/cli.assetstore.yml

@@ -12,8 +12,6 @@
 # https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/cli.assetstore.yml
 #
 # Therefore, it should be kept in sync with that file
-version: "3.7"
-
 services:
   dspace-cli:
     environment:

docker/cli.ingest.yml

@@ -12,8 +12,6 @@
 # https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/cli.ingest.yml
 #
 # Therefore, it should be kept in sync with that file
-version: "3.7"
-
 services:
   dspace-cli:
     environment:
@@ -34,5 +32,7 @@ services:
 
           /dspace/bin/dspace packager -r -a -t AIP -e $${ADMIN_EMAIL} -f -u SITE*.zip
           /dspace/bin/dspace database update-sequences
+          touch /dspace/solr/search/conf/reindex.flag
 
-          /dspace/bin/dspace index-discovery
+          /dspace/bin/dspace oai import
+          /dspace/bin/dspace oai clean-cache

docker/cli.yml

@@ -12,17 +12,16 @@
 # https://github.com/DSpace/DSpace/blob/main/docker-compose-cli.yml
 #
 # Therefore, it should be kept in sync with that file
-version: "3.7"
 networks:
   # Default to using network named 'dspacenet' from docker-compose-rest.yml.
-  # Its full name will be prepended with the project name (e.g. "-p d7" means it will be named "d7_dspacenet")
+  # Its full name will be prepended with the project name (e.g. "-p d8" means it will be named "d8_dspacenet")
   # If COMPOSITE_PROJECT_NAME is missing, default value will be "docker" (name of folder this file is in)
   default:
     name: ${COMPOSE_PROJECT_NAME:-docker}_dspacenet
     external: true
 services:
   dspace-cli:
-    image: "${DOCKER_OWNER:-dspace}/dspace-cli:${DSPACE_VER:-latest}"
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-cli:${DSPACE_VER:-dspace-8_x}"
     container_name: dspace-cli
     environment:
       # Below syntax may look odd, but it is how to override dspace.cfg settings via env variables.

docker/db.entities.yml

@@ -12,14 +12,13 @@
 # https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/db.entities.yml
 #
 # # Therefore, it should be kept in sync with that file
-version: "3.7"
-
 services:
   dspacedb:
-    image: dspace/dspace-postgres-pgcrypto:loadsql
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-dspace-8_x}-loadsql"
     environment:
       # This LOADSQL should be kept in sync with the URL in DSpace/DSpace
       # This SQL is available from https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
+      # NOTE: currently there is no dspace8 version
       - LOADSQL=https://github.com/DSpace-Labs/AIP-Files/releases/download/demo-entities-data/dspace7-entities-data.sql
   dspace:
     ### OVERRIDE default 'entrypoint' in 'docker-compose-rest.yml' ####
@@ -29,23 +28,11 @@ services:
     # 3. (Custom for Entities) enable Entity-specific collection submission mappings in item-submission.xml
     #    This 'sed' command inserts the sample configurations specific to the Entities data set, see:
     #    https://github.com/DSpace/DSpace/blob/main/dspace/config/item-submission.xml#L36-L49
-    # 4. Finally, start Tomcat
+    # 4. Finally, start DSpace
     entrypoint:
       - /bin/bash
       - '-c'
       - |
         while (!</dev/tcp/dspacedb/5432) > /dev/null 2>&1; do sleep 1; done;
         /dspace/bin/dspace database migrate ignored
-        sed -i '/name-map collection-handle="default".*/a \\n <name-map collection-handle="123456789/3" submission-name="Publication"/> \
-          <name-map collection-handle="123456789/4" submission-name="Publication"/> \
-          <name-map collection-handle="123456789/281" submission-name="Publication"/> \
-          <name-map collection-handle="123456789/5" submission-name="Publication"/> \
-          <name-map collection-handle="123456789/8" submission-name="OrgUnit"/> \
-          <name-map collection-handle="123456789/6" submission-name="Person"/> \
-          <name-map collection-handle="123456789/279" submission-name="Person"/> \
-          <name-map collection-handle="123456789/7" submission-name="Project"/> \
-          <name-map collection-handle="123456789/280" submission-name="Project"/> \
-          <name-map collection-handle="123456789/28" submission-name="Journal"/> \
-          <name-map collection-handle="123456789/29" submission-name="JournalVolume"/> \
-          <name-map collection-handle="123456789/30" submission-name="JournalIssue"/>' /dspace/config/item-submission.xml
-        catalina.sh run
+        java -jar /dspace/webapps/server-boot.jar --dspace.dir=/dspace

docker/docker-compose-ci.yml

@@ -10,7 +10,6 @@
 # This is used by our GitHub CI at .github/workflows/build.yml
 # It is based heavily on the Backend's Docker Compose:
 # https://github.com/DSpace/DSpace/blob/main/docker-compose.yml
-version: '3.7'
 networks:
   dspacenet:
 services:
@@ -33,7 +32,8 @@ services:
       # Tell Statistics to commit all views immediately instead of waiting on Solr's autocommit.
       # This allows us to generate statistics in e2e tests so that statistics pages can be tested thoroughly.
       solr__D__statistics__P__autoCommit: 'false'
-    image: "${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-latest-test}"
+      LOGGING_CONFIG: /dspace/config/log4j2-container.xml
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-dspace-8_x-test}"
     depends_on:
     - dspacedb
     networks:
@@ -48,27 +48,32 @@ services:
     # Ensure that the database is ready BEFORE starting tomcat
     # 1. While a TCP connection to dspacedb port 5432 is not available, continue to sleep
     # 2. Then, run database migration to init database tables (including any out-of-order ignored migrations, if any)
-    # 3. Finally, start Tomcat
+    # 3. Finally, start DSpace
     entrypoint:
     - /bin/bash
     - '-c'
     - |
       while (!</dev/tcp/dspacedb/5432) > /dev/null 2>&1; do sleep 1; done;
       /dspace/bin/dspace database migrate ignored
-      catalina.sh run
+      java -jar /dspace/webapps/server-boot.jar --dspace.dir=/dspace
   # DSpace database container
   # NOTE: This is customized to use our loadsql image, so that we are using a database with existing test data
   dspacedb:
     container_name: dspacedb
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-dspace-8_x}-loadsql"
     environment:
       # This LOADSQL should be kept in sync with the LOADSQL in
       # https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/db.entities.yml
       # This SQL is available from https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
+      # NOTE: currently there is no dspace8 version
       LOADSQL: https://github.com/DSpace-Labs/AIP-Files/releases/download/demo-entities-data/dspace7-entities-data.sql
       PGDATA: /pgdata
-    image: dspace/dspace-postgres-pgcrypto:loadsql
+      POSTGRES_PASSWORD: dspace
     networks:
       - dspacenet
+    ports:
+    - published: 5432
+      target: 5432
     stdin_open: true
     tty: true
     volumes:
@@ -77,7 +82,7 @@ services:
   # DSpace Solr container
   dspacesolr:
     container_name: dspacesolr
-    image: "${DOCKER_OWNER:-dspace}/dspace-solr:${DSPACE_VER:-latest}"
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-solr:${DSPACE_VER:-dspace-8_x}"
     networks:
       - dspacenet
     ports:
@@ -105,6 +110,8 @@ services:
       cp -r /opt/solr/server/solr/configsets/statistics/* statistics
       precreate-core qaevent /opt/solr/server/solr/configsets/qaevent
       cp -r /opt/solr/server/solr/configsets/qaevent/* qaevent
+      precreate-core suggestion /opt/solr/server/solr/configsets/suggestion
+      cp -r /opt/solr/server/solr/configsets/suggestion/* suggestion
       exec solr -f
 volumes:
   assetstore:

docker/docker-compose-dist.yml

@@ -8,7 +8,6 @@
 
 # Docker Compose for running the DSpace Angular UI dist build
 # for previewing with the DSpace Demo site backend
-version: '3.7'
 networks:
   dspacenet:
 services:
@@ -27,7 +26,7 @@ services:
       DSPACE_REST_HOST: sandbox.dspace.org
       DSPACE_REST_PORT: 443
       DSPACE_REST_NAMESPACE: /server
-    image: dspace/dspace-angular:${DSPACE_VER:-latest}-dist
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-angular:${DSPACE_VER:-dspace-8_x}-dist"
     build:
       context: ..
       dockerfile: Dockerfile.dist

docker/docker-compose-rest.yml

@@ -10,7 +10,6 @@
 # This is based heavily on the docker-compose.yml that is available in the DSpace/DSpace
 # (Backend) at:
 # https://github.com/DSpace/DSpace/blob/main/docker-compose.yml
-version: '3.7'
 networks:
   dspacenet:
     ipam:
@@ -29,8 +28,9 @@ services:
       # __D__ => "-" (e.g. google__D__metadata => google-metadata)
       # dspace.dir, dspace.server.url, dspace.ui.url and dspace.name
       dspace__P__dir: /dspace
-      dspace__P__server__P__url: http://localhost:8080/server
-      dspace__P__ui__P__url: http://localhost:4000
+      # Uncomment to set a non-default value for dspace.server.url or dspace.ui.url
+      # dspace__P__server__P__url: http://localhost:8080/server
+      # dspace__P__ui__P__url: http://localhost:4000
       dspace__P__name: 'DSpace Started with Docker Compose'
       # db.url: Ensure we are using the 'dspacedb' image for our database
       db__P__url: 'jdbc:postgresql://dspacedb:5432/dspace'
@@ -39,7 +39,8 @@ services:
       # proxies.trusted.ipranges: This setting is required for a REST API running in Docker to trust requests 
       # from the host machine. This IP range MUST correspond to the 'dspacenet' subnet defined above.
       proxies__P__trusted__P__ipranges: '172.23.0'
-    image: "${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-latest-test}"
+      LOGGING_CONFIG: /dspace/config/log4j2-container.xml
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-dspace-8_x-test}"
     depends_on:
     - dspacedb
     networks:
@@ -50,24 +51,27 @@ services:
     stdin_open: true
     tty: true
     volumes:
+    # Keep DSpace assetstore directory between reboots
     - assetstore:/dspace/assetstore
     # Ensure that the database is ready BEFORE starting tomcat
     # 1. While a TCP connection to dspacedb port 5432 is not available, continue to sleep
     # 2. Then, run database migration to init database tables
-    # 3. Finally, start Tomcat
+    # 3. Finally, start DSpace
     entrypoint:
     - /bin/bash
     - '-c'
     - |
       while (!</dev/tcp/dspacedb/5432) > /dev/null 2>&1; do sleep 1; done;
       /dspace/bin/dspace database migrate
-      catalina.sh run
+      java -jar /dspace/webapps/server-boot.jar --dspace.dir=/dspace
   # DSpace database container    
   dspacedb:
     container_name: dspacedb
+    # Uses a custom Postgres image with pgcrypto installed
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-dspace-8_x}"
     environment:
       PGDATA: /pgdata
-    image: "${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-latest}"
+      POSTGRES_PASSWORD: dspace
     networks:
       - dspacenet
     ports:
@@ -81,7 +85,7 @@ services:
   # DSpace Solr container  
   dspacesolr:
     container_name: dspacesolr
-    image: "${DOCKER_OWNER:-dspace}/dspace-solr:${DSPACE_VER:-latest}"
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-solr:${DSPACE_VER:-dspace-8_x}"
     networks:
       - dspacenet
     ports:
@@ -97,7 +101,7 @@ services:
     # * First, run precreate-core to create the core (if it doesn't yet exist). If exists already, this is a no-op
     # * Second, copy configsets to this core:
     #   Updates to Solr configs require the container to be rebuilt/restarted:
-    #   `docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d --build dspacesolr`
+    #   `docker compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d --build dspacesolr`
     entrypoint:
     - /bin/bash
     - '-c'
@@ -113,6 +117,8 @@ services:
       cp -r /opt/solr/server/solr/configsets/statistics/* statistics
       precreate-core qaevent /opt/solr/server/solr/configsets/qaevent
       cp -r /opt/solr/server/solr/configsets/qaevent/* qaevent
+      precreate-core suggestion /opt/solr/server/solr/configsets/suggestion
+      cp -r /opt/solr/server/solr/configsets/suggestion/* suggestion
       exec solr -f
 volumes:
   assetstore:

docker/docker-compose.yml

@@ -9,7 +9,6 @@
 # Docker Compose for running the DSpace Angular UI for testing/development
 # Requires also running a REST API backend (either locally or remotely),
 # for example via 'docker-compose-rest.yml'
-version: '3.7'
 networks:
   dspacenet:
 services:
@@ -24,7 +23,7 @@ services:
       DSPACE_REST_HOST: localhost
       DSPACE_REST_PORT: 8080
       DSPACE_REST_NAMESPACE: /server
-    image: dspace/dspace-angular:${DSPACE_VER:-latest}
+    image: "${DOCKER_REGISTRY:-docker.io}/${DOCKER_OWNER:-dspace}/dspace-angular:${DSPACE_VER:-dspace-8_x}"
     build:
       context: ..
       dockerfile: Dockerfile

docs/lint/html/index.md

@@ -0,0 +1,5 @@
+[DSpace ESLint plugins](../../../lint/README.md) > HTML rules
+_______
+
+- [`dspace-angular-html/themed-component-usages`](./rules/themed-component-usages.md): Themeable components should be used via the selector of their `ThemedComponent` wrapper class
+- [`dspace-angular-html/no-disabled-attribute-on-button`](./rules/no-disabled-attribute-on-button.md): Buttons should use the `dsBtnDisabled` directive instead of the HTML `disabled` attribute.

docs/lint/html/rules/no-disabled-attribute-on-button.md

@@ -0,0 +1,78 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [HTML rules](../index.md) > `dspace-angular-html/no-disabled-attribute-on-button`
+_______
+
+Buttons should use the `dsBtnDisabled` directive instead of the HTML `disabled` attribute.
+      This should be done to ensure that users with a screen reader are able to understand that the a button button is present, and that it is disabled.
+      The native html disabled attribute does not allow users to navigate to the button by keyboard, and thus they have no way of knowing that the button is present.
+
+_______
+
+[Source code](../../../../lint/src/rules/html/no-disabled-attribute-on-button.ts)
+
+### Examples
+
+
+#### Valid code
+    
+##### should use [dsBtnDisabled] in HTML templates
+        
+```html
+<button [dsBtnDisabled]="true">Submit</button>
+```
+    
+##### disabled attribute is still valid on non-button elements
+        
+```html
+<input disabled>
+```
+    
+##### [disabled] attribute is still valid on non-button elements
+        
+```html
+<input [disabled]="true">
+```
+    
+##### angular dynamic attributes that use disabled are still valid
+        
+```html
+<button [class.disabled]="isDisabled">Submit</button>
+```
+    
+
+
+
+#### Invalid code  &amp; automatic fixes
+    
+##### should not use disabled attribute in HTML templates
+        
+```html
+<button disabled>Submit</button>
+```
+Will produce the following error(s):
+```
+Buttons should use the `dsBtnDisabled` directive instead of the `disabled` attribute.
+```
+        
+Result of `yarn lint --fix`:
+```html
+<button [dsBtnDisabled]="true">Submit</button>
+```
+        
+    
+##### should not use [disabled] attribute in HTML templates
+        
+```html
+<button [disabled]="true">Submit</button>
+```
+Will produce the following error(s):
+```
+Buttons should use the `dsBtnDisabled` directive instead of the `disabled` attribute.
+```
+        
+Result of `yarn lint --fix`:
+```html
+<button [dsBtnDisabled]="true">Submit</button>
+```
+        
+    
+

docs/lint/html/rules/themed-component-usages.md

@@ -0,0 +1,110 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [HTML rules](../index.md) > `dspace-angular-html/themed-component-usages`
+_______
+
+Themeable components should be used via the selector of their `ThemedComponent` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+The only exception to this rule are unit tests, where we may want to use the base component in order to keep the test setup simple.
+      
+
+_______
+
+[Source code](../../../../lint/src/rules/html/themed-component-usages.ts)
+
+### Examples
+
+
+#### Valid code
+    
+##### use no-prefix selectors in HTML templates
+        
+```html
+<ds-test-themeable/>
+<ds-test-themeable></ds-test-themeable>
+<ds-test-themeable [test]="something"></ds-test-themeable>
+```
+    
+##### use no-prefix selectors in TypeScript templates
+        
+```html
+@Component({
+  template: '<ds-test-themeable></ds-test-themeable>'
+})
+class Test {
+}
+```
+    
+##### use no-prefix selectors in TypeScript test templates
+        
+Filename: `lint/test/fixture/src/test.spec.ts`
+        
+```html
+@Component({
+  template: '<ds-test-themeable></ds-test-themeable>'
+})
+class Test {
+}
+```
+    
+##### base selectors are also allowed in TypeScript test templates
+        
+Filename: `lint/test/fixture/src/test.spec.ts`
+        
+```html
+@Component({
+  template: '<ds-base-test-themeable></ds-base-test-themeable>'
+})
+class Test {
+}
+```
+    
+
+
+
+#### Invalid code  &amp; automatic fixes
+    
+##### themed override selectors are not allowed in HTML templates
+        
+```html
+<ds-themed-test-themeable/>
+<ds-themed-test-themeable></ds-themed-test-themeable>
+<ds-themed-test-themeable [test]="something"></ds-themed-test-themeable>
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+```
+        
+Result of `yarn lint --fix`:
+```html
+<ds-test-themeable/>
+<ds-test-themeable></ds-test-themeable>
+<ds-test-themeable [test]="something"></ds-test-themeable>
+```
+        
+    
+##### base selectors are not allowed in HTML templates
+        
+```html
+<ds-base-test-themeable/>
+<ds-base-test-themeable></ds-base-test-themeable>
+<ds-base-test-themeable [test]="something"></ds-base-test-themeable>
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+Themeable components should be used via their ThemedComponent wrapper's selector
+```
+        
+Result of `yarn lint --fix`:
+```html
+<ds-test-themeable/>
+<ds-test-themeable></ds-test-themeable>
+<ds-test-themeable [test]="something"></ds-test-themeable>
+```
+        
+    
+

docs/lint/ts/index.md

@@ -0,0 +1,6 @@
+[DSpace ESLint plugins](../../../lint/README.md) > TypeScript rules
+_______
+
+- [`dspace-angular-ts/themed-component-classes`](./rules/themed-component-classes.md): Formatting rules for themeable component classes
+- [`dspace-angular-ts/themed-component-selectors`](./rules/themed-component-selectors.md): Themeable component selectors should follow the DSpace convention
+- [`dspace-angular-ts/themed-component-usages`](./rules/themed-component-usages.md): Themeable components should be used via their `ThemedComponent` wrapper class

docs/lint/ts/rules/themed-component-classes.md

@@ -0,0 +1,257 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/themed-component-classes`
+_______
+
+Formatting rules for themeable component classes
+
+- All themeable components must be standalone.
+- The base component must always be imported in the `ThemedComponent` wrapper. This ensures that it is always sufficient to import just the wrapper whenever we use the component.
+      
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/themed-component-classes.ts)
+
+### Examples
+
+
+#### Valid code
+    
+##### Regular non-themeable component
+        
+```typescript
+@Component({
+  selector: 'ds-something',
+  standalone: true,
+})
+class Something {
+}
+```
+    
+##### Base component
+        
+```typescript
+@Component({
+  selector: 'ds-base-test-themable',
+  standalone: true,
+})
+class TestThemeableTomponent {
+}
+```
+    
+##### Wrapper component
+        
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [
+    TestThemeableComponent,
+  ],
+})
+class ThemedTestThemeableTomponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+    
+##### Override component
+        
+Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-themed-test-themable',
+  standalone: true,
+})
+class Override extends BaseComponent {
+}
+```
+    
+
+
+
+#### Invalid code  &amp; automatic fixes
+    
+##### Base component must be standalone
+        
+```typescript
+@Component({
+  selector: 'ds-base-test-themable',
+})
+class TestThemeableComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components must be standalone
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-base-test-themable',
+  standalone: true,
+})
+class TestThemeableComponent {
+}
+```
+        
+    
+##### Wrapper component must be standalone and import base component
+        
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-test-themable',
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+Will produce the following error(s):
+```
+Themeable component wrapper classes must be standalone and import the base class
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+        
+    
+##### Wrapper component must import base component (array present but empty)
+        
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper classes must only import the base class
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+        
+    
+##### Wrapper component must import base component (array is wrong)
+        
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+        
+```typescript
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [
+    SomethingElse,
+  ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper classes must only import the base class
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+        
+    
+##### Wrapper component must import base component (array is wrong)
+        
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+        
+```typescript
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [
+    SomethingElse,
+  ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper classes must only import the base class
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+        
+    
+##### Override component must be standalone
+        
+Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-themed-test-themable',
+})
+class Override extends BaseComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components must be standalone
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-themed-test-themable',
+  standalone: true,
+})
+class Override extends BaseComponent {
+}
+```
+        
+    
+

docs/lint/ts/rules/themed-component-selectors.md

@@ -0,0 +1,156 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/themed-component-selectors`
+_______
+
+Themeable component selectors should follow the DSpace convention
+
+Each themeable component is comprised of a base component, a wrapper component and any number of themed components
+- Base components should have a selector starting with `ds-base-`
+- Themed components should have a selector starting with `ds-themed-`
+- Wrapper components should have a selector starting with `ds-`, but not `ds-base-` or `ds-themed-`
+  - This is the regular DSpace selector prefix
+  - **When making a regular component themeable, its selector prefix should be changed to `ds-base-`, and the new wrapper's component should reuse the previous selector**
+
+Unit tests are exempt from this rule, because they may redefine components using the same class name as other themeable components elsewhere in the source.
+      
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/themed-component-selectors.ts)
+
+### Examples
+
+
+#### Valid code
+    
+##### Regular non-themeable component selector
+        
+```typescript
+@Component({
+  selector: 'ds-something',
+})
+class Something {
+}
+```
+    
+##### Themeable component selector should replace the original version, unthemed version should be changed to ds-base-
+        
+```typescript
+@Component({
+  selector: 'ds-base-something',
+})
+class Something {
+}
+
+@Component({
+  selector: 'ds-something',
+})
+class ThemedSomething extends ThemedComponent<Something> {
+}
+
+@Component({
+  selector: 'ds-themed-something',
+})
+class OverrideSomething extends Something {
+}
+```
+    
+##### Other themed component wrappers should not interfere
+        
+```typescript
+@Component({
+  selector: 'ds-something',
+})
+class Something {
+}
+
+@Component({
+  selector: 'ds-something-else',
+})
+class ThemedSomethingElse extends ThemedComponent<SomethingElse> {
+}
+```
+    
+
+
+
+#### Invalid code  &amp; automatic fixes
+    
+##### Wrong selector for base component
+        
+Filename: `lint/test/fixture/src/app/test/test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-something',
+})
+class TestThemeableComponent {
+}
+```
+Will produce the following error(s):
+```
+Unthemed version of themeable component should have a selector starting with 'ds-base-'
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-base-something',
+})
+class TestThemeableComponent {
+}
+```
+        
+    
+##### Wrong selector for wrapper component
+        
+Filename: `lint/test/fixture/src/app/test/themed-test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-themed-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+Will produce the following error(s):
+```
+Themed component wrapper of themeable component shouldn't have a selector starting with 'ds-themed-'
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+        
+    
+##### Wrong selector for theme override
+        
+Filename: `lint/test/fixture/src/themes/test/app/test/test-themeable.component.ts`
+        
+```typescript
+@Component({
+  selector: 'ds-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+```
+Will produce the following error(s):
+```
+Theme override of themeable component should have a selector starting with 'ds-themed-'
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+@Component({
+  selector: 'ds-themed-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+```
+        
+    
+

docs/lint/ts/rules/themed-component-usages.md

@@ -0,0 +1,332 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [TypeScript rules](../index.md) > `dspace-angular-ts/themed-component-usages`
+_______
+
+Themeable components should be used via their `ThemedComponent` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+There are a few exceptions where the base class can still be used:
+- Class declaration expressions (otherwise we can't declare, extend or override the class in the first place)
+- Angular modules (except for routing modules)
+- Angular `@ViewChild` decorators
+- Type annotations
+      
+
+_______
+
+[Source code](../../../../lint/src/rules/ts/themed-component-usages.ts)
+
+### Examples
+
+
+#### Valid code
+    
+##### allow wrapper class usages
+        
+```typescript
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+
+const config = {
+  a: ThemedTestThemeableComponent,
+  b: ChipsComponent,
+}
+```
+    
+##### allow base class in class declaration
+        
+```typescript
+export class TestThemeableComponent {
+}
+```
+    
+##### allow inheriting from base class
+        
+```typescript
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class ThemedAdminSidebarComponent extends ThemedComponent<TestThemeableComponent> {
+}
+```
+    
+##### allow base class in ViewChild
+        
+```typescript
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class Something {
+  @ViewChild(TestThemeableComponent) test: TestThemeableComponent;
+}
+```
+    
+##### allow wrapper selectors in test queries
+        
+Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
+        
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+    
+##### allow wrapper selectors in cypress queries
+        
+Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
+        
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+    
+
+
+
+#### Invalid code  &amp; automatic fixes
+    
+##### disallow direct usages of base class
+        
+```typescript
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: TestThemeableComponent,
+  b: TestComponent,
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: ThemedTestThemeableComponent,
+  b: TestComponent,
+}
+```
+        
+    
+##### disallow direct usages of base class, keep other imports
+        
+```typescript
+import { Something, TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: TestThemeableComponent,
+  b: TestComponent,
+  c: Something,
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { Something } from './app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: ThemedTestThemeableComponent,
+  b: TestComponent,
+  c: Something,
+}
+```
+        
+    
+##### handle array replacements correctly
+        
+```typescript
+const DECLARATIONS = [
+  Something,
+  TestThemeableComponent,
+  Something,
+  ThemedTestThemeableComponent,
+];
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+const DECLARATIONS = [
+  Something,
+  Something,
+  ThemedTestThemeableComponent,
+];
+```
+        
+    
+##### disallow override selector in test queries
+        
+Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
+        
+```typescript
+By.css('ds-themed-themeable');
+By.css('#test > ds-themed-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+        
+    
+##### disallow base selector in test queries
+        
+Filename: `lint/test/fixture/src/app/test/test.component.spec.ts`
+        
+```typescript
+By.css('ds-base-themeable');
+By.css('#test > ds-base-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+```
+        
+    
+##### disallow override selector in cypress queries
+        
+Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
+        
+```typescript
+cy.get('ds-themed-themeable');
+cy.get('#test > ds-themed-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+```
+        
+    
+##### disallow base selector in cypress queries
+        
+Filename: `lint/test/fixture/src/app/test/test.component.cy.ts`
+        
+```typescript
+cy.get('ds-base-themeable');
+cy.get('#test > ds-base-themeable > #nest');
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+```
+        
+    
+##### edge case: unable to find usage node through usage token, but import is still flagged and fixed
+        
+Filename: `lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts`
+        
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+        
+    
+##### edge case edge case: both are imported, only wrapper is retained
+        
+Filename: `lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts`
+        
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [TestThemeableComponent, ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+Will produce the following error(s):
+```
+Themeable components should be used via their ThemedComponent wrapper
+Themeable components should be used via their ThemedComponent wrapper
+```
+        
+Result of `yarn lint --fix`:
+```typescript
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+```
+        
+    
+

lint/.gitignore

@@ -0,0 +1,3 @@
+/dist/
+/coverage/
+/node-modules/

lint/README.md

@@ -0,0 +1,50 @@
+# DSpace ESLint plugins
+
+Custom ESLint rules for DSpace Angular peculiarities.
+
+## Usage
+
+These plugins are included with the rest of our ESLint configuration in [.eslintc.json](../.eslintrc.json). Individual rules can be configured or disabled there, like usual.
+- In order for the new rules to be picked up by your IDE, you should first run `yarn build:lint` to build the plugins.
+- This will also happen automatically each time `yarn lint` is run.
+
+## Documentation
+
+The rules are split up into plugins by language:
+- [TypeScript rules](../docs/lint/ts/index.md)
+- [HTML rules](../docs/lint/html/index.md)
+
+> Run `yarn docs:lint` to generate this documentation!
+
+## Developing
+
+### Overview
+
+- All rules are written in TypeScript and compiled into [`dist`](./dist)
+  - The plugins are linked into the main project dependencies from here
+  - These directories already contain the necessary `package.json` files to mark them as ESLint plugins
+- Rule source files are structured, so they can be imported all in one go
+  - Each rule must export the following:
+    - `Messages`: an Enum of error message IDs
+    - `info`: metadata about this rule (name, description, messages, options, ...)
+    - `rule`: the implementation of the rule
+    - `tests`: the tests for this rule, as a set of valid/invalid code snippets. These snippets are used as example in the documentation.
+  - New rules should be added to their plugin's `index.ts`
+- Some useful links
+  - [Developing ESLint plugins](https://eslint.org/docs/latest/extend/plugins)
+  - [Custom rules in typescript-eslint](https://typescript-eslint.io/developers/custom-rules)
+  - [Angular ESLint](https://github.com/angular-eslint/angular-eslint)
+
+### Parsing project metadata in advance ~ TypeScript AST
+
+While it is possible to retain persistent state between files during the linting process, it becomes quite complicated if the content of one file determines how we want to lint another file.
+Because the two files may be linted out of order, we may not know whether the first file is wrong before we pass by the second. This means that we cannot report or fix the issue, because the first file is already detached from the linting context.
+
+For example, we cannot consistently determine which components are themeable (i.e. have a `ThemedComponent` wrapper) while linting.
+To work around this issue, we construct a registry of themeable components _before_ linting anything.
+- We don't have a good way to hook into the ESLint parser at this time
+- Instead, we leverage the actual TypeScript AST parser
+  - Retrieve all `ThemedComponent` wrapper files by the pattern of their path (`themed-*.component.ts`)
+  - Determine the themed component they're linked to (by the actual type annotation/import path, since filenames are prone to errors)
+  - Store metadata describing these component pairs in a global registry that can be shared between rules
+- This only needs to happen once, and only takes a fraction of a second (for ~100 themeable components)

lint/dist/src/rules/html/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "eslint-plugin-dspace-angular-html",
+  "version": "0.0.0",
+  "main": "./index.js",
+  "private": true
+}

lint/dist/src/rules/ts/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "eslint-plugin-dspace-angular-ts",
+  "version": "0.0.0",
+  "main": "./index.js",
+  "private": true
+}

lint/generate-docs.ts

@@ -0,0 +1,85 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import {
+  existsSync,
+  mkdirSync,
+  readFileSync,
+  rmSync,
+  writeFileSync,
+} from 'fs';
+import { join } from 'path';
+
+import { default as htmlPlugin } from './src/rules/html';
+import { default as tsPlugin } from './src/rules/ts';
+
+const templates = new Map();
+
+function lazyEJS(path: string, data: object): string {
+  if (!templates.has(path)) {
+    templates.set(path, require('ejs').compile(readFileSync(path).toString()));
+  }
+
+  return templates.get(path)(data).replace(/\r\n/g, '\n');
+}
+
+const docsDir = join('docs', 'lint');
+const tsDir = join(docsDir, 'ts');
+const htmlDir = join(docsDir, 'html');
+
+if (existsSync(docsDir)) {
+  rmSync(docsDir, { recursive: true });
+}
+
+mkdirSync(join(tsDir, 'rules'), { recursive: true });
+mkdirSync(join(htmlDir, 'rules'), { recursive: true });
+
+function template(name: string): string {
+  return join('lint', 'src', 'util', 'templates', name);
+}
+
+// TypeScript docs
+writeFileSync(
+  join(tsDir, 'index.md'),
+  lazyEJS(template('index.ejs'), {
+    plugin: tsPlugin,
+    rules: tsPlugin.index.map(rule => rule.info),
+  }),
+);
+
+for (const rule of tsPlugin.index) {
+  writeFileSync(
+    join(tsDir, 'rules', rule.info.name + '.md'),
+    lazyEJS(template('rule.ejs'), {
+      plugin: tsPlugin,
+      rule: rule.info,
+      tests: rule.tests,
+    }),
+  );
+}
+
+// HTML docs
+writeFileSync(
+  join(htmlDir, 'index.md'),
+  lazyEJS(template('index.ejs'), {
+    plugin: htmlPlugin,
+    rules: htmlPlugin.index.map(rule => rule.info),
+  }),
+);
+
+for (const rule of htmlPlugin.index) {
+  writeFileSync(
+    join(htmlDir, 'rules', rule.info.name + '.md'),
+    lazyEJS(template('rule.ejs'), {
+      plugin: htmlPlugin,
+      rule: rule.info,
+      tests: rule.tests,
+    }),
+  );
+}
+

lint/jasmine.json

@@ -0,0 +1,7 @@
+{
+  "spec_files": ["**/*.spec.js"],
+  "spec_dir": "lint/dist/test",
+  "helpers": [
+    "./test/helpers.js"
+  ]
+}

lint/src/rules/html/index.ts

@@ -0,0 +1,25 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+/* eslint-disable import/no-namespace */
+import {
+  bundle,
+  RuleExports,
+} from '../../util/structure';
+import * as noDisabledAttributeOnButton from './no-disabled-attribute-on-button';
+import * as themedComponentUsages from './themed-component-usages';
+
+const index = [
+  themedComponentUsages,
+  noDisabledAttributeOnButton,
+
+] as unknown as RuleExports[];
+
+export = {
+  parser: require('@angular-eslint/template-parser'),
+  ...bundle('dspace-angular-html', 'HTML', index),
+};

lint/src/rules/html/no-disabled-attribute-on-button.ts

@@ -0,0 +1,147 @@
+import {
+  TmplAstBoundAttribute,
+  TmplAstTextAttribute,
+} from '@angular-eslint/bundled-angular-compiler';
+import { TemplateParserServices } from '@angular-eslint/utils';
+import {
+  ESLintUtils,
+  TSESLint,
+} from '@typescript-eslint/utils';
+
+import {
+  DSpaceESLintRuleInfo,
+  NamedTests,
+} from '../../util/structure';
+import { getSourceCode } from '../../util/typescript';
+
+export enum Message {
+  USE_DSBTN_DISABLED = 'mustUseDsBtnDisabled',
+}
+
+export const info = {
+  name: 'no-disabled-attribute-on-button',
+  meta: {
+    docs: {
+      description: `Buttons should use the \`dsBtnDisabled\` directive instead of the HTML \`disabled\` attribute.
+      This should be done to ensure that users with a screen reader are able to understand that the a button button is present, and that it is disabled.
+      The native html disabled attribute does not allow users to navigate to the button by keyboard, and thus they have no way of knowing that the button is present.`,
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: [],
+    messages: {
+      [Message.USE_DSBTN_DISABLED]: 'Buttons should use the `dsBtnDisabled` directive instead of the `disabled` attribute.',
+    },
+  },
+  defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+  ...info,
+  create(context: TSESLint.RuleContext<Message, unknown[]>) {
+    const parserServices = getSourceCode(context).parserServices as TemplateParserServices;
+
+    /**
+     * Some dynamic angular inputs will have disabled as name because of how Angular handles this internally (e.g [class.disabled]="isDisabled")
+     * But these aren't actually the disabled attribute we're looking for, we can determine this by checking the details of the keySpan
+     */
+    function isOtherAttributeDisabled(node: TmplAstBoundAttribute | TmplAstTextAttribute): boolean {
+      // if the details are not null, and the details are not 'disabled', then it's not the disabled attribute we're looking for
+      return node.keySpan?.details !== null && node.keySpan?.details !== 'disabled';
+    }
+
+    /**
+     * Replace the disabled text with [dsBtnDisabled] in the template
+     */
+    function replaceDisabledText(text: string ): string {
+      const hasBrackets = text.includes('[') && text.includes(']');
+      const newDisabledText = hasBrackets ? 'dsBtnDisabled' : '[dsBtnDisabled]="true"';
+      return text.replace('disabled', newDisabledText);
+    }
+
+    function inputIsChildOfButton(node: any): boolean {
+      return (node.parent?.tagName === 'button' || node.parent?.name === 'button');
+    }
+
+    function reportAndFix(node: TmplAstBoundAttribute | TmplAstTextAttribute) {
+      if (!inputIsChildOfButton(node) || isOtherAttributeDisabled(node)) {
+        return;
+      }
+
+      const sourceSpan = node.sourceSpan;
+      context.report({
+        messageId: Message.USE_DSBTN_DISABLED,
+        loc: parserServices.convertNodeSourceSpanToLoc(sourceSpan),
+        fix(fixer) {
+          const templateText = sourceSpan.start.file.content;
+          const disabledText = templateText.slice(sourceSpan.start.offset, sourceSpan.end.offset);
+          const newText = replaceDisabledText(disabledText);
+          return fixer.replaceTextRange([sourceSpan.start.offset, sourceSpan.end.offset], newText);
+        },
+      });
+    }
+
+    return {
+      'BoundAttribute[name="disabled"]'(node: TmplAstBoundAttribute) {
+        reportAndFix(node);
+      },
+      'TextAttribute[name="disabled"]'(node: TmplAstTextAttribute) {
+        reportAndFix(node);
+      },
+    };
+  },
+});
+
+export const tests = {
+  plugin: info.name,
+  valid: [
+    {
+      name: 'should use [dsBtnDisabled] in HTML templates',
+      code: `
+<button [dsBtnDisabled]="true">Submit</button>
+      `,
+    },
+    {
+      name: 'disabled attribute is still valid on non-button elements',
+      code: `
+<input disabled>
+      `,
+    },
+    {
+      name: '[disabled] attribute is still valid on non-button elements',
+      code: `
+<input [disabled]="true">
+      `,
+    },
+    {
+      name: 'angular dynamic attributes that use disabled are still valid',
+      code: `
+<button [class.disabled]="isDisabled">Submit</button>
+      `,
+    },
+  ],
+  invalid: [
+    {
+      name: 'should not use disabled attribute in HTML templates',
+      code: `
+<button disabled>Submit</button>
+      `,
+      errors: [{ messageId: Message.USE_DSBTN_DISABLED }],
+      output: `
+<button [dsBtnDisabled]="true">Submit</button>
+      `,
+    },
+    {
+      name: 'should not use [disabled] attribute in HTML templates',
+      code: `
+<button [disabled]="true">Submit</button>
+      `,
+      errors: [{ messageId: Message.USE_DSBTN_DISABLED }],
+      output: `
+<button [dsBtnDisabled]="true">Submit</button>
+      `,
+    },
+  ],
+} as NamedTests;
+
+export default rule;

lint/src/rules/html/themed-component-usages.ts

@@ -0,0 +1,189 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TmplAstElement } from '@angular-eslint/bundled-angular-compiler';
+import { TemplateParserServices } from '@angular-eslint/utils';
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import {
+  DSpaceESLintRuleInfo,
+  NamedTests,
+} from '../../util/structure';
+import {
+  DISALLOWED_THEME_SELECTORS,
+  fixSelectors,
+} from '../../util/theme-support';
+import {
+  getFilename,
+  getSourceCode,
+} from '../../util/typescript';
+
+export enum Message {
+  WRONG_SELECTOR = 'mustUseThemedWrapperSelector',
+}
+
+export const info = {
+  name: 'themed-component-usages',
+  meta: {
+    docs: {
+      description: `Themeable components should be used via the selector of their \`ThemedComponent\` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+The only exception to this rule are unit tests, where we may want to use the base component in order to keep the test setup simple.
+      `,
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: [],
+    messages: {
+      [Message.WRONG_SELECTOR]: 'Themeable components should be used via their ThemedComponent wrapper\'s selector',
+    },
+  },
+  defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+  ...info,
+  create(context: RuleContext<Message, unknown[]>) {
+    if (getFilename(context).includes('.spec.ts')) {
+      // skip inline templates in unit tests
+      return {};
+    }
+
+    const parserServices = getSourceCode(context).parserServices as TemplateParserServices;
+
+    return {
+      [`Element$1[name = /^${DISALLOWED_THEME_SELECTORS}/]`](node: TmplAstElement) {
+        const { startSourceSpan, endSourceSpan } = node;
+        const openStart = startSourceSpan.start.offset as number;
+
+        context.report({
+          messageId: Message.WRONG_SELECTOR,
+          loc: parserServices.convertNodeSourceSpanToLoc(startSourceSpan),
+          fix(fixer) {
+            const oldSelector = node.name;
+            const newSelector = fixSelectors(oldSelector);
+
+            const ops = [
+              fixer.replaceTextRange([openStart + 1, openStart + 1 + oldSelector.length], newSelector),
+            ];
+
+            // make sure we don't mangle self-closing tags
+            if (endSourceSpan !== null && startSourceSpan.end.offset !== endSourceSpan.end.offset) {
+              const closeStart = endSourceSpan.start.offset as number;
+              const closeEnd = endSourceSpan.end.offset as number;
+
+              ops.push(fixer.replaceTextRange([closeStart + 2, closeEnd - 1], newSelector));
+            }
+
+            return ops;
+          },
+        });
+      },
+    };
+  },
+});
+
+export const tests = {
+  plugin: info.name,
+  valid: [
+    {
+      name: 'use no-prefix selectors in HTML templates',
+      code: `
+<ds-test-themeable/>
+<ds-test-themeable></ds-test-themeable>
+<ds-test-themeable [test]="something"></ds-test-themeable>
+        `,
+    },
+    {
+      name: 'use no-prefix selectors in TypeScript templates',
+      code: `
+@Component({
+  template: '<ds-test-themeable></ds-test-themeable>'
+})
+class Test {
+}
+        `,
+    },
+    {
+      name: 'use no-prefix selectors in TypeScript test templates',
+      filename: fixture('src/test.spec.ts'),
+      code: `
+@Component({
+  template: '<ds-test-themeable></ds-test-themeable>'
+})
+class Test {
+}
+        `,
+    },
+    {
+      name: 'base selectors are also allowed in TypeScript test templates',
+      filename: fixture('src/test.spec.ts'),
+      code: `
+@Component({
+  template: '<ds-base-test-themeable></ds-base-test-themeable>'
+})
+class Test {
+}
+        `,
+    },
+  ],
+  invalid: [
+    {
+      name: 'themed override selectors are not allowed in HTML templates',
+      code: `
+<ds-themed-test-themeable/>
+<ds-themed-test-themeable></ds-themed-test-themeable>
+<ds-themed-test-themeable [test]="something"></ds-themed-test-themeable>
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+      ],
+      output: `
+<ds-test-themeable/>
+<ds-test-themeable></ds-test-themeable>
+<ds-test-themeable [test]="something"></ds-test-themeable>
+        `,
+    },
+    {
+      name: 'base selectors are not allowed in HTML templates',
+      code: `
+<ds-base-test-themeable/>
+<ds-base-test-themeable></ds-base-test-themeable>
+<ds-base-test-themeable [test]="something"></ds-base-test-themeable>
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+      ],
+      output: `
+<ds-test-themeable/>
+<ds-test-themeable></ds-test-themeable>
+<ds-test-themeable [test]="something"></ds-test-themeable>
+        `,
+    },
+  ],
+} as NamedTests;
+
+export default rule;

lint/src/rules/ts/index.ts

@@ -0,0 +1,25 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+  bundle,
+  RuleExports,
+} from '../../util/structure';
+/* eslint-disable import/no-namespace */
+import * as themedComponentClasses from './themed-component-classes';
+import * as themedComponentSelectors from './themed-component-selectors';
+import * as themedComponentUsages from './themed-component-usages';
+
+const index = [
+  themedComponentClasses,
+  themedComponentSelectors,
+  themedComponentUsages,
+] as unknown as RuleExports[];
+
+export = {
+  ...bundle('dspace-angular-ts', 'TypeScript',  index),
+};

lint/src/rules/ts/themed-component-classes.ts

@@ -0,0 +1,382 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+  ESLintUtils,
+  TSESTree,
+} from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import {
+  getComponentImportNode,
+  getComponentInitializer,
+  getComponentStandaloneNode,
+} from '../../util/angular';
+import { appendObjectProperties } from '../../util/fix';
+import { DSpaceESLintRuleInfo } from '../../util/structure';
+import {
+  getBaseComponentClassName,
+  inThemedComponentOverrideFile,
+  isThemeableComponent,
+  isThemedComponentWrapper,
+} from '../../util/theme-support';
+import { getFilename } from '../../util/typescript';
+
+export enum Message {
+  NOT_STANDALONE = 'mustBeStandalone',
+  NOT_STANDALONE_IMPORTS_BASE = 'mustBeStandaloneAndImportBase',
+  WRAPPER_IMPORTS_BASE = 'wrapperShouldImportBase',
+}
+
+export const info = {
+  name: 'themed-component-classes',
+  meta: {
+    docs: {
+      description: `Formatting rules for themeable component classes
+
+- All themeable components must be standalone.
+- The base component must always be imported in the \`ThemedComponent\` wrapper. This ensures that it is always sufficient to import just the wrapper whenever we use the component.
+      `,
+    },
+    type: 'problem',
+    fixable: 'code',
+    schema: [],
+    messages: {
+      [Message.NOT_STANDALONE]: 'Themeable components must be standalone',
+      [Message.NOT_STANDALONE_IMPORTS_BASE]: 'Themeable component wrapper classes must be standalone and import the base class',
+      [Message.WRAPPER_IMPORTS_BASE]: 'Themed component wrapper classes must only import the base class',
+    },
+  },
+  defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+  ...info,
+  create(context: RuleContext<Message, unknown[]>) {
+    const filename = getFilename(context);
+
+    if (filename.endsWith('.spec.ts')) {
+      return {};
+    }
+
+    function enforceStandalone(decoratorNode: TSESTree.Decorator, withBaseImport = false) {
+      const standaloneNode = getComponentStandaloneNode(decoratorNode);
+
+      if (standaloneNode === undefined) {
+        // We may need to add these properties in one go
+        if (!withBaseImport) {
+          context.report({
+            messageId: Message.NOT_STANDALONE,
+            node: decoratorNode,
+            fix(fixer) {
+              const initializer = getComponentInitializer(decoratorNode);
+              return appendObjectProperties(context, fixer, initializer, ['standalone: true']);
+            },
+          });
+        }
+      } else if (!standaloneNode.value) {
+        context.report({
+          messageId: Message.NOT_STANDALONE,
+          node: standaloneNode,
+          fix(fixer) {
+            return fixer.replaceText(standaloneNode, 'true');
+          },
+        });
+      }
+
+      if (withBaseImport) {
+        const baseClass = getBaseComponentClassName(decoratorNode);
+
+        if (baseClass === undefined) {
+          return;
+        }
+
+        const importsNode = getComponentImportNode(decoratorNode);
+
+        if (importsNode === undefined) {
+          if (standaloneNode === undefined) {
+            context.report({
+              messageId: Message.NOT_STANDALONE_IMPORTS_BASE,
+              node: decoratorNode,
+              fix(fixer) {
+                const initializer = getComponentInitializer(decoratorNode);
+                return appendObjectProperties(context, fixer, initializer, ['standalone: true', `imports: [${baseClass}]`]);
+              },
+            });
+          } else {
+            context.report({
+              messageId: Message.WRAPPER_IMPORTS_BASE,
+              node: decoratorNode,
+              fix(fixer) {
+                const initializer = getComponentInitializer(decoratorNode);
+                return appendObjectProperties(context, fixer, initializer, [`imports: [${baseClass}]`]);
+              },
+            });
+          }
+        } else {
+          // If we have an imports node, standalone: true will be enforced by another rule
+
+          const imports = importsNode.elements.map(e => (e as TSESTree.Identifier).name);
+
+          if (!imports.includes(baseClass) || imports.length > 1) {
+            // The wrapper should _only_ import the base component
+            context.report({
+              messageId: Message.WRAPPER_IMPORTS_BASE,
+              node: importsNode,
+              fix(fixer) {
+                // todo: this may leave unused imports, but that's better than mangling things
+                return fixer.replaceText(importsNode, `[${baseClass}]`);
+              },
+            });
+          }
+        }
+      }
+    }
+
+    return {
+      'ClassDeclaration > Decorator[expression.callee.name = "Component"]'(node: TSESTree.Decorator) {
+        const classNode = node.parent as TSESTree.ClassDeclaration;
+        const className = classNode.id?.name;
+
+        if (className === undefined) {
+          return;
+        }
+
+        if (isThemedComponentWrapper(node)) {
+          enforceStandalone(node, true);
+        } else if (inThemedComponentOverrideFile(filename)) {
+          enforceStandalone(node);
+        } else if (isThemeableComponent(className)) {
+          enforceStandalone(node);
+        }
+      },
+    };
+  },
+});
+
+export const tests = {
+  plugin: info.name,
+  valid: [
+    {
+      name: 'Regular non-themeable component',
+      code: `
+@Component({
+  selector: 'ds-something',
+  standalone: true,
+})
+class Something {
+}
+      `,
+    },
+    {
+      name: 'Base component',
+      code: `
+@Component({
+  selector: 'ds-base-test-themable',
+  standalone: true,
+})
+class TestThemeableTomponent {
+}
+      `,
+    },
+    {
+      name: 'Wrapper component',
+      filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [
+    TestThemeableComponent,
+  ],
+})
+class ThemedTestThemeableTomponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+    },
+    {
+      name: 'Override component',
+      filename: fixture('src/themes/test/app/test/test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-themed-test-themable',
+  standalone: true,
+})
+class Override extends BaseComponent {
+}
+      `,
+    },
+  ],
+  invalid: [
+    {
+      name: 'Base component must be standalone',
+      code: `
+@Component({
+  selector: 'ds-base-test-themable',
+})
+class TestThemeableComponent {
+}
+      `,
+      errors:[
+        {
+          messageId: Message.NOT_STANDALONE,
+        },
+      ],
+      output: `
+@Component({
+  selector: 'ds-base-test-themable',
+  standalone: true,
+})
+class TestThemeableComponent {
+}
+      `,
+    },
+    {
+      name: 'Wrapper component must be standalone and import base component',
+      filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-test-themable',
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+      errors:[
+        {
+          messageId: Message.NOT_STANDALONE_IMPORTS_BASE,
+        },
+      ],
+      output: `
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+    },
+
+    {
+      name: 'Wrapper component must import base component (array present but empty)',
+      filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+      errors:[
+        {
+          messageId: Message.WRAPPER_IMPORTS_BASE,
+        },
+      ],
+      output: `
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+    },
+    {
+      name: 'Wrapper component must import base component (array is wrong)',
+      filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+      code: `
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [
+    SomethingElse,
+  ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+      errors:[
+        {
+          messageId: Message.WRAPPER_IMPORTS_BASE,
+        },
+      ],
+      output: `
+import { SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+    },    {
+      name: 'Wrapper component must import base component (array is wrong)',
+      filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+      code: `
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [
+    SomethingElse,
+  ],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+      errors:[
+        {
+          messageId: Message.WRAPPER_IMPORTS_BASE,
+        },
+      ],
+      output: `
+import { Something, SomethingElse } from './somewhere-else';
+
+@Component({
+  selector: 'ds-test-themable',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+      `,
+    },
+    {
+      name: 'Override component must be standalone',
+      filename: fixture('src/themes/test/app/test/test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-themed-test-themable',
+})
+class Override extends BaseComponent {
+}
+      `,
+      errors:[
+        {
+          messageId: Message.NOT_STANDALONE,
+        },
+      ],
+      output: `
+@Component({
+  selector: 'ds-themed-test-themable',
+  standalone: true,
+})
+class Override extends BaseComponent {
+}
+      `,
+    },
+  ],
+};

lint/src/rules/ts/themed-component-selectors.ts

@@ -0,0 +1,257 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+  ESLintUtils,
+  TSESTree,
+} from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import { getComponentSelectorNode } from '../../util/angular';
+import { stringLiteral } from '../../util/misc';
+import { DSpaceESLintRuleInfo } from '../../util/structure';
+import {
+  inThemedComponentOverrideFile,
+  isThemeableComponent,
+  isThemedComponentWrapper,
+} from '../../util/theme-support';
+import { getFilename } from '../../util/typescript';
+
+export enum Message {
+  BASE = 'wrongSelectorUnthemedComponent',
+  WRAPPER = 'wrongSelectorThemedComponentWrapper',
+  THEMED = 'wrongSelectorThemedComponentOverride',
+}
+
+export const info = {
+  name: 'themed-component-selectors',
+  meta: {
+    docs: {
+      description: `Themeable component selectors should follow the DSpace convention
+
+Each themeable component is comprised of a base component, a wrapper component and any number of themed components
+- Base components should have a selector starting with \`ds-base-\`
+- Themed components should have a selector starting with \`ds-themed-\`
+- Wrapper components should have a selector starting with \`ds-\`, but not \`ds-base-\` or \`ds-themed-\`
+  - This is the regular DSpace selector prefix
+  - **When making a regular component themeable, its selector prefix should be changed to \`ds-base-\`, and the new wrapper's component should reuse the previous selector**
+
+Unit tests are exempt from this rule, because they may redefine components using the same class name as other themeable components elsewhere in the source.
+      `,
+    },
+    type: 'problem',
+    schema: [],
+    fixable: 'code',
+    messages: {
+      [Message.BASE]: 'Unthemed version of themeable component should have a selector starting with \'ds-base-\'',
+      [Message.WRAPPER]: 'Themed component wrapper of themeable component shouldn\'t have a selector starting with \'ds-themed-\'',
+      [Message.THEMED]: 'Theme override of themeable component should have a selector starting with \'ds-themed-\'',
+    },
+  },
+  defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+  ...info,
+  create(context: RuleContext<Message, unknown[]>) {
+    const filename = getFilename(context);
+
+    if (filename.endsWith('.spec.ts')) {
+      return {};
+    }
+
+    function enforceWrapperSelector(selectorNode: TSESTree.StringLiteral) {
+      if (selectorNode?.value.startsWith('ds-themed-')) {
+        context.report({
+          messageId: Message.WRAPPER,
+          node: selectorNode,
+          fix(fixer) {
+            return fixer.replaceText(selectorNode, stringLiteral(selectorNode.value.replace('ds-themed-', 'ds-')));
+          },
+        });
+      }
+    }
+
+    function enforceBaseSelector(selectorNode: TSESTree.StringLiteral) {
+      if (!selectorNode?.value.startsWith('ds-base-')) {
+        context.report({
+          messageId: Message.BASE,
+          node: selectorNode,
+          fix(fixer) {
+            return fixer.replaceText(selectorNode, stringLiteral(selectorNode.value.replace('ds-', 'ds-base-')));
+          },
+        });
+      }
+    }
+
+    function enforceThemedSelector(selectorNode: TSESTree.StringLiteral) {
+      if (!selectorNode?.value.startsWith('ds-themed-')) {
+        context.report({
+          messageId: Message.THEMED,
+          node: selectorNode,
+          fix(fixer) {
+            return fixer.replaceText(selectorNode, stringLiteral(selectorNode.value.replace('ds-', 'ds-themed-')));
+          },
+        });
+      }
+    }
+
+    return {
+      'ClassDeclaration > Decorator[expression.callee.name = "Component"]'(node: TSESTree.Decorator) {
+        const selectorNode = getComponentSelectorNode(node);
+
+        if (selectorNode === undefined) {
+          return;
+        }
+
+        const selector = selectorNode?.value;
+        const classNode = node.parent as TSESTree.ClassDeclaration;
+        const className = classNode.id?.name;
+
+        if (selector === undefined || className === undefined) {
+          return;
+        }
+
+        if (isThemedComponentWrapper(node)) {
+          enforceWrapperSelector(selectorNode);
+        } else if (inThemedComponentOverrideFile(filename)) {
+          enforceThemedSelector(selectorNode);
+        } else if (isThemeableComponent(className)) {
+          enforceBaseSelector(selectorNode);
+        }
+      },
+    };
+  },
+});
+
+export const tests = {
+  plugin: info.name,
+  valid: [
+    {
+      name: 'Regular non-themeable component selector',
+      code: `
+@Component({
+  selector: 'ds-something',
+})
+class Something {
+}
+      `,
+    },
+    {
+      name: 'Themeable component selector should replace the original version, unthemed version should be changed to ds-base-',
+      code: `
+@Component({
+  selector: 'ds-base-something',
+})
+class Something {
+}
+
+@Component({
+  selector: 'ds-something',
+})
+class ThemedSomething extends ThemedComponent<Something> {
+}
+
+@Component({
+  selector: 'ds-themed-something',
+})
+class OverrideSomething extends Something {
+}
+      `,
+    },
+    {
+      name: 'Other themed component wrappers should not interfere',
+      code: `
+@Component({
+  selector: 'ds-something',
+})
+class Something {
+}
+
+@Component({
+  selector: 'ds-something-else',
+})
+class ThemedSomethingElse extends ThemedComponent<SomethingElse> {
+}
+      `,
+    },
+  ],
+  invalid: [
+    {
+      name: 'Wrong selector for base component',
+      filename: fixture('src/app/test/test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-something',
+})
+class TestThemeableComponent {
+}
+        `,
+      errors: [
+        {
+          messageId: Message.BASE,
+        },
+      ],
+      output: `
+@Component({
+  selector: 'ds-base-something',
+})
+class TestThemeableComponent {
+}
+        `,
+    },
+    {
+      name: 'Wrong selector for wrapper component',
+      filename: fixture('src/app/test/themed-test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-themed-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+        `,
+      errors: [
+        {
+          messageId: Message.WRAPPER,
+        },
+      ],
+      output: `
+@Component({
+  selector: 'ds-something',
+})
+class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+}
+        `,
+    },
+    {
+      name: 'Wrong selector for theme override',
+      filename: fixture('src/themes/test/app/test/test-themeable.component.ts'),
+      code: `
+@Component({
+  selector: 'ds-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+        `,
+      errors: [
+        {
+          messageId: Message.THEMED,
+        },
+      ],
+      output: `
+@Component({
+  selector: 'ds-themed-something',
+})
+class TestThememeableComponent extends BaseComponent {
+}
+        `,
+    },
+  ],
+};
+
+export default rule;

lint/src/rules/ts/themed-component-usages.ts

@@ -0,0 +1,502 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+  ESLintUtils,
+  TSESTree,
+} from '@typescript-eslint/utils';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+
+import { fixture } from '../../../test/fixture';
+import {
+  removeWithCommas,
+  replaceOrRemoveArrayIdentifier,
+} from '../../util/fix';
+import { DSpaceESLintRuleInfo } from '../../util/structure';
+import {
+  allThemeableComponents,
+  DISALLOWED_THEME_SELECTORS,
+  fixSelectors,
+  getThemeableComponentByBaseClass,
+  isAllowedUnthemedUsage,
+} from '../../util/theme-support';
+import {
+  findImportSpecifier,
+  findUsages,
+  findUsagesByName,
+  getFilename,
+  relativePath,
+} from '../../util/typescript';
+
+export enum Message {
+  WRONG_CLASS = 'mustUseThemedWrapperClass',
+  WRONG_IMPORT = 'mustImportThemedWrapper',
+  WRONG_SELECTOR = 'mustUseThemedWrapperSelector',
+  BASE_IN_MODULE = 'baseComponentNotNeededInModule',
+}
+
+export const info = {
+  name: 'themed-component-usages',
+  meta: {
+    docs: {
+      description: `Themeable components should be used via their \`ThemedComponent\` wrapper class
+
+This ensures that custom themes can correctly override _all_ instances of this component.
+There are a few exceptions where the base class can still be used:
+- Class declaration expressions (otherwise we can't declare, extend or override the class in the first place)
+- Angular modules (except for routing modules)
+- Angular \`@ViewChild\` decorators
+- Type annotations
+      `,
+    },
+    type: 'problem',
+    schema: [],
+    fixable: 'code',
+    messages: {
+      [Message.WRONG_CLASS]: 'Themeable components should be used via their ThemedComponent wrapper',
+      [Message.WRONG_IMPORT]: 'Themeable components should be used via their ThemedComponent wrapper',
+      [Message.WRONG_SELECTOR]: 'Themeable components should be used via their ThemedComponent wrapper',
+      [Message.BASE_IN_MODULE]: 'Base themeable components shouldn\'t be declared in modules',
+    },
+  },
+  defaultOptions: [],
+} as DSpaceESLintRuleInfo;
+
+export const rule = ESLintUtils.RuleCreator.withoutDocs({
+  ...info,
+  create(context: RuleContext<Message, unknown[]>) {
+    const filename = getFilename(context);
+
+    function handleUnthemedUsagesInTypescript(node: TSESTree.Identifier) {
+      if (isAllowedUnthemedUsage(node)) {
+        return;
+      }
+
+      const entry = getThemeableComponentByBaseClass(node.name);
+
+      if (entry === undefined) {
+        // this should never happen
+        throw new Error(`No such themeable component in registry: '${node.name}'`);
+      }
+
+      context.report({
+        messageId: Message.WRONG_CLASS,
+        node: node,
+        fix(fixer) {
+          if (node.parent.type === TSESTree.AST_NODE_TYPES.ArrayExpression) {
+            return replaceOrRemoveArrayIdentifier(context, fixer, node, entry.wrapperClass);
+          } else {
+            return fixer.replaceText(node, entry.wrapperClass);
+          }
+        },
+      });
+    }
+
+    function handleThemedSelectorQueriesInTests(node: TSESTree.Literal) {
+      context.report({
+        node,
+        messageId: Message.WRONG_SELECTOR,
+        fix(fixer){
+          const newSelector = fixSelectors(node.raw);
+          return fixer.replaceText(node, newSelector);
+        },
+      });
+    }
+
+    function handleUnthemedImportsInTypescript(specifierNode: TSESTree.ImportSpecifier) {
+      const allUsages = findUsages(context, specifierNode.local);
+      const badUsages = allUsages.filter(usage => !isAllowedUnthemedUsage(usage));
+
+      if (badUsages.length === 0) {
+        return;
+      }
+
+      const importedNode = specifierNode.imported;
+      const declarationNode = specifierNode.parent as TSESTree.ImportDeclaration;
+
+      const entry = getThemeableComponentByBaseClass(importedNode.name);
+      if (entry === undefined) {
+        // this should never happen
+        throw new Error(`No such themeable component in registry: '${importedNode.name}'`);
+      }
+
+      context.report({
+        messageId: Message.WRONG_IMPORT,
+        node: importedNode,
+        fix(fixer) {
+          const ops = [];
+
+          const wrapperImport = findImportSpecifier(context, entry.wrapperClass);
+
+          if (findUsagesByName(context, entry.wrapperClass).length === 0) {
+            // Wrapper is not present in this file, safe to add import
+
+            const newImportLine = `import { ${entry.wrapperClass} } from '${relativePath(filename, entry.wrapperPath)}';`;
+
+            if (declarationNode.specifiers.length === 1) {
+              if (allUsages.length === badUsages.length) {
+                ops.push(fixer.replaceText(declarationNode, newImportLine));
+              } else if (wrapperImport === undefined) {
+                ops.push(fixer.insertTextAfter(declarationNode, '\n' + newImportLine));
+              }
+            } else {
+              ops.push(...removeWithCommas(context, fixer, specifierNode));
+              if (wrapperImport === undefined) {
+                ops.push(fixer.insertTextAfter(declarationNode, '\n' + newImportLine));
+              }
+            }
+          } else {
+            // Wrapper already present in the file, remove import instead
+
+            if (allUsages.length === badUsages.length) {
+              if (declarationNode.specifiers.length === 1) {
+                // Make sure we remove the newline as well
+                ops.push(fixer.removeRange([declarationNode.range[0], declarationNode.range[1] + 1]));
+              } else {
+                ops.push(...removeWithCommas(context, fixer, specifierNode));
+              }
+            }
+          }
+
+          return ops;
+        },
+      });
+    }
+
+    // ignore tests and non-routing modules
+    if (filename.endsWith('.spec.ts')) {
+      return {
+        [`CallExpression[callee.object.name = "By"][callee.property.name = "css"] > Literal:first-child[value = /.*${DISALLOWED_THEME_SELECTORS}.*/]`]: handleThemedSelectorQueriesInTests,
+      };
+    } else if (filename.endsWith('.cy.ts')) {
+      return {
+        [`CallExpression[callee.object.name = "cy"][callee.property.name = "get"] > Literal:first-child[value = /.*${DISALLOWED_THEME_SELECTORS}.*/]`]: handleThemedSelectorQueriesInTests,
+      };
+    } else if (
+      filename.match(/(?!src\/themes\/).*(?!routing).module.ts$/)
+      || filename.match(/themed-.+\.component\.ts$/)
+    ) {
+      // do nothing
+      return {};
+    } else {
+      return allThemeableComponents().reduce(
+        (rules, entry) => {
+          return {
+            ...rules,
+            [`:not(:matches(ClassDeclaration, ImportSpecifier)) > Identifier[name = "${entry.baseClass}"]`]: handleUnthemedUsagesInTypescript,
+            [`ImportSpecifier[imported.name = "${entry.baseClass}"]`]: handleUnthemedImportsInTypescript,
+          };
+        }, {},
+      );
+    }
+
+  },
+});
+
+export const tests = {
+  plugin: info.name,
+  valid: [
+    {
+      name: 'allow wrapper class usages',
+      code: `
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+
+const config = {
+  a: ThemedTestThemeableComponent,
+  b: ChipsComponent,
+}
+        `,
+    },
+    {
+      name: 'allow base class in class declaration',
+      code: `
+export class TestThemeableComponent {
+}
+        `,
+    },
+    {
+      name: 'allow inheriting from base class',
+      code: `
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class ThemedAdminSidebarComponent extends ThemedComponent<TestThemeableComponent> {
+}
+        `,
+    },
+    {
+      name: 'allow base class in ViewChild',
+      code: `
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+
+export class Something {
+  @ViewChild(TestThemeableComponent) test: TestThemeableComponent;
+}
+        `,
+    },
+    {
+      name: 'allow wrapper selectors in test queries',
+      filename: fixture('src/app/test/test.component.spec.ts'),
+      code: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+        `,
+    },
+    {
+      name: 'allow wrapper selectors in cypress queries',
+      filename: fixture('src/app/test/test.component.cy.ts'),
+      code: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+        `,
+    },
+  ],
+  invalid: [
+    {
+      name: 'disallow direct usages of base class',
+      code: `
+import { TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: TestThemeableComponent,
+  b: TestComponent,
+}
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_IMPORT,
+        },
+        {
+          messageId: Message.WRONG_CLASS,
+        },
+      ],
+      output: `
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: ThemedTestThemeableComponent,
+  b: TestComponent,
+}
+        `,
+    },
+    {
+      name: 'disallow direct usages of base class, keep other imports',
+      code: `
+import { Something, TestThemeableComponent } from './app/test/test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: TestThemeableComponent,
+  b: TestComponent,
+  c: Something,
+}
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_IMPORT,
+        },
+        {
+          messageId: Message.WRONG_CLASS,
+        },
+      ],
+      output: `
+import { Something } from './app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from './app/test/themed-test-themeable.component';
+import { TestComponent } from './app/test/test.component';
+
+const config = {
+  a: ThemedTestThemeableComponent,
+  b: TestComponent,
+  c: Something,
+}
+        `,
+    },
+    {
+      name: 'handle array replacements correctly',
+      code: `
+const DECLARATIONS = [
+  Something,
+  TestThemeableComponent,
+  Something,
+  ThemedTestThemeableComponent,
+];
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_CLASS,
+        },
+      ],
+      output: `
+const DECLARATIONS = [
+  Something,
+  Something,
+  ThemedTestThemeableComponent,
+];
+        `,
+    },
+    {
+      name: 'disallow override selector in test queries',
+      filename: fixture('src/app/test/test.component.spec.ts'),
+      code: `
+By.css('ds-themed-themeable');
+By.css('#test > ds-themed-themeable > #nest');
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+      ],
+      output: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+        `,
+    },
+    {
+      name: 'disallow base selector in test queries',
+      filename: fixture('src/app/test/test.component.spec.ts'),
+      code: `
+By.css('ds-base-themeable');
+By.css('#test > ds-base-themeable > #nest');
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+      ],
+      output: `
+By.css('ds-themeable');
+By.css('#test > ds-themeable > #nest');
+        `,
+    },
+    {
+      name: 'disallow override selector in cypress queries',
+      filename: fixture('src/app/test/test.component.cy.ts'),
+      code: `
+cy.get('ds-themed-themeable');
+cy.get('#test > ds-themed-themeable > #nest');
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+      ],
+      output: `
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+        `,
+    },
+    {
+      name: 'disallow base selector in cypress queries',
+      filename: fixture('src/app/test/test.component.cy.ts'),
+      code: `
+cy.get('ds-base-themeable');
+cy.get('#test > ds-base-themeable > #nest');
+        `,
+      errors: [
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+        {
+          messageId: Message.WRONG_SELECTOR,
+        },
+      ],
+      output: `
+cy.get('ds-themeable');
+cy.get('#test > ds-themeable > #nest');
+        `,
+    },
+    {
+      name: 'edge case: unable to find usage node through usage token, but import is still flagged and fixed',
+      filename: fixture('src/themes/test/app/test/other-themeable.component.ts'),
+      code: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+export class UsageComponent {
+}
+      `,
+      errors: [
+        {
+          messageId: Message.WRONG_IMPORT,
+        },
+        {
+          messageId: Message.WRONG_CLASS,
+        },
+      ],
+      output: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+      `,
+    },
+    {
+      name: 'edge case edge case: both are imported, only wrapper is retained',
+      filename: fixture('src/themes/test/app/test/other-themeable.component.ts'),
+      code: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { TestThemeableComponent } from '../../../../app/test/test-themeable.component';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [TestThemeableComponent, ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+      `,
+      errors: [
+        {
+          messageId: Message.WRONG_IMPORT,
+        },
+        {
+          messageId: Message.WRONG_CLASS,
+        },
+      ],
+      output: `
+import { Component } from '@angular/core';
+
+import { Context } from './app/core/shared/context.model';
+import { ThemedTestThemeableComponent } from '../../../../app/test/themed-test-themeable.component';
+
+@Component({
+  standalone: true,
+  imports: [ThemedTestThemeableComponent],
+})
+export class UsageComponent {
+}
+      `,
+    },
+  ],
+};
+
+export default rule;

lint/src/util/angular.ts

@@ -0,0 +1,83 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TSESTree } from '@typescript-eslint/utils';
+
+import { getObjectPropertyNodeByName } from './typescript';
+
+export function getComponentSelectorNode(componentDecoratorNode: TSESTree.Decorator): TSESTree.StringLiteral | undefined {
+  const property = getComponentInitializerNodeByName(componentDecoratorNode, 'selector');
+
+  if (property !== undefined) {
+    // todo: support template literals as well
+    if (property.type === TSESTree.AST_NODE_TYPES.Literal && typeof property.value === 'string') {
+      return property as TSESTree.StringLiteral;
+    }
+  }
+
+  return undefined;
+}
+
+export function getComponentStandaloneNode(componentDecoratorNode: TSESTree.Decorator): TSESTree.BooleanLiteral | undefined {
+  const property = getComponentInitializerNodeByName(componentDecoratorNode, 'standalone');
+
+  if (property !== undefined) {
+    if (property.type === TSESTree.AST_NODE_TYPES.Literal && typeof property.value === 'boolean') {
+      return property as TSESTree.BooleanLiteral;
+    }
+  }
+
+  return undefined;
+}
+export function getComponentImportNode(componentDecoratorNode: TSESTree.Decorator): TSESTree.ArrayExpression | undefined {
+  const property = getComponentInitializerNodeByName(componentDecoratorNode, 'imports');
+
+  if (property !== undefined) {
+    if (property.type === TSESTree.AST_NODE_TYPES.ArrayExpression) {
+      return property as TSESTree.ArrayExpression;
+    }
+  }
+
+  return undefined;
+}
+
+export function getComponentClassName(decoratorNode: TSESTree.Decorator): string | undefined {
+  if (decoratorNode.parent.type !== TSESTree.AST_NODE_TYPES.ClassDeclaration) {
+    return undefined;
+  }
+
+  if (decoratorNode.parent.id?.type !== TSESTree.AST_NODE_TYPES.Identifier) {
+    return undefined;
+  }
+
+  return decoratorNode.parent.id.name;
+}
+
+export function getComponentSuperClassName(decoratorNode: TSESTree.Decorator): string | undefined {
+  if (decoratorNode.parent.type !== TSESTree.AST_NODE_TYPES.ClassDeclaration) {
+    return undefined;
+  }
+
+  if (decoratorNode.parent.superClass?.type !== TSESTree.AST_NODE_TYPES.Identifier) {
+    return undefined;
+  }
+
+  return decoratorNode.parent.superClass.name;
+}
+
+export function getComponentInitializer(componentDecoratorNode: TSESTree.Decorator): TSESTree.ObjectExpression {
+  return (componentDecoratorNode.expression as TSESTree.CallExpression).arguments[0] as TSESTree.ObjectExpression;
+}
+
+export function getComponentInitializerNodeByName(componentDecoratorNode: TSESTree.Decorator, name: string): TSESTree.Node | undefined {
+  const initializer = getComponentInitializer(componentDecoratorNode);
+  return getObjectPropertyNodeByName(initializer, name);
+}
+
+export function isPartOfViewChild(node: TSESTree.Identifier): boolean {
+  return (node.parent as any)?.callee?.name === 'ViewChild';
+}

lint/src/util/fix.ts

@@ -0,0 +1,125 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TSESTree } from '@typescript-eslint/utils';
+import {
+  RuleContext,
+  RuleFix,
+  RuleFixer,
+} from '@typescript-eslint/utils/ts-eslint';
+
+import { getSourceCode } from './typescript';
+
+
+
+export function appendObjectProperties(context: RuleContext<any, any>, fixer: RuleFixer, objectNode: TSESTree.ObjectExpression, properties: string[]): RuleFix {
+  // todo: may not handle empty objects too well
+  const lastProperty = objectNode.properties[objectNode.properties.length - 1];
+  const source = getSourceCode(context);
+  const nextToken = source.getTokenAfter(lastProperty);
+
+  // todo: newline & indentation are hardcoded for @Component({})
+  // todo: we're assuming that we need trailing commas, what if we don't?
+  const newPart = '\n' + properties.map(p => `  ${p},`).join('\n');
+
+  if (nextToken !== null && nextToken.value === ',') {
+    return fixer.insertTextAfter(nextToken, newPart);
+  } else {
+    return fixer.insertTextAfter(lastProperty, ',' + newPart);
+  }
+}
+
+export function appendArrayElement(context: RuleContext<any, any>, fixer: RuleFixer, arrayNode: TSESTree.ArrayExpression, value: string): RuleFix {
+  const source = getSourceCode(context);
+
+  if (arrayNode.elements.length === 0) {
+    // This is the first element
+    const openArray = source.getTokenByRangeStart(arrayNode.range[0]);
+
+    if (openArray == null) {
+      throw new Error('Unexpected null token for opening square bracket');
+    }
+
+    // safe to assume the list is single-line
+    return fixer.insertTextAfter(openArray, `${value}`);
+  } else {
+    const lastElement = arrayNode.elements[arrayNode.elements.length - 1];
+
+    if (lastElement == null) {
+      throw new Error('Unexpected null node in array');
+    }
+
+    const nextToken = source.getTokenAfter(lastElement);
+
+    // todo: we don't know if the list is chopped or not, so we can't make any assumptions -- may produce output that will be flagged by other rules on the next run!
+    // todo: we're assuming that we need trailing commas, what if we don't?
+    if (nextToken !== null && nextToken.value === ',') {
+      return fixer.insertTextAfter(nextToken, ` ${value},`);
+    } else {
+      return fixer.insertTextAfter(lastElement, `, ${value},`);
+    }
+  }
+
+}
+
+export function isLast(elementNode: TSESTree.Node): boolean {
+  if (!elementNode.parent) {
+    return false;
+  }
+
+  let siblingNodes: (TSESTree.Node | null)[] = [null];
+  if (elementNode.parent.type === TSESTree.AST_NODE_TYPES.ArrayExpression) {
+    siblingNodes = elementNode.parent.elements;
+  } else if (elementNode.parent.type === TSESTree.AST_NODE_TYPES.ImportDeclaration) {
+    siblingNodes = elementNode.parent.specifiers;
+  }
+
+  return elementNode === siblingNodes[siblingNodes.length - 1];
+}
+
+export function removeWithCommas(context: RuleContext<any, any>, fixer: RuleFixer, elementNode: TSESTree.Node): RuleFix[] {
+  const ops = [];
+
+  const source = getSourceCode(context);
+  let nextToken = source.getTokenAfter(elementNode);
+  let prevToken = source.getTokenBefore(elementNode);
+
+  if (nextToken !== null && prevToken !== null) {
+    if (nextToken.value === ',') {
+      nextToken = source.getTokenAfter(nextToken);
+      if (nextToken !== null) {
+        ops.push(fixer.removeRange([elementNode.range[0], nextToken.range[0]]));
+      }
+    }
+    if (isLast(elementNode) && prevToken.value === ',') {
+      prevToken = source.getTokenBefore(prevToken);
+      if (prevToken !== null) {
+        ops.push(fixer.removeRange([prevToken.range[1], elementNode.range[1]]));
+      }
+    }
+  } else if (nextToken !== null) {
+    ops.push(fixer.removeRange([elementNode.range[0], nextToken.range[0]]));
+  }
+
+  return ops;
+}
+
+export function replaceOrRemoveArrayIdentifier(context: RuleContext<any, any>, fixer: RuleFixer, identifierNode: TSESTree.Identifier, newValue: string): RuleFix[] {
+  if (identifierNode.parent.type !== TSESTree.AST_NODE_TYPES.ArrayExpression) {
+    throw new Error('Parent node is not an array expression!');
+  }
+
+  const array = identifierNode.parent as TSESTree.ArrayExpression;
+
+  for (const element of array.elements) {
+    if (element !== null && element.type === TSESTree.AST_NODE_TYPES.Identifier && element.name === newValue) {
+      return removeWithCommas(context, fixer, identifierNode);
+    }
+  }
+
+  return [fixer.replaceText(identifierNode, newValue)];
+}

lint/src/util/misc.ts

@@ -0,0 +1,28 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+export function match(rangeA: number[], rangeB: number[]) {
+  return rangeA[0] === rangeB[0] && rangeA[1] === rangeB[1];
+}
+
+
+export function stringLiteral(value: string): string {
+  return `'${value}'`;
+}
+
+/**
+ * Transform Windows-style paths into Unix-style paths
+ */
+export function toUnixStylePath(path: string): string {
+  // note: we're assuming that none of the directory/file names contain '\' or '/' characters.
+  //       using these characters in paths is very bad practice in general, so this should be a safe assumption.
+  if (path.includes('\\')) {
+    return path.replace(/^[A-Z]:\\/, '/').replaceAll('\\', '/');
+  }
+  return path;
+}

lint/src/util/structure.ts

@@ -0,0 +1,61 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import {
+  InvalidTestCase,
+  RuleMetaData,
+  RuleModule,
+  ValidTestCase,
+} from '@typescript-eslint/utils/ts-eslint';
+import { EnumType } from 'typescript';
+
+export type Meta = RuleMetaData<string, unknown[]>;
+export type Valid = ValidTestCase<unknown[]>;
+export type Invalid = InvalidTestCase<string, unknown[]>;
+
+export interface DSpaceESLintRuleInfo {
+  name: string;
+  meta: Meta,
+  defaultOptions: unknown[],
+}
+
+export interface NamedTests {
+  plugin: string;
+  valid: Valid[];
+  invalid: Invalid[];
+}
+
+export interface RuleExports {
+  Message: EnumType,
+  info: DSpaceESLintRuleInfo,
+  rule: RuleModule<string>,
+  tests: NamedTests,
+  default: unknown,
+}
+
+export interface PluginExports {
+  name: string,
+  language: string,
+  rules: Record<string, unknown>,
+  index: RuleExports[],
+}
+
+export function bundle(
+  name: string,
+  language: string,
+  index: RuleExports[],
+): PluginExports {
+  return index.reduce((o: PluginExports, i: RuleExports) => {
+    o.rules[i.info.name] = i.rule;
+    return o;
+  }, {
+    name,
+    language,
+    rules: {},
+    index,
+  });
+}

lint/src/util/templates/index.ejs

@@ -0,0 +1,5 @@
+[DSpace ESLint plugins](../../../lint/README.md) > <%= plugin.language %> rules
+_______
+<% rules.forEach(rule => { %>
+- [`<%= plugin.name %>/<%= rule.name %>`](./rules/<%= rule.name %>.md)<% if (rule.meta?.docs?.description) {%>: <%= rule.meta.docs.description.split('\n')[0].trim() -%><% }-%>
+<% }) %>

lint/src/util/templates/rule.ejs

@@ -0,0 +1,48 @@
+[DSpace ESLint plugins](../../../../lint/README.md) > [<%= plugin.language %> rules](../index.md) > `<%= plugin.name %>/<%= rule.name %>`
+_______
+
+<%- rule.meta.docs?.description %>
+
+_______
+
+[Source code](../../../../lint/src/rules/<%- plugin.name.replace('dspace-angular-', '') %>/<%- rule.name %>.ts)
+
+### Examples
+
+<% if (tests.valid) {%>
+#### Valid code
+    <% tests.valid.forEach(test => { %>
+##### <%= test.name !== undefined ? test.name : 'UNNAMED' %>
+        <% if (test.filename) { %>
+Filename: `<%- test.filename %>`
+        <% } %>
+```<%- plugin.language.toLowerCase() %>
+<%- test.code.trim() %>
+```
+    <% }) %>
+<% } %>
+
+<% if (tests.invalid) {%>
+#### Invalid code <%= rule.meta.fixable ? ' & automatic fixes' : '' %>
+    <% tests.invalid.forEach(test => { %>
+##### <%= test.name !== undefined ? test.name : 'UNNAMED' %>
+        <% if (test.filename) { %>
+Filename: `<%- test.filename %>`
+        <% } %>
+```<%- plugin.language.toLowerCase() %>
+<%- test.code.trim() %>
+```
+Will produce the following error(s):
+```
+<% for (const error of test.errors) { -%>
+<%- rule.meta.messages[error.messageId] %>
+<% } -%>
+```
+        <% if (test.output) { %>
+Result of `yarn lint --fix`:
+```<%- plugin.language.toLowerCase() %>
+<%- test.output.trim() %>
+```
+        <% } %>
+    <% }) %>
+<% } %>

lint/src/util/theme-support.ts

@@ -0,0 +1,265 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+import { TSESTree } from '@typescript-eslint/utils';
+import { readFileSync } from 'fs';
+import { basename } from 'path';
+import ts, { Identifier } from 'typescript';
+
+import {
+  getComponentClassName,
+  isPartOfViewChild,
+} from './angular';
+import {
+  isPartOfClassDeclaration,
+  isPartOfTypeExpression,
+} from './typescript';
+
+/**
+ * Couples a themeable Component to its ThemedComponent wrapper
+ */
+export interface ThemeableComponentRegistryEntry {
+  basePath: string;
+  baseFileName: string,
+  baseClass: string;
+
+  wrapperPath: string;
+  wrapperFileName: string,
+  wrapperClass: string;
+}
+
+function isAngularComponentDecorator(node: ts.Node) {
+  if (node.kind === ts.SyntaxKind.Decorator && node.parent.kind === ts.SyntaxKind.ClassDeclaration) {
+    const decorator = node as ts.Decorator;
+
+    if (decorator.expression.kind === ts.SyntaxKind.CallExpression) {
+      const method = decorator.expression as ts.CallExpression;
+
+      if (method.expression.kind === ts.SyntaxKind.Identifier) {
+        return (method.expression as Identifier).text === 'Component';
+      }
+    }
+  }
+
+  return false;
+}
+
+function findImportDeclaration(source: ts.SourceFile, identifierName: string): ts.ImportDeclaration | undefined {
+  return ts.forEachChild(source, (topNode: ts.Node) => {
+    if (topNode.kind === ts.SyntaxKind.ImportDeclaration) {
+      const importDeclaration = topNode as ts.ImportDeclaration;
+
+      if (importDeclaration.importClause?.namedBindings?.kind === ts.SyntaxKind.NamedImports) {
+        const namedImports = importDeclaration.importClause?.namedBindings as ts.NamedImports;
+
+        for (const element of namedImports.elements) {
+          if (element.name.text === identifierName) {
+            return importDeclaration;
+          }
+        }
+      }
+    }
+
+    return undefined;
+  });
+}
+
+/**
+ * Listing of all themeable Components
+ */
+class ThemeableComponentRegistry {
+  public readonly entries: Set<ThemeableComponentRegistryEntry>;
+  public readonly byBaseClass: Map<string, ThemeableComponentRegistryEntry>;
+  public readonly byWrapperClass: Map<string, ThemeableComponentRegistryEntry>;
+  public readonly byBasePath: Map<string, ThemeableComponentRegistryEntry>;
+  public readonly byWrapperPath: Map<string, ThemeableComponentRegistryEntry>;
+
+  constructor() {
+    this.entries = new Set();
+    this.byBaseClass = new Map();
+    this.byWrapperClass = new Map();
+    this.byBasePath = new Map();
+    this.byWrapperPath = new Map();
+  }
+
+  public initialize(prefix = '') {
+    if (this.entries.size > 0) {
+      return;
+    }
+
+    function registerWrapper(path: string) {
+      const source = getSource(path);
+
+      function traverse(node: ts.Node) {
+        if (node.parent !== undefined && isAngularComponentDecorator(node)) {
+          const classNode = node.parent as ts.ClassDeclaration;
+
+          if (classNode.name === undefined || classNode.heritageClauses === undefined) {
+            return;
+          }
+
+          const wrapperClass = classNode.name?.escapedText as string;
+
+          for (const heritageClause of classNode.heritageClauses) {
+            for (const type of heritageClause.types) {
+              if ((type as any).expression.escapedText === 'ThemedComponent') {
+                if (type.kind !== ts.SyntaxKind.ExpressionWithTypeArguments || type.typeArguments === undefined) {
+                  continue;
+                }
+
+                const firstTypeArg = type.typeArguments[0] as ts.TypeReferenceNode;
+                const baseClass = (firstTypeArg.typeName as ts.Identifier)?.escapedText;
+
+                if (baseClass === undefined) {
+                  continue;
+                }
+
+                const importDeclaration = findImportDeclaration(source, baseClass);
+
+                if (importDeclaration === undefined) {
+                  continue;
+                }
+
+                const basePath = resolveLocalPath((importDeclaration.moduleSpecifier as ts.StringLiteral).text, path);
+
+                themeableComponents.add({
+                  baseClass,
+                  basePath: basePath.replace(new RegExp(`^${prefix}`), ''),
+                  baseFileName: basename(basePath).replace(/\.ts$/, ''),
+                  wrapperClass,
+                  wrapperPath: path.replace(new RegExp(`^${prefix}`), ''),
+                  wrapperFileName: basename(path).replace(/\.ts$/, ''),
+                });
+              }
+            }
+          }
+
+          return;
+        } else {
+          ts.forEachChild(node, traverse);
+        }
+      }
+
+      traverse(source);
+    }
+
+    const glob = require('glob');
+
+    // note: this outputs Unix-style paths on Windows
+    const wrappers: string[] = glob.GlobSync(prefix + 'src/app/**/themed-*.component.ts', { ignore: 'node_modules/**' }).found;
+
+    for (const wrapper of wrappers) {
+      registerWrapper(wrapper);
+    }
+  }
+
+  private add(entry: ThemeableComponentRegistryEntry) {
+    this.entries.add(entry);
+    this.byBaseClass.set(entry.baseClass, entry);
+    this.byWrapperClass.set(entry.wrapperClass, entry);
+    this.byBasePath.set(entry.basePath, entry);
+    this.byWrapperPath.set(entry.wrapperPath, entry);
+  }
+}
+
+export const themeableComponents = new ThemeableComponentRegistry();
+
+/**
+ * Construct the AST of a TypeScript source file
+ * @param file
+ */
+function getSource(file: string): ts.SourceFile {
+  return ts.createSourceFile(
+    file,
+    readFileSync(file).toString(),
+    ts.ScriptTarget.ES2020,  // todo: actually use tsconfig.json?
+    /*setParentNodes */ true,
+  );
+}
+
+/**
+ * Resolve a possibly relative local path into an absolute path starting from the root directory of the project
+ */
+function resolveLocalPath(path: string, relativeTo: string) {
+  if (path.startsWith('src/')) {
+    return path;
+  } else if (path.startsWith('./')) {
+    const parts = relativeTo.split('/');
+    return [
+      ...parts.slice(0, parts.length - 1),
+      path.replace(/^.\//, ''),
+    ].join('/') + '.ts';
+  } else {
+    throw new Error(`Unsupported local path: ${path}`);
+  }
+}
+
+export function isThemedComponentWrapper(decoratorNode: TSESTree.Decorator): boolean {
+  if (decoratorNode.parent.type !== TSESTree.AST_NODE_TYPES.ClassDeclaration) {
+    return false;
+  }
+
+  if (decoratorNode.parent.superClass?.type !== TSESTree.AST_NODE_TYPES.Identifier) {
+    return false;
+  }
+
+  return (decoratorNode.parent.superClass as any)?.name === 'ThemedComponent';
+}
+
+export function getBaseComponentClassName(decoratorNode: TSESTree.Decorator): string | undefined {
+  const wrapperClass = getComponentClassName(decoratorNode);
+
+  if (wrapperClass === undefined) {
+    return;
+  }
+
+  themeableComponents.initialize();
+  const entry = themeableComponents.byWrapperClass.get(wrapperClass);
+
+  if (entry === undefined) {
+    return undefined;
+  }
+
+  return entry.baseClass;
+}
+
+export function isThemeableComponent(className: string): boolean {
+  themeableComponents.initialize();
+  return themeableComponents.byBaseClass.has(className);
+}
+
+export function inThemedComponentOverrideFile(filename: string): boolean {
+  const match = filename.match(/src\/themes\/[^\/]+\/(app\/.*)/);
+
+  if (!match) {
+    return false;
+  }
+  themeableComponents.initialize();
+  // todo: this is fragile!
+  return themeableComponents.byBasePath.has(`src/${match[1]}`);
+}
+
+export function allThemeableComponents(): ThemeableComponentRegistryEntry[] {
+  themeableComponents.initialize();
+  return [...themeableComponents.entries];
+}
+
+export function getThemeableComponentByBaseClass(baseClass: string): ThemeableComponentRegistryEntry | undefined {
+  themeableComponents.initialize();
+  return themeableComponents.byBaseClass.get(baseClass);
+}
+
+export function isAllowedUnthemedUsage(usageNode: TSESTree.Identifier) {
+  return isPartOfClassDeclaration(usageNode) || isPartOfTypeExpression(usageNode) || isPartOfViewChild(usageNode);
+}
+
+export const DISALLOWED_THEME_SELECTORS = 'ds-(base|themed)-';
+
+export function fixSelectors(text: string): string {
+  return text.replaceAll(/ds-(base|themed)-/g, 'ds-');
+}

lint/src/util/typescript.ts

@@ -0,0 +1,155 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { TSESTree } from '@typescript-eslint/utils';
+import {
+  RuleContext,
+  SourceCode,
+} from '@typescript-eslint/utils/ts-eslint';
+
+import {
+  match,
+  toUnixStylePath,
+} from './misc';
+
+export type AnyRuleContext = RuleContext<string, unknown[]>;
+
+/**
+ * Return the current filename based on the ESLint rule context as a Unix-style path.
+ * This is easier for regex and comparisons to glob paths.
+ */
+export function getFilename(context: AnyRuleContext): string {
+  // TSESLint claims this is deprecated, but the suggested alternative is undefined (could be a version mismatch between ESLint and TSESlint?)
+  // eslint-disable-next-line deprecation/deprecation
+  return toUnixStylePath(context.getFilename());
+}
+
+export function getSourceCode(context: AnyRuleContext): SourceCode {
+  // TSESLint claims this is deprecated, but the suggested alternative is undefined (could be a version mismatch between ESLint and TSESlint?)
+  // eslint-disable-next-line deprecation/deprecation
+  return context.getSourceCode();
+}
+
+export function getObjectPropertyNodeByName(objectNode: TSESTree.ObjectExpression, propertyName: string): TSESTree.Node | undefined {
+  for (const propertyNode of objectNode.properties) {
+    if (
+      propertyNode.type === TSESTree.AST_NODE_TYPES.Property
+      && (
+        (
+          propertyNode.key?.type === TSESTree.AST_NODE_TYPES.Identifier
+          && propertyNode.key?.name === propertyName
+        ) || (
+          propertyNode.key?.type === TSESTree.AST_NODE_TYPES.Literal
+          && propertyNode.key?.value === propertyName
+        )
+      )
+    ) {
+      return propertyNode.value;
+    }
+  }
+  return undefined;
+}
+
+export function findUsages(context: AnyRuleContext, localNode: TSESTree.Identifier): TSESTree.Identifier[] {
+  const source = getSourceCode(context);
+
+  const usages: TSESTree.Identifier[] = [];
+
+  for (const token of source.ast.tokens) {
+    if (token.type === TSESTree.AST_TOKEN_TYPES.Identifier && token.value === localNode.name && !match(token.range, localNode.range)) {
+      const node = source.getNodeByRangeIndex(token.range[0]);
+      // todo: in some cases, the resulting node can actually be the whole program (!)
+      if (node !== null) {
+        usages.push(node as TSESTree.Identifier);
+      }
+    }
+  }
+
+  return usages;
+}
+
+export function findUsagesByName(context: AnyRuleContext, identifier: string): TSESTree.Identifier[] {
+  const source = getSourceCode(context);
+
+  const usages: TSESTree.Identifier[] = [];
+
+  for (const token of source.ast.tokens) {
+    if (token.type === TSESTree.AST_TOKEN_TYPES.Identifier && token.value === identifier) {
+      const node = source.getNodeByRangeIndex(token.range[0]);
+      // todo: in some cases, the resulting node can actually be the whole program (!)
+      if (node !== null) {
+        usages.push(node as TSESTree.Identifier);
+      }
+    }
+  }
+
+  return usages;
+}
+
+export function isPartOfTypeExpression(node: TSESTree.Identifier): boolean {
+  return node.parent?.type?.valueOf().startsWith('TSType');
+}
+
+export function isPartOfClassDeclaration(node: TSESTree.Identifier): boolean {
+  return node.parent?.type === TSESTree.AST_NODE_TYPES.ClassDeclaration;
+}
+
+function fromSrc(path: string): string {
+  const m = path.match(/^.*(src\/.+)(\.(ts|json|js)?)$/);
+
+  if (m) {
+    return m[1];
+  } else {
+    throw new Error(`Can't infer project-absolute TS/resource path from: ${path}`);
+  }
+}
+
+
+export function relativePath(thisFile: string, importFile: string): string {
+  const fromParts = fromSrc(thisFile).split('/');
+  const toParts = fromSrc(importFile).split('/');
+
+  let lastCommon = 0;
+  for (let i = 0; i < fromParts.length - 1; i++) {
+    if (fromParts[i] === toParts[i]) {
+      lastCommon++;
+    } else {
+      break;
+    }
+  }
+
+  const path = toParts.slice(lastCommon, toParts.length).join('/');
+  const backtrack = fromParts.length - lastCommon - 1;
+
+  let prefix: string;
+  if (backtrack > 0) {
+    prefix = '../'.repeat(backtrack);
+  } else {
+    prefix = './';
+  }
+
+  return prefix + path;
+}
+
+
+export function findImportSpecifier(context: AnyRuleContext, identifier: string): TSESTree.ImportSpecifier | undefined {
+  const source = getSourceCode(context);
+
+  const usages: TSESTree.Identifier[] = [];
+
+  for (const token of source.ast.tokens) {
+    if (token.type === TSESTree.AST_TOKEN_TYPES.Identifier && token.value === identifier) {
+      const node = source.getNodeByRangeIndex(token.range[0]);
+      // todo: in some cases, the resulting node can actually be the whole program (!)
+      if (node && node.parent && node.parent.type === TSESTree.AST_NODE_TYPES.ImportSpecifier) {
+        return node.parent;
+      }
+    }
+  }
+
+  return undefined;
+}

lint/test/fixture/README.md

@@ -0,0 +1,9 @@
+# ESLint testing fixtures
+
+The files in this directory are used for the ESLint testing environment
+- Some rules rely on registries that must be built up _before_ the rule is run
+  - In order to test these registries, the fixture sources contain a few dummy components
+- The TypeScript ESLint test runner requires at least one dummy file to exist to run any tests
+  - By default, [`test.ts`](./src/test.ts) is used. Note that this file is empty; it's only there for the TypeScript configuration, the actual content is injected from the `code` property in the tests.
+  - To test rules that make assertions based on the path of the file, you'll need to include the `filename` property in the test configuration. Note that it must point to an existing file too!
+  - The `filename` must be provided as `fixture('src/something.ts')`

lint/test/fixture/index.ts

@@ -0,0 +1,13 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
+export const FIXTURE = 'lint/test/fixture/';
+
+export function fixture(path: string): string {
+  return FIXTURE + path;
+}

lint/test/fixture/src/app/test/test-routing.module.ts

@@ -0,0 +1,14 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { ThemedTestThemeableComponent } from './themed-test-themeable.component';
+
+export const ROUTES = [
+  {
+    component: ThemedTestThemeableComponent,
+  },
+];

lint/test/fixture/src/app/test/test-themeable.component.ts

@@ -0,0 +1,16 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'ds-base-test-themeable',
+  template: '',
+  standalone: true,
+})
+export class TestThemeableComponent {
+}

lint/test/fixture/src/app/test/test.component.cy.ts

@@ -0,0 +1,8 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+

lint/test/fixture/src/app/test/test.component.spec.ts

@@ -0,0 +1,8 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+

lint/test/fixture/src/app/test/test.component.ts

@@ -0,0 +1,15 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'ds-test',
+  template: '',
+})
+export class TestComponent {
+}

lint/test/fixture/src/app/test/test.module.ts

@@ -0,0 +1,24 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+// @ts-ignore
+import { NgModule } from '@angular/core';
+
+import { TestComponent } from './test.component';
+import { TestThemeableComponent } from './test-themeable.component';
+import { ThemedTestThemeableComponent } from './themed-test-themeable.component';
+
+@NgModule({
+  declarations: [
+    TestComponent,
+    TestThemeableComponent,
+    ThemedTestThemeableComponent,
+  ],
+})
+export class TestModule {
+
+}

lint/test/fixture/src/app/test/themed-test-themeable.component.ts

@@ -0,0 +1,31 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+import { ThemedComponent } from '../../../../../../src/app/shared/theme-support/themed.component';
+import { TestThemeableComponent } from './test-themeable.component';
+
+@Component({
+  selector: 'ds-test-themeable',
+  template: '',
+  standalone: true,
+  imports: [TestThemeableComponent],
+})
+export class ThemedTestThemeableComponent extends ThemedComponent<TestThemeableComponent> {
+  protected getComponentName(): string {
+    return '';
+  }
+
+  protected importThemedComponent(themeName: string): Promise<any> {
+    return Promise.resolve(undefined);
+  }
+
+  protected importUnthemedComponent(): Promise<any> {
+    return Promise.resolve(undefined);
+  }
+}

lint/test/fixture/src/themes/test/app/test/other-themeable.component.ts

@@ -0,0 +1,16 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'ds-themed-test-themeable',
+  template: '',
+})
+export class OtherThemeableComponent {
+
+}