adapt-authoring-config 1.0.0 → 1.1.0

package/.github/workflows/new.yml

@@ -1,19 +1,15 @@
-name: Add to main project
+# Calls the org-level reusable workflow to add PRs to the TODO Board
+
+name: Add PR to Project
 
 on:
-  issues:
-    types:
-      - opened
   pull_request:
     types:
       - opened
+      - reopened
 
 jobs:
   add-to-project:
-    name: Add to main project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@v0.1.0
-        with:
-          project-url: https://github.com/orgs/adapt-security/projects/5
-          github-token: ${{ secrets.PROJECTS_SECRET }}
+    uses: adapt-security/.github/.github/workflows/new.yml@main
+    secrets:
+      PROJECTS_SECRET: ${{ secrets.PROJECTS_SECRET }}

package/.github/workflows/releases.yml

@@ -3,10 +3,16 @@ on:
   push:
     branches:
       - master
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -16,10 +22,11 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'
+      - name: Update npm
+        run: npm install -g npm@latest
       - name: Install dependencies
         run: npm ci
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
-        run: npx semantic-release
+        run: npx semantic-release

package/.github/workflows/standardjs.yml

@@ -0,0 +1,13 @@
+name: Standard.js formatting check
+on: push
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - run: npm ci
+      - run: npx standard

package/docs/plugins/configuration.js

@@ -1,70 +1,74 @@
-import fs from 'fs';
-import path from 'path';
+import fs from 'fs'
+import path from 'path'
 
 export default class Configuration {
-  async run() {
-    const schemas = this.loadSchemas();
-    this.contents = Object.keys(schemas).sort();
-    this.manualFile = 'configuration.md';
+  async run () {
+    const schemas = this.loadSchemas()
+    this.contents = Object.keys(schemas).sort()
+    this.manualFile = 'configuration.md'
     this.replace = {
-      'CODE_EXAMPLE': this.generateCodeExample(schemas),
-      'LIST': this.generateList(schemas)
-    };
+      CODE_EXAMPLE: this.generateCodeExample(schemas),
+      LIST: this.generateList(schemas)
+    }
   }
-  loadSchemas() {
-    const schemas = {};
+
+  loadSchemas () {
+    const schemas = {}
     Object.values(this.app.dependencies).forEach(c => {
-      const confDir = path.join(c.rootDir, 'conf');
+      const confDir = path.join(c.rootDir, 'conf')
       try {
-        schemas[c.name] = JSON.parse(fs.readFileSync(path.join(confDir, 'config.schema.json')));
-      } catch(e) {}
-    });
-    return schemas;
+        schemas[c.name] = JSON.parse(fs.readFileSync(path.join(confDir, 'config.schema.json')))
+      } catch (e) {}
+    })
+    return schemas
   }
-  generateCodeExample(schemas) {
-    let output = '\`\`\`javascript\nexport default {\n';
+
+  generateCodeExample (schemas) {
+    let output = '```javascript\nexport default {\n'
     this.contents.forEach((name) => {
-      const schema = schemas[name];
-      output += `  '${name}': {\n`;
+      const schema = schemas[name]
+      output += `  '${name}': {\n`
       Object.entries(schema.properties).forEach(([attr, config]) => {
-        const required = schema.required && schema.required.includes(attr);
-        if(config.description) output += `    // ${config.description}\n`;
-        output += `    ${attr}: ${this.defaultToMd(config)}, // ${config.type}, ${required ? 'required' : 'optional'}\n`;
-      });
-      output += `  },\n`;
-    });
-    output += `};\n\`\`\``;
-    return output;
+        const required = schema.required && schema.required.includes(attr)
+        if (config.description) output += `    // ${config.description}\n`
+        output += `    ${attr}: ${this.defaultToMd(config)}, // ${config.type}, ${required ? 'required' : 'optional'}\n`
+      })
+      output += '  },\n'
+    })
+    output += '};\n```'
+    return output
   }
