chore: resolve mr conflicts

Author: Fabian Stoehr

.codecov.yml

@@ -0,0 +1,5 @@
+codecov:
+  coverage:
+    precision: 1
+    round: up
+    

.eslintrc

@@ -1,19 +1,59 @@
 {
-  "env": {
-    "jest/globals": true
+  "parserOptions": {
+    "ecmaVersion": 2022,
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    }
   },
-  "extends": ["airbnb","react-app", "plugin:jest-dom/recommended", "plugin:testing-library/react"],
+  "extends": [
+    "airbnb",
+    "plugin:react/recommended",
+    "plugin:react-hooks/recommended",
+    "plugin:testing-library/react"
+  ],
   "globals": {
     "page": true,
-    "document": true
+    "document": true,
+    "vi": true
   },
-  "plugins": ["jest", "jest-dom", "react", "react-hooks", "testing-library"],
+  "plugins": [
+    "react", 
+    "react-hooks",
+    "testing-library"
+  ],
   "rules": {
     "import/no-unresolved": [
       2, { "ignore": ["test-utils"] }
     ],
     "import/prefer-default-export": "off",
     "no-console": "off",
+    "no-unused-expressions": ["error", { "allowShortCircuit": true, "allowTernary": true }],
+    "no-unused-vars": "off",
+    "no-undef": "off",
+    "no-restricted-syntax": ["warn", "WithStatement"],
+    "no-restricted-globals": ["error"],
+    "eqeqeq": ["warn", "smart"],
+    "no-use-before-define": [
+      "warn",
+      {
+        "functions": false,
+        "classes": false,
+        "variables": false
+      },
+    ],
+    "no-mixed-operators": [
+      "warn",
+      {
+        "groups": [
+          ["&", "|", "^", "~", "<<", ">>", ">>>"],
+          ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
+          ["&&", "||"],
+          ["in", "instanceof"],
+        ],
+        "allowSamePrecedence": false,
+      },
+    ],
     "react/jsx-filename-extension": [1, { "extensions": [".js", ".jsx"] }],
     "require-jsdoc": ["error", {
       "require": {
@@ -35,6 +75,7 @@
     "default-param-last": "off",
     "arrow-parens": "off",
     "import/no-anonymous-default-export": "off",
+    "import/no-extraneous-dependencies": "off",
     "max-len": ["error", {
       "code": 120,
       "ignoreComments": true,
@@ -44,9 +85,12 @@
     }],
     "react/jsx-uses-react": "off",
     "react/react-in-jsx-scope": "off",
+    "react/require-default-props": [2, {
+      "functions": "defaultArguments"
+    }],
     "react-hooks/exhaustive-deps": "error",
     "testing-library/render-result-naming-convention": "off",
-    "testing-library/no-render-in-setup": [
+    "testing-library/no-render-in-lifecycle": [
       "error",
       {
         "allowTestingFrameworkSetupHook": "beforeEach"

.github/workflows/node.js.yml

@@ -14,15 +14,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 19.x]
+        node-version: [18.x, 20.x, 22.x]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install
     - run: npm test
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v5
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

CONTRIBUTING.md

@@ -1,26 +1,47 @@
-This document serves as a reference for the Mirador community and others interested in the project. It aims to outline agreed upon practices that are used in the development and maintenance of the Mirador software.
+This document serves as a reference for the Mirador community and others interested in the project. It aims to outline agreed-upon practices that are used in the development and maintenance of the Mirador software.
+
 
 ## Contributing to Mirador
-Contributions to Mirador are always welcome, however, it will always be helpful to begin any large change by submitting an issue or engaging with the Mirador community. For more on this, see [plugin architecture](#plugin-architecture). Mirador 3.0 and beyond adheres to [semantic versioning](https://semver.org/) so that adopters and contributors can better understand what changes can be expected in released versions of the software.
 
-All contributions should be submitted as a [GitHub pull request](https://help.github.com/articles/about-pull-requests/) to the `master` branch. Pull requests must be reviewed and accepted by another Mirador maintainer and pass all continuous integration checks. Contributions should have tests for the feature or bug fix, documentation and should conform to the Mirador agreed upon coding style. Contributions should not include a “built” version of Mirador, this will help in reducing merge conflicts.
+Contributions to Mirador are always welcome!
+
+It is always helpful to begin any large change by submitting an issue or engaging with the Mirador community. Mirador 3.0 and beyond adheres to [semantic versioning](https://semver.org/) so that adopters and contributors can better understand what changes can be expected in released versions of the software.
+
+All contributions should be submitted as a [GitHub pull request](https://help.github.com/articles/about-pull-requests/) to the master branch. Pull requests must be reviewed and accepted by another Mirador maintainer and pass all continuous integration checks. Contributions should have tests for the feature or bug fix, documentation, should maintain high code coverage, and should conform to the Mirador agreed-upon coding style. Contributions should not include a “built” version of Mirador—this will help to reduce merge conflicts.
+
+### Code of Conduct
+Everyone interacting in this community is expected to follow the [Mirador Code of Conduct](https://github.com/ProjectMirador/mirador/blob/master/CODE_OF_CONDUCT.md).
+
+### Accessibility
+Mirador 3 aims to comply with the [Web Content Accessibility Guidelines (WCAG) 2.1 AA](https://www.w3.org/WAI/standards-guidelines/wcag/). These guidelines, authored by the W3C and legally adopted [internationally](https://www.w3.org/WAI/policies/?q=wcag-20), are comprehensive and provide the success criteria designers and developers need to build accessible web applications.
+
+Mirador’s documentation wiki offers [additional information, tools, and resources](https://github.com/ProjectMirador/mirador/wiki/M3-Accessibility-Guidelines-for-Contributors) for testing your contributions against accessibility criteria before submitting pull requests.
 
 ### Adding dependencies
-Careful consideration should be given when adding software dependencies to Mirador. During the code review process, new dependencies may be evaluated on the following considerations: 
-- added size of the dependency
-- whether or not that dependency is maintained and tested
-- how the dependency may interact with Mirador embedded in other environments
+Careful consideration should be given when adding software dependencies to Mirador. During the code review process, new dependencies may be evaluated on the following considerations:
 
-As a general rule, any dependencies added should not be committed directly, but should use a package manager to require the dependency.
+-   added size of the dependency
+-   whether or not that dependency is maintained and tested
+-   how the dependency may interact with Mirador embedded in other environments
+    
+As a general rule, dependencies added should not be committed directly, but should instead use a package manager to require the dependency.
 
 Dependencies should also be scoped (both for style and script) so that they do not interact with a containing application.
 
 ### Coding style
-Mirador has adopted the [AirBnb JavaScript Style Guide](https://github.com/airbnb/javascript) as its agreed upon coding style for all contributions. This helps us ensure a consistent codebase with higher readability. 
+Mirador has adopted the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) as its agreed-upon coding style for all contributions. This helps us ensure a consistent codebase with higher readability.
+
 ### Testing
-Mirador should be well tested at several different levels. A component or class should be tested individually (unit tests) and the interaction of that component or class with other parts should also be tested (integration tests).
+Mirador should be well-tested at several different levels. A component or class should be tested individually (unit tests) and the interaction of that component or class with other parts should also be tested (integration tests).
+
 ### Documentation
 Added or modified code should be appropriately documented using JSDoc comments and established project conventions.
 
+### Plugin architecture
+Mirador 3 shifted to a plugin architecture to better support the wide array of uses of Mirador. This allows for the design to accommodate plugins in a more focused way. It also allows the community to maintain the core components while giving developers the freedom to develop new and innovative plugins. Your contribution might fit nicely as a Mirador plugin. For more on plugins, please see [Mirador 3 Plugins](https://github.com/ProjectMirador/mirador/wiki/Mirador-3-plugins) and [Creating a Mirador 3 Plugin](https://github.com/ProjectMirador/mirador/wiki/M3---Creating-a-Mirador-plugin) in the wiki.
+
+### Support
+If you have questions, please check the [wiki](https://github.com/ProjectMirador/mirador/wiki), add a [discussion](https://github.com/ProjectMirador/mirador/discussions) question, post on the #mirador channel of the [IIIF Slack workspace](http://iiif.slack.com/), or join a Mirador community call (see #mirador for call details). Slack and community calls are also both great places to meet users and maintainers.
+
 ### Plugin architecture
 Mirador 3 shifted to a plugin architecture to better support the wide array of uses of Mirador. This allows for the design to accommodate plugins in more focused way. It also allows the community to maintain the core components while giving developers the freedom to develop new and innovative plugins. Your contribution might fit nicely as a Mirador plugin.

README.md

@@ -1,4 +1,3 @@
-⚠️ This project is for Mirador 3, the latest version of Mirador. For Mirador 2, please see [ProjectMirador/mirador2](https://github.com/projectmirador/mirador2) or legacy documentation on the [Mirador 2 wiki](https://github.com/ProjectMirador/mirador-2-wiki/wiki). Please note that the community's focus is on Mirador 3, and are unlikely to accept pull requests or provide support for Mirador 2.
 # Mirador
 ![Node.js CI](https://github.com/ProjectMirador/mirador/workflows/Node.js%20CI/badge.svg) [![codecov](https://codecov.io/gh/ProjectMirador/mirador/branch/master/graph/badge.svg)](https://codecov.io/gh/ProjectMirador/mirador) 
 
@@ -75,15 +74,21 @@ store.getState()
 ```
 
 ## Running the tests
+We use Vitest to run our test suite.
 
 ```sh
-$ npm test # For headless CI=true npm test
+$ npm test
 ```
 
-or to continually watch the source files
+You can see the helpful Vitest UI in your browser by running Vitest with the `--ui` flag. To pass the flag through to npm run the following:
 
 ```sh
-$ npm run test:watch
+$ npm test -- --ui
+```
+
+You can run Vitest without the additional linting and size checks in our `npm test` command. You can also test a single file:
+```sh
+$ npx vitest __tests__/integration/mirador/tests/sequence-switching.test.js --ui
 ```
 
 ## Linting the project

__tests__/fixtures/version-2/broken.json

@@ -1,6 +1,3 @@
-<html>
-  <title>Error</title>
-  <body>
-    <p>Something went wrong</p>
-  </body>
-</html>
+{
+  "test": "Broken"
+}

__tests__/integration/mirador/annotations.test.js

@@ -9,22 +9,10 @@
   </head>
   <body>
     <div id="mirador" style="position: absolute; top: 0; bottom: 0; left: 0; right: 0;"></div>
-    <script>document.write("<script type='text/javascript' src='../../../dist/mirador.min.js?v=" + Date.now() + "'><\/script>");</script>
-    <script type="text/javascript">
-     var miradorInstance = Mirador.viewer({
-       id: 'mirador',
-       windows: [
-       {
-         manifestId: 'https://purl.stanford.edu/ds199xg9454/iiif/manifest',
-       },
-       {
-         manifestId: 'https://edsilv.github.io/test-manifests/auth1-degraded.json'
-       },
-       {
-         manifestId: 'https://edsilv.github.io/test-manifests/auth1-standard.json'
-       }
-       ],
-     });
+    <script type="module">
+      import Mirador from '../../../src';
+      import config from './mirador-configs/auth.js';
+      Mirador.viewer(config);
     </script>
   </body>
 </html>

__tests__/integration/mirador/auth.html

@@ -9,15 +9,10 @@
   </head>
   <body>
     <div id="mirador" style="position: absolute; top: 0; bottom: 0; left: 0; right: 0;"></div>
-    <script>document.write("<script type='text/javascript' src='../../../dist/mirador.min.js?v=" + Date.now() + "'><\/script>");</script>
-    <script type="text/javascript">
-     var miradorInstance = Mirador.viewer({
-       id: 'mirador',
-       windows: [],
-       theme: {
-         transitions: window.location.port === '4488' ?  { create: () => 'none' } : {},
-       },
-     });
+    <script type="module">
+      import Mirador from '../../../src';
+      import config from './mirador-configs/blank.js';
+      Mirador.viewer(config);
     </script>
   </body>
 </html>