feat(#103): adds $jsModule parsing extension package

Author: joelgallant

.github/workflows/main.yml

@@ -41,6 +41,7 @@ jobs:
           ./app-config-generate/coverage/coverage-final.json,
           ./app-config-git/coverage/coverage-final.json,
           ./app-config-inject/coverage/coverage-final.json,
+          ./app-config-js/coverage/coverage-final.json,
           ./app-config-logging/coverage/coverage-final.json,
           ./app-config-main/coverage/coverage-final.json,
           ./app-config-meta/coverage/coverage-final.json,

.github/workflows/publishing.yml

@@ -76,6 +76,11 @@ jobs:
         token: ${{ secrets.NPM_TOKEN }}
         access: public
         package: ./app-config-inject/package.json
+    - uses: JS-DevTools/npm-publish@v1
+      with:
+        token: ${{ secrets.NPM_TOKEN }}
+        access: public
+        package: ./app-config-js/package.json
     - uses: JS-DevTools/npm-publish@v1
       with:
         token: ${{ secrets.NPM_TOKEN }}

app-config-js/.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('@lcdev/eslint-config/cwd')(__dirname);

app-config-js/README.md

@@ -0,0 +1,15 @@
+## App Config JS Module Loader
+
+This is a parsing extension to load arbitrary JavaScript code.
+
+Add to meta file:
+
+```yaml
+parsingExtensions:
+  - @app-config/js
+```
+
+The API of this module is documented via TypeScript definitions.
+
+Read the [Introduction](https://app-config.dev/guide/intro/) or
+[Quick Start](https://app-config.dev/guide/intro/quick-start/) guides on our website.

app-config-js/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@app-config/js",
+  "description": "Loads a JavaScript module to inject configuration",
+  "version": "2.2.0",
+  "license": "MPL-2.0",
+  "author": {
+    "name": "Launchcode",
+    "email": "[email protected]",
+    "url": "https://lc.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchcodedev/app-config.git"
+  },
+  "main": "dist/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist",
+    "!**/*.tsbuildinfo",
+    "!**/*.test.*"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "build:es": "tsc -b tsconfig.es.json",
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "lint": "eslint src",
+    "fix": "eslint --fix src",
+    "test": "jest",
+    "prepublishOnly": "yarn clean && yarn build && yarn build:es"
+  },
+  "dependencies": {
+    "@app-config/core": "^2.2.0",
+    "@app-config/extension-utils": "^2.2.0"
+  },
+  "devDependencies": {
+    "@app-config/test-utils": "^2.2.0"
+  },
+  "prettier": "@lcdev/prettier",
+  "jest": {
+    "preset": "@lcdev/jest"
+  }
+}

app-config-js/src/index.test.ts

@@ -0,0 +1,71 @@
+import { LiteralSource } from '@app-config/core';
+import { withTempFiles } from '@app-config/test-utils';
+import jsModuleDirective from './index';
+
+describe('$jsModule directive', () => {
+  it('loads function node export', () =>
+    withTempFiles(
+      {
+        'foo.js': `
+        module.exports = () => 'bar';
+      `,
+      },
+      async (inDir) => {
+        const source = new LiteralSource({
+          $jsModule: inDir('foo.js'),
+        });
+
+        expect(await source.readToJSON([jsModuleDirective()])).toEqual('bar');
+      },
+    ));
+
+  it('loads default function node export', () =>
+    withTempFiles(
+      {
+        'foo.js': `
+        module.exports.__esModule = true;
+        module.exports.default = () => 'bar';
+      `,
+      },
+      async (inDir) => {
+        const source = new LiteralSource({
+          $jsModule: inDir('foo.js'),
+        });
+
+        expect(await source.readToJSON([jsModuleDirective()])).toEqual('bar');
+      },
+    ));
+
+  it('loads object node export', () =>
+    withTempFiles(
+      {
+        'foo.js': `
+        module.exports = 'bar';
+      `,
+      },
+      async (inDir) => {
+        const source = new LiteralSource({
+          $jsModule: inDir('foo.js'),
+        });
+
+        expect(await source.readToJSON([jsModuleDirective()])).toEqual('bar');
+      },
+    ));
+
+  it('loads default object node export', () =>
+    withTempFiles(
+      {
+        'foo.js': `
+        module.exports.__esModule = true;
+        module.exports.default = 'bar';
+      `,
+      },
+      async (inDir) => {
+        const source = new LiteralSource({
+          $jsModule: inDir('foo.js'),
+        });
+
+        expect(await source.readToJSON([jsModuleDirective()])).toEqual('bar');
+      },
+    ));
+});

app-config-js/src/index.ts

@@ -0,0 +1,32 @@
+import { ParsingExtension } from '@app-config/core';
+import { forKey, validateOptions } from '@app-config/extension-utils';
+
+/* eslint-disable @typescript-eslint/no-unsafe-call */
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+/* eslint-disable @typescript-eslint/no-unsafe-member-access */
+
+export default function jsModuleDirective(): ParsingExtension {
+  return forKey(
+    '$jsModule',
+    validateOptions(
+      (SchemaBuilder) => SchemaBuilder.stringSchema(),
+      (value) => async (parse) => {
+        let loaded: any = await import(value);
+
+        if (!loaded) {
+          return parse(loaded, { shouldFlatten: true });
+        }
+
+        if ('default' in loaded) {
+          loaded = loaded.default;
+        }
+
+        if (typeof loaded === 'function') {
+          loaded = loaded();
+        }
+
+        return parse(loaded, { shouldFlatten: true });
+      },
+    ),
+  );
+}

app-config-js/tsconfig.es.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "es2020",
+    "outDir": "./dist/es"
+  }
+}

app-config-js/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "@lcdev/tsconfig",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"],
+  "references": [
+    { "path": "../app-config-test-utils" },
+    { "path": "../app-config-core" },
+    { "path": "../app-config-extension-utils" }
+  ]
+}