-  generateList(schemas) {
-    let output = '';
+
+  generateList (schemas) {
+    let output = ''
 
     this.contents.forEach(dep => {
-      const schema = schemas[dep];
-      output += `<h3 id="${dep}" class="dep">${dep}</h3>\n\n`;
-      output += `<div class="options">\n`;
+      const schema = schemas[dep]
+      output += `<h3 id="${dep}" class="dep">${dep}</h3>\n\n`
+      output += '<div class="options">\n'
       Object.entries(schema.properties).forEach(([attr, config]) => {
-        const required = schema.required && schema.required.includes(attr);
-        output += `<div class="attribute">\n`;
-        output += `<div class="title"><span class="main">${attr}</span> (${config.type || ''}, ${required ? 'required' : 'optional'})</div>\n`;
-        output += `<div class="inner">\n`;
-        output += `<div class="description">${config.description}</div>\n`;
-        if(!required) {
-          output += `<div class="default"><span class="label">Default</span>: <pre>${this.defaultToMd(config)}</pre></div>\n`;
+        const required = schema.required && schema.required.includes(attr)
+        output += '<div class="attribute">\n'
+        output += `<div class="title"><span class="main">${attr}</span> (${config.type || ''}, ${required ? 'required' : 'optional'})</div>\n`
+        output += '<div class="inner">\n'
+        output += `<div class="description">${config.description}</div>\n`
+        if (!required) {
+          output += `<div class="default"><span class="label">Default</span>: <pre>${this.defaultToMd(config)}</pre></div>\n`
         }
-        output += `</div>\n`;
-        output += `</div>\n`;
-      });
-      output += `</div>`;
-      output += `\n\n`;
-    });
+        output += '</div>\n'
+        output += '</div>\n'
+      })
+      output += '</div>'
+      output += '\n\n'
+    })
 
-    return output;
+    return output
   }
+
   /**
    * Returns a string formatted nicely for markdown
    */
