Merge pull request #176 from launchcodedev/esbuild-plugin

esbuild plugin v1

Author: joelgallant

.github/workflows/main.yml

@@ -34,8 +34,9 @@ jobs:
       env: { CI: 1 }
       if: matrix.os != 'ubuntu-latest'
 
-    # sanity check that the rollup plugin made a file without needing to loadConfig
+    # sanity check that plugins made a file without needing to loadConfig
     - run: yarn --cwd ./examples/rollup-project start
+    - run: yarn --cwd ./examples/esbuild-project start
 
     - uses: codecov/codecov-action@v1
       if: matrix.os == 'ubuntu-latest'

.github/workflows/publishing.yml

@@ -166,6 +166,12 @@ jobs:
         token: ${{ secrets.NPM_TOKEN }}
         access: public
         package: ./app-config-vite/package.json
+    - name: app-config-esbuild
+      uses: JS-DevTools/npm-publish@v1
+      with:
+        token: ${{ secrets.NPM_TOKEN }}
+        access: public
+        package: ./app-config-esbuild/package.json
     - name: lcdev-app-config-inject
       uses: JS-DevTools/npm-publish@v1
       with:

app-config-config/src/index.ts

@@ -16,6 +16,7 @@ import {
   EnvironmentAliases,
   EnvironmentSource,
   asEnvOptions,
+  currentEnvironment,
 } from '@app-config/node';
 import { markAllValuesAsSecret } from '@app-config/extensions';
 import { defaultExtensions, defaultEnvExtensions } from '@app-config/default-extensions';
