adapt-authoring-config 0.0.1 → 1.0.0

package/.eslintignore

@@ -1 +1 @@
-node_modules
+node_modules

package/.eslintrc

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

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,55 +1,55 @@
-name: Bug Report
-description: File a bug report
-labels: ["bug"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this bug report!
-  - type: textarea
-    id: description
-    attributes:
-      label: What happened?
-      description: Please describe the issue
-    validations:
-      required: true
-  - type: textarea
-    id: expected
-    attributes:
-      label: Expected behaviour
-      description: Tell us what should have happened
-  - type: textarea
-    id: repro-steps
-    attributes:
-      label: Steps to reproduce
-      description: Tell us how to reproduce the issue
-    validations:
-      required: true
-  - type: input
-    id: aat-version
-    attributes:
-      label: Authoring tool version
-      description: What version of the Adapt authoring tool are you running?
-    validations:
-      required: true
-  - type: input
-    id: fw-version
-    attributes:
-      label: Framework version
-      description: What version of the Adapt framework are you running?
-  - type: dropdown
-    id: browsers
-    attributes:
-      label: What browsers are you seeing the problem on?
-      multiple: true
-      options:
-        - Firefox
-        - Chrome
-        - Safari
-        - Microsoft Edge
-  - type: textarea
-    id: logs
-    attributes:
-      label: Relevant log output
-      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
-      render: sh
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: Please describe the issue
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: Tell us what should have happened
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to reproduce
+      description: Tell us how to reproduce the issue
+    validations:
+      required: true
+  - type: input
+    id: aat-version
+    attributes:
+      label: Authoring tool version
+      description: What version of the Adapt authoring tool are you running?
+    validations:
+      required: true
+  - type: input
+    id: fw-version
+    attributes:
+      label: Framework version
+      description: What version of the Adapt framework are you running?
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: sh

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,22 +1,22 @@
-name: Feature request
-description: Request a new feature
-labels: ["enhancement"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to request a new feature in the Adapt authoring tool! The Adapt team will consider all new feature requests, but unfortunately cannot commit to every one.
-  - type: textarea
-    id: description
-    attributes:
-      label: Feature description
-      description: Please describe your feature request
-    validations:
-      required: true
-  - type: checkboxes
-    id: contribute
-    attributes:
-      label: Can you work on this feature?
-      description: If you are able to commit your own time to work on this feature, it will greatly increase the liklihood of it being implemented by the core dev team. Otherwise, it will be triaged and prioritised alongside the core team's current priorities.
-      options:
-        - label: I can contribute
+name: Feature request
+description: Request a new feature
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to request a new feature in the Adapt authoring tool! The Adapt team will consider all new feature requests, but unfortunately cannot commit to every one.
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature description
+      description: Please describe your feature request
+    validations:
+      required: true
+  - type: checkboxes
+    id: contribute
+    attributes:
+      label: Can you work on this feature?
+      description: If you are able to commit your own time to work on this feature, it will greatly increase the liklihood of it being implemented by the core dev team. Otherwise, it will be triaged and prioritised alongside the core team's current priorities.
+      options:
+        - label: I can contribute

package/.github/dependabot.yml

@@ -1,11 +1,11 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
-version: 2
-updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/pull_request_template.md

@@ -1,25 +1,25 @@
-[//]: # (Please title your PR according to eslint commit conventions)
-[//]: # (See https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint#eslint-convention for details)
-
-[//]: # (Add a link to the original issue)
-
-[//]: # (Delete as appropriate)
-### Fix
-* A sentence describing each fix
-
-### Update
-* A sentence describing each udpate
-
-### New
-* A sentence describing each new feature
-
-### Breaking
-* A sentence describing each breaking change
-
-[//]: # (List appropriate steps for testing if needed)
-### Testing
-1. Steps for testing
-
-[//]: # (Mention any other dependencies)
-
-
+[//]: # (Please title your PR according to eslint commit conventions)
+[//]: # (See https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint#eslint-convention for details)
+
+[//]: # (Add a link to the original issue)
+
+[//]: # (Delete as appropriate)
+### Fix
+* A sentence describing each fix
+
+### Update
+* A sentence describing each udpate
+
+### New
+* A sentence describing each new feature
+
+### Breaking
+* A sentence describing each breaking change
+
+[//]: # (List appropriate steps for testing if needed)
+### Testing
+1. Steps for testing
+
+[//]: # (Mention any other dependencies)
+
+

package/.github/workflows/labelled_prs.yml

@@ -1,16 +1,16 @@
-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 }}
+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/.github/workflows/new.yml

@@ -1,19 +1,19 @@
-name: Add to main project
-
-on:
-  issues:
-    types:
-      - opened
-  pull_request:
-    types:
-      - opened
-
-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 }}
+name: Add to main project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+
+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 }}

package/.github/workflows/releases.yml

@@ -0,0 +1,25 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
+        run: npx semantic-release

package/README.md

@@ -1 +1 @@
-adapt-authoring-config
+adapt-authoring-config

package/adapt-authoring.json

@@ -1,12 +1,12 @@
-{
-  "essentialType": "config",
-  "documentation": {
-    "enable": true,
-    "manualPlugins": ["docs/plugins/configuration.js"],
-    "manualPages": {
-      "configuration.md": "reference",
-      "configure-environment.md": "getting-started",
-      "defining-config.md": "basics"
-    }
-  }
-}
+{
+  "essentialType": "config",
+  "documentation": {
+    "enable": true,
+    "manualPlugins": ["docs/plugins/configuration.js"],
+    "manualPages": {
+      "configuration.md": "reference",
+      "configure-environment.md": "getting-started",
+      "defining-config.md": "basics"
+    }
+  }
+}

package/artillery.yml

@@ -1,4 +1,4 @@
-scenarios:
-  - flow:
-    - get:
-        url: "/config"
+scenarios:
+  - flow:
+    - get:
+        url: "/config"

package/bin/confgen.js

@@ -1,132 +1,132 @@
-#!/usr/bin/env node
-/**
- * Generates a template config file which can be populated with required values.
- * @param {String} [environment] The enviroment to write the config for
- * @param {String} --defaults Will include default values
- * @param {String} --replace Will override any existing values
- * @param {String} --update Will update existing configuration with any missing values
- */
-import fs from 'fs/promises'
-import { globSync } from 'glob'
-import path from 'path'
-import { pathToFileURL } from 'url'
-import { Utils } from 'adapt-authoring-core'
-
-const {
-  defaults: useDefaults,
-  params: [env],
-  replace: replaceExisting,
-  update: updateExisting
-} = Utils.getArgs()
-const NODE_ENV = env || process.env.NODE_ENV
-const confDir = path.resolve(path.join(process.cwd(), 'conf'))
-const outpath = path.join(confDir, `${NODE_ENV}.config.js`)
-const configJson = {}
-
-async function init () {
-  if (!NODE_ENV) {
-    return console.log('ERROR: NODE_ENV must be specified\n')
-  }
-  if (replaceExisting && updateExisting) {
-    return console.log('ERROR: --update and --replace cannot both be specified, please choose one and run the utility again')
-  }
-  if (useDefaults) {
-    console.log('Default values will be included')
-  }
-  let isExistingConfig = false
-  let existingConfig
-  try {
-    existingConfig = (await import(pathToFileURL(outpath))).default
-    isExistingConfig = true
-  } catch (e) {
-    console.log(`No config found for NODE_ENV '${NODE_ENV}'. File will be written to ${outpath}\n`)
-  }
-  if (isExistingConfig) {
-    const msg = `Config already exists for NODE_ENV '${NODE_ENV}'. `
-    if (replaceExisting) {
-      console.log(`${msg}All existing values will be replaced.`)
-    } else if (updateExisting) {
-      console.log(`${msg}Any missing values will be added.`)
-      Object.assign(configJson, existingConfig)
-    } else {
-      return console.log(`${msg}Must specifiy --replace or --update to make changes.`)
-    }
-  }
-  try {
-    await generateConfig()
-    try {
-      await fs.mkdir(confDir, { recursive: true })
-    } catch (e) {
-      if (e.code !== 'EEXIST') throw e
-    }
-    await fs.writeFile(outpath, `export default ${JSON.stringify(configJson, null, 2)};`)
-
-    console.log(`Config file written successfully to ${outpath}.\n`)
-
-    logRequired()
-  } catch (e) {
-    console.log(`ERROR: Failed to write ${outpath}\n${e}`)
-  }
-}
-
-function logRequired () {
-  const requiredAttrs = []
-  Object.entries(configJson).forEach(([name, config]) => {
-    Object.entries(config).forEach(([key, value]) => value === null && requiredAttrs.push(`${name}.${key}`))
-  })
-  if (requiredAttrs.length) {
-    console.log('Note: the following required attributes have been given a value of null and must be set for the application to run:\n')
-    console.log(requiredAttrs.join('\n'))
-    console.log('')
-  }
-}
-
-async function getDeps () {
-  try {
-    const depRoot = `${process.cwd()}/node_modules/`.replaceAll(path.sep, path.posix.sep)
-    return globSync(`${depRoot}**/adapt-authoring.json`).map(f => {
-      const dirname = path.dirname(f)
-      return [dirname.replace(depRoot, ''), dirname]
-    })
-  } catch (e) {
-    console.log('Failed to load package', e)
-  }
-}
-
-async function generateConfig () {
-  await Promise.all((await getDeps()).map(async ([name, dir]) => {
-    let schema
-    try {
-      schema = schema = JSON.parse(await fs.readFile(path.resolve(dir, 'conf/config.schema.json')))
-    } catch (e) {
-      return
-    }
-    if (!configJson[name]) {
-      configJson[name] = {}
-    }
-    storeDefaults(schema, configJson[name])
-    // remove any empty objects
-    Object.entries(configJson).forEach(([key, config]) => !Object.keys(config).length && delete configJson[key])
-  }))
-}
-function storeDefaults (schema, defaults = {}) {
-  return Object.entries(schema.properties).reduce((memo, [attr, config]) => {
-    if (config.type === 'object' && config.properties) {
-      return { ...memo, [attr]: storeDefaults(config, memo) }
-    }
-    config.required = schema?.required?.includes(attr) ?? false
-    const shouldUpdate = replaceExisting || !Object.prototype.hasOwnProperty.call(memo, attr)
-    const useDefault = useDefaults && Object.prototype.hasOwnProperty.call(config, 'default')
-    if (shouldUpdate && (useDefault || config.required)) {
-      memo[attr] = getValueForAttr(config)
-    }
-    return memo
-  }, defaults)
-}
-
-function getValueForAttr (config) {
-  if (config.required) return null
-  if (Object.prototype.hasOwnProperty.call(config, 'default')) return config.default
-}
-
-init()
+#!/usr/bin/env node
+/**
+ * Generates a template config file which can be populated with required values.
+ * @param {String} [environment] The enviroment to write the config for
+ * @param {String} --defaults Will include default values
+ * @param {String} --replace Will override any existing values
+ * @param {String} --update Will update existing configuration with any missing values
+ */
+import fs from 'fs/promises'
+import { globSync } from 'glob'
+import path from 'path'
+import { pathToFileURL } from 'url'
+import { Utils } from 'adapt-authoring-core'
+
+const {
+  defaults: useDefaults,
+  params: [env],
+  replace: replaceExisting,
+  update: updateExisting
+} = Utils.getArgs()
+const NODE_ENV = env || process.env.NODE_ENV
+const confDir = path.resolve(path.join(process.cwd(), 'conf'))
+const outpath = path.join(confDir, `${NODE_ENV}.config.js`)
+const configJson = {}
+
+async function init () {
+  if (!NODE_ENV) {
+    return console.log('ERROR: NODE_ENV must be specified\n')
+  }
+  if (replaceExisting && updateExisting) {
+    return console.log('ERROR: --update and --replace cannot both be specified, please choose one and run the utility again')
+  }
+  if (useDefaults) {
+    console.log('Default values will be included')
+  }
+  let isExistingConfig = false
+  let existingConfig
+  try {
+    existingConfig = (await import(pathToFileURL(outpath))).default
+    isExistingConfig = true
+  } catch (e) {
+    console.log(`No config found for NODE_ENV '${NODE_ENV}'. File will be written to ${outpath}\n`)
+  }
+  if (isExistingConfig) {
+    const msg = `Config already exists for NODE_ENV '${NODE_ENV}'. `
+    if (replaceExisting) {
+      console.log(`${msg}All existing values will be replaced.`)
+    } else if (updateExisting) {
+      console.log(`${msg}Any missing values will be added.`)
+      Object.assign(configJson, existingConfig)
+    } else {
+      return console.log(`${msg}Must specifiy --replace or --update to make changes.`)
+    }
+  }
+  try {
+    await generateConfig()
+    try {
+      await fs.mkdir(confDir, { recursive: true })
+    } catch (e) {
+      if (e.code !== 'EEXIST') throw e
+    }
+    await fs.writeFile(outpath, `export default ${JSON.stringify(configJson, null, 2)};`)
+
+    console.log(`Config file written successfully to ${outpath}.\n`)
+
+    logRequired()
+  } catch (e) {
+    console.log(`ERROR: Failed to write ${outpath}\n${e}`)
+  }
+}
+
+function logRequired () {
+  const requiredAttrs = []
+  Object.entries(configJson).forEach(([name, config]) => {
+    Object.entries(config).forEach(([key, value]) => value === null && requiredAttrs.push(`${name}.${key}`))
+  })
+  if (requiredAttrs.length) {
+    console.log('Note: the following required attributes have been given a value of null and must be set for the application to run:\n')
+    console.log(requiredAttrs.join('\n'))
+    console.log('')
+  }
+}
+
+async function getDeps () {
+  try {
+    const depRoot = `${process.cwd()}/node_modules/`.replaceAll(path.sep, path.posix.sep)
+    return globSync(`${depRoot}**/adapt-authoring.json`).map(f => {
+      const dirname = path.dirname(f)
+      return [dirname.replace(depRoot, ''), dirname]
+    })
+  } catch (e) {
+    console.log('Failed to load package', e)
+  }
+}
+
+async function generateConfig () {
+  await Promise.all((await getDeps()).map(async ([name, dir]) => {
+    let schema
+    try {
+      schema = schema = JSON.parse(await fs.readFile(path.resolve(dir, 'conf/config.schema.json')))
+    } catch (e) {
+      return
+    }
+    if (!configJson[name]) {
+      configJson[name] = {}
+    }
+    storeDefaults(schema, configJson[name])
+    // remove any empty objects
+    Object.entries(configJson).forEach(([key, config]) => !Object.keys(config).length && delete configJson[key])
+  }))
+}
+function storeDefaults (schema, defaults = {}) {
+  return Object.entries(schema.properties).reduce((memo, [attr, config]) => {
+    if (config.type === 'object' && config.properties) {
+      return { ...memo, [attr]: storeDefaults(config, memo) }
+    }
+    config.required = schema?.required?.includes(attr) ?? false
+    const shouldUpdate = replaceExisting || !Object.prototype.hasOwnProperty.call(memo, attr)
+    const useDefault = useDefaults && Object.prototype.hasOwnProperty.call(config, 'default')
+    if (shouldUpdate && (useDefault || config.required)) {
+      memo[attr] = getValueForAttr(config)
+    }
+    return memo
+  }, defaults)
+}
+
+function getValueForAttr (config) {
+  if (config.required) return null
+  if (Object.prototype.hasOwnProperty.call(config, 'default')) return config.default
+}
+
+init()