Add localConfig instructions.

.eslintrc.cjs

@@ -10,6 +10,9 @@ module.exports = {
     ecmaVersion: 'latest',
     sourceType: 'module'
   },
+  overrides: [{
+    files: ['**/*.js', '**/*.cjs']
+  }],
   extends: [
     'eslint-config-digitalbazaar',
     'eslint-config-digitalbazaar/jsdoc',

.gitignore

@@ -18,3 +18,4 @@ reports/**
 credentials/*.json
 .vscode
 .localImplementationsConfig.cjs
+localConfig.cjs

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Changed
 - `respecConfig.json` is now `config/respec.json`.
 - `abstract.hbs` is now `config/abstract.hbs`.
+- `localImplementationsConfig.cjs` is now `localConfig.cjs`
 
 ### Added
 - Add `config/runner.json` for configuring the tag used for the suite.

README.md

@@ -86,47 +86,48 @@ Content-Type: application/ld+json
 
 ### Testing Locally
 If you want to test implementations or just endpoints running locally, you can
-copy `localImplementationsConfig.example.cjs` to `.localImplementationsConfig.cjs`
+copy `localConfig.example.cjs` to `localConfig.cjs`
 in the root directory of the test suite.
 
 ```bash
-cp localImplementationsConfig.example.cjs .localImplementationsConfig.cjs
+cp localConfig.example.cjs localConfig.cjs
 ```
 
-Git is set to ignore `.localImplementationsConfig.cjs` by default.
+Git is set to ignore `localConfig.cjs` by default.
 
 This file must be a CommonJS module that exports an array of implementations:
 
 ```js
-// .localImplementationsConfig.cjs defining local implementations
+// .localConfig.cjs defining local implementations
 // you can specify a BASE_URL before running the tests such as:
 // BASE_URL=http://localhost:40443/zDdfsdfs npm test
 const baseUrl = process.env.BASE_URL || 'https://localhost:40443/id';
-module.exports = [{
-  name: 'My Company',
-  implementation: 'My Implementation Name',
-  issuers: [{
-    id: 'did:myMethod:implementation:issuer:id',
-    endpoint: `${baseUrl}/credentials/issue`,
-    tags: ['eddsa-rdfc-2022', 'localhost']
-  }],
-  verifiers: [{
-    id: 'did:myMethod:implementation:verifier:id',
-    endpoint: `${baseUrl}/credentials/verify`,
-    tags: ['eddsa-rdfc-2022', 'localhost']
-  }]
-}];
+module.exports = {
+  settings: {
+    enableInteropTests: false, // default
+    testAllImplementations: false // default
+  },
+  implementations: [{
+    name: 'My Company',
+    implementation: 'My Implementation Name',
+    issuers: [{
+      id: 'did:myMethod:implementation:issuer:id',
+      endpoint: `${baseUrl}/credentials/issue`,
+      supports: {
+        vc: ['1.1', '2.0']
+      },
+      tags: ['eddsa-rdfc-2022', 'localhost']
+    }],
+    verifiers: [{
+      id: 'did:myMethod:implementation:verifier:id',
+      endpoint: `${baseUrl}/credentials/verify`,
+      tags: ['eddsa-rdfc-2022', 'localhost']
+    }]
+  }];
+}
 ```
-
-After adding the config file, both the localhost implementations and other
-implementations matching the test tag will be included in the test run.
-
-To specifically test only the localhost implementation, modify the test suite to
-filter implementations based on a specific tag in your local configuration file.
-
-For instance, if your `.localImplementationsConfig.cjs` config file looks like
-the config above, you can adjust the tag used in each test suite by modifying `./config/runner.json`
-to filter the implementations by `localhost` and other tags.
+To specifically test only the implementations in `localConfig.cjs`, change
+`settings.testAllImplementations` to `false`.
 
 ### Running Specific Tests
 This suite uses [mocha.js](https://mochajs.org) as the test runner.

localConfig.example.cjs

@@ -0,0 +1,32 @@
+/*!
+ * Copyright (c) 2022-2024 Digital Bazaar, Inc.
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+// Rename this file to .localConfig.cjs
+// you can specify a BASE_URL before running the tests such as:
+// BASE_URL=http://localhost:40443/zDdfsdfs npm test
+const baseUrl = process.env.BASE_URL || 'https://localhost:34557';
+
+module.exports = {
+  settings: {
+    enableInteropTests: false, // default
+    testAllImplementations: false // default
+  },
+  implementations: [{
+    name: 'My Company',
+    implementation: 'My Implementation Name',
+    issuers: [{
+      id: 'did:myMethod:implementation:issuer:id',
+      endpoint: `${baseUrl}/credentials/issue`,
+      supports: {
+        vc: ['1.1', '2.0']
+      },
+      tags: ['eddsa-rdfc-2022', 'localhost']
+    }],
+    verifiers: [{
+      id: 'did:myMethod:implementation:verifier:id',
+      endpoint: `${baseUrl}/credentials/verify`,
+      tags: ['eddsa-rdfc-2022', 'localhost']
+    }]
+  }]
+};