@@ -44,6 +45,8 @@ export interface LoadedConfiguration {
   parsed: ParsedValue;
   parsedSecrets?: ParsedValue;
   parsedNonSecrets?: ParsedValue;
+  /** the current environment that was loaded from given options */
+  environment?: string;
   /** non-exhaustive list of files that were read (useful for reloading in plugins) */
   filePaths?: string[];
   /** if loadValidatedConfig, this is the normalized JSON schema that was used for validation */
@@ -79,7 +82,18 @@ export async function loadUnvalidatedConfig({
 
     verifyParsedValue(parsed);
 
-    return { parsed, fullConfig: parsed.toJSON() };
+    return {
+      parsed,
+      fullConfig: parsed.toJSON(),
+      // NOTE: not checking meta values here
+      environment: currentEnvironment(
+        asEnvOptions(
+          environmentOverride,
+          environmentAliasesArg ?? defaultAliases,
+          environmentSourceNamesArg,
+        ),
+      ),
+    };
   } catch (error) {
     // having no APP_CONFIG environment variable is normal, and should fall through to reading files
     if (!NotFoundError.isNotFoundError(error)) throw error;
@@ -186,6 +200,7 @@ export async function loadUnvalidatedConfig({
     parsed,
     parsedSecrets: secrets,
     parsedNonSecrets: mainConfig.cloneWhere((v) => !v.meta.fromSecrets),
+    environment: currentEnvironment(environmentOptions),
     fullConfig: parsed.toJSON(),
     filePaths: Array.from(filePaths),
   };

app-config-esbuild/.eslintrc.js

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

app-config-esbuild/README.md

@@ -0,0 +1,28 @@
+## App Config esbuild
+
+Use app-config with esbuild.
+
+Install:
+
+```sh
+yarn add -D @app-config/esbuild
+```
+
+Then add it to your esbuild configuration:
+
+```javascript
+const { createPlugin: appConfig } = require('@app-config/esbuild');
+
+require('esbuild')
+  .build({
+    bundle: true,
+    entryPoints: ['./src/index.ts'],
+    outfile: './dist/index.js',
+    // this is the line we care about
+    plugins: [appConfig()],
+  })
+  .catch(() => process.exit(1));
+```
+
+This will allow you to import `@app-config/main` from your application, with all
+filesystem and other Node.js code stripped out (when using `bundle`).

app-config-esbuild/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@app-config/esbuild",
+  "description": "esbuild module resolution support for @app-config",
+  "version": "2.7.2",
+  "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/config": "^2.7.2",
+    "@app-config/utils": "^2.7.2"
+  },
+  "devDependencies": {
+    "@app-config/test-utils": "^2.7.2",
+    "esbuild": "0.13"
+  },
+  "prettier": "@lcdev/prettier",
+  "jest": {
+    "preset": "@lcdev/jest"
+  }
+}

app-config-esbuild/src/__snapshots__/index.test.ts.snap

@@ -0,0 +1,16 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`loads config correctly 1`] = `
+"(()=>{var r={foo:\\"bar\\"},e=(typeof window==\\"undefined\\"?globalThis:window)||{},t=e._appConfig||r;(typeof e._appConfig==\\"undefined\\"||!Object.isFrozen(e._appConfig))&&(e._appConfig=t);var a=t;console.log(a);})();
+"
+`;
+
+exports[`loads currentEnvironment 1`] = `
+"(()=>{var t={foo:\\"bar\\"},e=(typeof window==\\"undefined\\"?globalThis:window)||{},r=e._appConfig||t;(typeof e._appConfig==\\"undefined\\"||!Object.isFrozen(e._appConfig))&&(e._appConfig=r);function o(){return\\"test\\"}console.log(o());})();
+"
+`;
+
+exports[`loads validation function 1`] = `
+"(()=>{var v={foo:\\"bar\\"},n=(typeof window==\\"undefined\\"?globalThis:window)||{},m=n._appConfig||v;(typeof n._appConfig==\\"undefined\\"||!Object.isFrozen(n._appConfig))&&(n._appConfig=m);function P(){let s={};return function(p){\\"use strict\\";p.exports=i,p.exports.default=i;var b={type:\\"object\\",additionalProperties:!1,properties:{foo:{type:\\"string\\"}},$schema:\\"http://json-schema.org/draft-07/schema#\\"};function i(o,t){\\"use strict\\";if(t)var a=t.dataPath,g=t.parentData,h=t.parentDataProperty,y=t.rootData;else var a=\\"\\",g=void 0,h=void 0,y=o;var e=null,r=0;if(o&&typeof o==\\"object\\"&&!Array.isArray(o)){for(var f in o)if(f!==\\"foo\\"){var d={keyword:\\"additionalProperties\\",dataPath:a,schemaPath:\\"#/additionalProperties\\",params:{additionalProperty:f},message:\\"should NOT have additional properties\\"};e===null?e=[d]:e.push(d),r++}if(o.foo!==void 0&&typeof o.foo!=\\"string\\"){var l={keyword:\\"type\\",dataPath:a+\\"/foo\\",schemaPath:\\"#/properties/foo/type\\",params:{type:\\"string\\"},message:\\"should be string\\"};e===null?e=[l]:e.push(l),r++}}else{var c={keyword:\\"type\\",dataPath:a,schemaPath:\\"#/type\\",params:{type:\\"object\\"},message:\\"should be object\\"};e===null?e=[c]:e.push(c),r++}return i.errors=e,r===0}}(s),s.exports}var u=P();u({foo:12});})();
+"
+`;

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

@@ -0,0 +1,123 @@
+import { withTempFiles } from '@app-config/test-utils';
+import { build } from 'esbuild';
+import createPlugin from './index';
+
+it('loads config correctly', () =>
+  withTempFiles(
+    {
+      '.app-config.schema.yml': `
+        type: object
+        additionalProperties: true
+      `,
+      '.app-config.yml': `
+        foo: bar
+      `,
+      'a.js': `
+        import config from '@app-config/main';
+        console.log(config);
+      `,
+    },
+    async (inDir) => {
+      const res = await build({
+        entryPoints: [inDir('a.js')],
+        plugins: [createPlugin({ loadingOptions: { directory: inDir('.') } })],
+        bundle: true,
+        minify: true,
+        write: false,
+      });
+
+      expect(res.outputFiles[0].text).toMatchSnapshot();
+    },
+  ));
+
+it('fails when config is incorrect', () =>
+  withTempFiles(
+    {
+      '.app-config.schema.yml': `
+        type: object
+        additionalProperties: false
+      `,
+      '.app-config.yml': `
+        foo: bar
+      `,
+      'a.js': `
+        import config from '@app-config/main';
+        console.log(config);
+      `,
+    },
+    async (inDir) => {
+      await expect(
+        build({
+          entryPoints: [inDir('a.js')],
+          plugins: [createPlugin({ loadingOptions: { directory: inDir('.') } })],
+          bundle: true,
+          minify: true,
+          write: false,
+        }),
+      ).rejects.toThrow(
+        'error: [plugin: @app-config/esbuild] Config is invalid: config should NOT have additional properties',
+      );
+    },
+  ));
+
+it('loads validation function', () =>
+  withTempFiles(
+    {
+      '.app-config.schema.yml': `
+        type: object
+        additionalProperties: false
+        properties:
+          foo: { type: string }
+      `,
+      '.app-config.yml': `
+        foo: bar
+      `,
+      'a.js': `
+        import { validateConfig } from '@app-config/main';
+
+        validateConfig({ foo: 12 })
+      `,
+    },
+    async (inDir) => {
+      const res = await build({
+        entryPoints: [inDir('a.js')],
+        plugins: [createPlugin({ loadingOptions: { directory: inDir('.') } })],
+        bundle: true,
+        minify: true,
+        write: false,
+      });
+
+      expect(res.outputFiles[0].text).toMatchSnapshot();
+    },
+  ));
+
+it('loads currentEnvironment', () =>
+  withTempFiles(
+    {
+      '.app-config.schema.yml': `
+        type: object
+        additionalProperties: false
+        properties:
+          foo: { type: string }
+      `,
+      '.app-config.yml': `
+        foo: bar
+      `,
+      'a.js': `
+        import { currentEnvironment } from '@app-config/main';
+
+        console.log(currentEnvironment())
+      `,
+    },
+    async (inDir) => {
+      const res = await build({
+        entryPoints: [inDir('a.js')],
+        plugins: [createPlugin({ loadingOptions: { directory: inDir('.') } })],
+        bundle: true,
+        minify: true,
+        write: false,
+      });
+
+      expect(res.outputFiles[0].text).toMatchSnapshot();
+    },
+  ));

app-config-esbuild/src/index.ts

@@ -0,0 +1,48 @@
+import type { Plugin } from 'esbuild';
+import path from 'path';
+import { ConfigLoadingOptions, loadValidatedConfig } from '@app-config/config';
+import { generateModuleText, packageNameRegex } from '@app-config/utils';
+import type { SchemaLoadingOptions } from '@app-config/schema';
+
+export interface Options {
+  useGlobalNamespace?: boolean;
+  loadingOptions?: ConfigLoadingOptions;
+  schemaLoadingOptions?: SchemaLoadingOptions;
+  injectValidationFunction?: boolean;
+}
+
+export const createPlugin = ({
+  useGlobalNamespace = true,
+  loadingOptions,
+  schemaLoadingOptions,
+  injectValidationFunction = true,
+}: Options = {}): Plugin => ({
+  name: '@app-config/esbuild',
+  setup(build) {
+    build.onResolve({ filter: packageNameRegex }, (args) => ({
+      path: args.path,
+      namespace: '@app-config/esbuild',
+    }));
+
+    build.onLoad({ filter: /.*/, namespace: '@app-config/esbuild' }, async () => {
+      const { fullConfig, environment, validationFunctionCode, filePaths } =
+        await loadValidatedConfig(loadingOptions, schemaLoadingOptions);
+
+      const code = generateModuleText(fullConfig, {
+        environment,
+        useGlobalNamespace,
+        validationFunctionCode: injectValidationFunction ? validationFunctionCode : undefined,
+        esmValidationCode: true,
+      });
+
+      return {
+        loader: 'js',
+        contents: code,
+        resolveDir: path.parse(process.cwd()).root,
+        watchFiles: filePaths,
+      };
+    });
+  },
+});
+
+export default createPlugin;

app-config-esbuild/tsconfig.es.json

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