feat(#43): adds yargs package for parsing CLI parameters

Author: joelgallant

.github/workflows/publishing.yml

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

app-config-yargs/.eslintrc.js

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

app-config-yargs/README.md

@@ -0,0 +1,45 @@
+{
+  "name": "@app-config/yargs",
+  "description": "Command line parsing for @app-config from yargs",
+  "version": "2.4.4",
+  "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.4.4",
+    "@app-config/extension-utils": "^2.4.4",
+    "@app-config/utils": "^2.4.4",
+    "yargs": "16"
+  },
+  "devDependencies": {
+    "@app-config/test-utils": "^2.4.4"
+  },
+  "prettier": "@lcdev/prettier",
+  "jest": {
+    "preset": "@lcdev/jest"
+  }
+}

app-config-yargs/package.json

@@ -0,0 +1,25 @@
+import yargs from 'yargs';
+import { defaultEnvExtensions, defaultExtensions, loadUnvalidatedConfig } from '@app-config/main';
+import yargsParsingExtension from './index';
+
+const makeOptions = (argv: string[]) => ({
+  environmentExtensions: defaultEnvExtensions().concat(yargsParsingExtension({ argv })),
+  parsingExtensions: defaultExtensions().concat(yargsParsingExtension({ argv })),
+});
+
+beforeEach(() => {
+  yargs.reset();
+});
+
+describe('yargsParsingExtension', () => {
+  it('loads an argument', async () => {
+    process.env.APP_CONFIG = `
+      foo:
+        $yargs: foo
+    `;
+
+    const { fullConfig } = await loadUnvalidatedConfig(makeOptions(['--foo=bar']));
+
+    expect(fullConfig).toEqual({ foo: 'bar' });
+  });
+});

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

@@ -0,0 +1,30 @@
+import { forKey, validateOptions } from '@app-config/extension-utils';
+import { ParsingExtension, AppConfigError } from '@app-config/core';
+import { Json } from '@app-config/utils';
+import yargs from 'yargs';
+
+interface Options {
+  argv?: string[];
+}
+
+function yargsParsingExtension({
+  argv = process.argv,
+}: Options = {}): ParsingExtension {
+  const args = yargs.parse(argv);
+
+  return forKey(
+    '$yargs',
+    validateOptions(
+      (SchemaBuilder) => SchemaBuilder.stringSchema(),
+      (value) => async (parse) => {
+        if (value in args) {
+          return parse(args[value] as Json, { shouldFlatten: true });
+        }
+
+        throw new AppConfigError(`Tried to use CLI arg named '${value}' but it was not found`);
+      },
+    ),
+  );
+}
+
+export default yargsParsingExtension;

app-config-yargs/src/index.ts

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

app-config-yargs/tsconfig.es.json

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

app-config-yargs/tsconfig.json

@@ -62,6 +62,7 @@ new_version app-config-utils
 new_version app-config-v1-compat
 new_version app-config-vault
 new_version app-config-webpack
+new_version app-config-yargs
 new_version lcdev-app-config
 new_version lcdev-app-config-inject
 new_version lcdev-app-config-webpack-plugin