-  defaultToMd(config) {
-    return JSON.stringify(config.default);
+  defaultToMd (config) {
+    return JSON.stringify(config.default, null, 2)?.replaceAll('\n', '\n    ')
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-config",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A configuration module for the Adapt authoring tool.",
   "homepage": "https://github.com/adapt-security/adapt-authoring-config",
   "license": "GPL-3.0",
@@ -13,22 +13,21 @@
   "dependencies": {
     "adapt-authoring-core": "github:adapt-security/adapt-authoring-core",
     "chalk": "^5.3.0",
-    "glob": "^11.0.0"
+    "glob": "^13.0.0"
   },
   "peerDependencies": {
     "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
   },
   "devDependencies": {
-    "eslint": "^9.12.0",
-    "standard": "^17.1.0",
-    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^8.0.5",
-    "@semantic-release/npm": "^9.0.1",
-    "@semantic-release/release-notes-generator": "^10.0.3",
-    "conventional-changelog-eslint": "^3.0.9",
-    "semantic-release": "^21.0.1",
-    "semantic-release-replace-plugin": "^1.2.7"
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "conventional-changelog-eslint": "^6.0.0",
+    "semantic-release": "^25.0.2",
+    "semantic-release-replace-plugin": "^1.2.7",
+    "standard": "^17.1.0"
   },
   "release": {
     "plugins": [

package/tests/configModule.spec.js

@@ -1,61 +1,63 @@
-const Config = require('../lib/configUtils');
-const path = require('path');
-const should = require('should');
+/* global before describe, it */
 
-describe('Config module', function() {
-  before(function() {
-    this.config = new Config(global.ADAPT.app, {});
-    this.configJson = require(path.join(process.cwd(), 'conf', 'testing.config.js'));
-  });
-  describe('#initialise()', function() {
-    it('should error on missing required attribute', runConfigInitialise('required'));
-    it('should error on incorrect attribute type', runConfigInitialise('incorrecttype'));
-    it('should error on validator fail', runConfigInitialise('invalid'));
-  });
-  describe('#has()', function() {
-    it('should be able to verify a value exists', function() {
-      const exists = this.config.has('adapt-authoring-testing.test');
-      exists.should.be.true();
-    });
-    it('should be able to verify a value doesn\'t exist', function() {
-      const exists = this.config.has('adapt-authoring-testing.nonono');
-      exists.should.not.be.true();
-    });
-  });
-  describe('#get()', function() {
-    it('should be able to retrieve a value', function() {
-      const actualValue = this.config.get('adapt-authoring-testing.test');
-      const expectedValue = this.configJson['adapt-authoring-testing'].test;
-      actualValue.should.equal(expectedValue);
-    });
-  });
-  describe('#set()', function() {
-    it('should be able to set a value', function() {
-      const newValue = 'newtestvalue';
-      this.config.set('adapt-authoring-testing.test', newValue);
-      const actualValue = this.config.get('adapt-authoring-testing.test');
-      actualValue.should.equal(newValue);
-    });
-  });
-  describe('#getPublicConfig()', function() {
-    it('should be able to retrieve values marked as public', function() {
-      this.config.app.dependencies = [{ name: 'adapt-authoring-testing', dir: path.join(__dirname, 'data') }];
-      this.config.initialise();
-      const config = this.config.getPublicConfig();
-      const value = config['adapt-authoring-testing.one'];
-      config.should.be.an.Object();
-      value.should.equal('default');
-    });
-  });
-});
+const Config = require('../lib/configUtils')
+const path = require('path')
+// const should = require('should')
+
+describe('Config module', function () {
+  before(function () {
+    this.config = new Config(global.ADAPT.app, {})
+    this.configJson = require(path.join(process.cwd(), 'conf', 'testing.config.js'))
+  })
+  describe('#initialise()', function () {
+    it('should error on missing required attribute', runConfigInitialise('required'))
+    it('should error on incorrect attribute type', runConfigInitialise('incorrecttype'))
+    it('should error on validator fail', runConfigInitialise('invalid'))
+  })
+  describe('#has()', function () {
+    it('should be able to verify a value exists', function () {
+      const exists = this.config.has('adapt-authoring-testing.test')
+      exists.should.be.true()
+    })
+    it('should be able to verify a value doesn\'t exist', function () {
+      const exists = this.config.has('adapt-authoring-testing.nonono')
+      exists.should.not.be.true()
+    })
+  })
+  describe('#get()', function () {
+    it('should be able to retrieve a value', function () {
+      const actualValue = this.config.get('adapt-authoring-testing.test')
+      const expectedValue = this.configJson['adapt-authoring-testing'].test
+      actualValue.should.equal(expectedValue)
+    })
+  })
+  describe('#set()', function () {
+    it('should be able to set a value', function () {
+      const newValue = 'newtestvalue'
+      this.config.set('adapt-authoring-testing.test', newValue)
+      const actualValue = this.config.get('adapt-authoring-testing.test')
+      actualValue.should.equal(newValue)
+    })
+  })
+  describe('#getPublicConfig()', function () {
+    it('should be able to retrieve values marked as public', function () {
+      this.config.app.dependencies = [{ name: 'adapt-authoring-testing', dir: path.join(__dirname, 'data') }]
+      this.config.initialise()
+      const config = this.config.getPublicConfig()
+      const value = config['adapt-authoring-testing.one']
+      config.should.be.an.Object()
+      value.should.equal('default')
+    })
+  })
+})
 /**
 * Checks ConfigUtility#initialise
 * Loads the testing data in tests/data/dirname
 */
-function runConfigInitialise(dirname) {
-  return function() {
-    this.config.app.dependencies = [{ name: 'adapt-authoring-testing', dir: path.join(__dirname, 'data', dirname) }];
-    this.config.initialise();
-    this.config.errors.length.should.be.exactly(1);
-  };
+function runConfigInitialise (dirname) {
+  return function () {
+    this.config.app.dependencies = [{ name: 'adapt-authoring-testing', dir: path.join(__dirname, 'data', dirname) }]
+    this.config.initialise()
+    this.config.errors.length.should.be.exactly(1)
+  }
 }

package/tests/configUtils.spec.js

@@ -1,34 +1,36 @@
-const path = require('path');
-const utils = require('../lib/ConfigUtils');
-const should = require('should');
+/* global describe, it */
 
-describe('Config utils', function() {
-  describe('#loadFile()', function() {
-    it('should be able to load a valid file', function() {
-      const filepath = path.join(__dirname, 'data', 'testfile.json');
-      const actualContents = utils.loadFile(filepath);
-      const expectedContents = require(filepath);
-      actualContents.should.deepEqual(expectedContents);
-    });
-    it('should not error on a missing file', function() {
-      should.doesNotThrow(function() {
-        const contents = utils.loadFile(path.join('this', 'path', 'does', 'not', 'exist.xyz'));
-        should(contents).be.undefined();
-      });
-    });
-  });
-  describe('#loadConfigSchema()', function() {
-    it('should be able to load a valid schema file', function() {
-      const dir = path.join(__dirname, 'data');
-      const actualContents = utils.loadConfigSchema(dir);
-      const expectedContents = require(path.join(dir, 'conf', 'config.schema.js'));
-      actualContents.should.deepEqual(expectedContents);
-    });
-    it('should not error on a missing schema file', function() {
-      should.doesNotThrow(function() {
-        const contents = utils.loadConfigSchema(path.join(__dirname, 'doesntexist'));
-        should(contents).be.undefined();
-      });
-    });
-  });
-});
+const path = require('path')
+const utils = require('../lib/ConfigUtils')
+const should = require('should')
+
+describe('Config utils', function () {
+  describe('#loadFile()', function () {
+    it('should be able to load a valid file', function () {
+      const filepath = path.join(__dirname, 'data', 'testfile.json')
+      const actualContents = utils.loadFile(filepath)
+      const expectedContents = require(filepath)
+      actualContents.should.deepEqual(expectedContents)
+    })
+    it('should not error on a missing file', function () {
+      should.doesNotThrow(function () {
+        const contents = utils.loadFile(path.join('this', 'path', 'does', 'not', 'exist.xyz'))
+        should(contents).be.undefined()
+      })
+    })
+  })
+  describe('#loadConfigSchema()', function () {
+    it('should be able to load a valid schema file', function () {
+      const dir = path.join(__dirname, 'data')
+      const actualContents = utils.loadConfigSchema(dir)
+      const expectedContents = require(path.join(dir, 'conf', 'config.schema.js'))
+      actualContents.should.deepEqual(expectedContents)
+    })
+    it('should not error on a missing schema file', function () {
+      should.doesNotThrow(function () {
+        const contents = utils.loadConfigSchema(path.join(__dirname, 'doesntexist'))
+        should(contents).be.undefined()
+      })
+    })
+  })
+})

package/tests/data/conf/config.schema.js

@@ -7,4 +7,4 @@ module.exports = {
       public: true
     }
   }
-};
+}

package/tests/data/incorrecttype/conf/config.schema.js

@@ -4,4 +4,4 @@ module.exports = {
       type: 'Number'
     }
   }
-};
+}

package/tests/data/invalid/conf/config.schema.js

@@ -5,4 +5,4 @@ module.exports = {
       validator: val => val === 4
     }
   }
-};
+}

package/tests/data/required/conf/config.schema.js

@@ -5,4 +5,4 @@ module.exports = {
       required: true
     }
   }
-};
+}

package/.eslintignore

@@ -1 +0,0 @@
-node_modules

package/.eslintrc

@@ -1,14 +0,0 @@
-{
-  "env": {
-      "browser": false,
-      "node": true,
-      "commonjs": false,
-      "es2020": true
-  },
-  "extends": [
-      "standard"
-  ],
-  "parserOptions": {
-      "ecmaVersion": 2020
-  }
-}

package/.github/workflows/labelled_prs.yml

@@ -1,16 +0,0 @@
-name: Add labelled PRs to project
-
-on:
-  pull_request:
-    types: [ labeled ]
-
-jobs:
-  add-to-project:
-    if: ${{ github.event.label.name == 'dependencies' }}
-    name: Add to main project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@v0.1.0
-        with:
-          project-url: https://github.com/orgs/adapt-security/projects/5
-          github-token: ${{ secrets.PROJECTS_SECRET }}

package/docs/defining-config.md

@@ -1,63 +0,0 @@
-# Defining module configuration
-
-As a module developer, you will likely have a number of user-configurable attributes for adjusting the functionality of your module. This is great from a user perspective as it allows customisation, but can introduce various bugs as a result of bad user input (missing or unexpected values etc.)
-
-The Adapt authoring tool's configuration module aims to pre-empt as many of these issues as possible through the use of configuration **schemas**, which can define the following:
-- Required attributes
-- Default values for optional attributes
-- Expected type for values (e.g. number, string, array)
-- Validation constraints (see JSON schema spec)
-
-## Defining module configuration
-_**Note**: it is not mandatory to include a config schema for your module, but it may help your general wellbeing/code neatness..._
-
-All that's needed to enable this feature is to include a `config.schema.json` to a directory named `conf` in the root of your module.
-
-This file must export a valid JSON object. See the JSON schema docs for more information.
-
-### Example configuration schema
-The below example shows a few common configuration use-cases:
-
-```json
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "requiredAttribute": {
-      "type": "Number",
-      "description": "This option is required"
-    },
-    "optionalAttribute": {
-      "type": "String",
-      "default": "This will be the default value",
-      "description": "An optional attribute with a default value"
-    },
-  },
-  "required": ["requiredAttribute"]
-}
-```
-
-## Directory paths
-
-It may be necessary to define directory paths in your config schema (e.g. the assets module defines an `uploadDir` attribute). To make this simpler from a developer _and_ user perspective, you can make use of the special `isDirectory` JSON schema keyword which will automatically populate the value with a number of global directory paths.
-
-If `isDirectory` is set in a config schema, the configuration module will look for the following keys and replace them with the corresponding `adapt-authoring-core` config values:
-
-- `$ROOT` -> `adapt-authoring-core.rootDir`
-- `$DATA` -> `adapt-authoring-core.dataDir`
-- `$TEMP` -> `adapt-authoring-core.tempDir`
-
-This allows the user to specify just the `dataDir` and `tempDir` attributes, and you can be safe in the knowledge that your config schema value will resolve to the correct location.
-
-See the following JSON schema snippet as an example:
-
-```json
-{
-  "uploadDir": {
-    "type": "String",
-    "description": "Temporary file upload directory for myplugin",
-    "isDirectory": true,
-    "default": "$TEMP/myfiles"
-  },
-}
-```