@mittwald/cli 1.13.5 → 1.14.0

package/dist/commands/context/get.js

@@ -18,6 +18,8 @@ const ContextSourceValue = ({ source }) => {
             return (_jsx(ContextSourceKnownValue, { name: "terraform state file", source: source, relative: true }));
         case "ddev":
             return (_jsx(ContextSourceKnownValue, { name: "DDEV configuration", source: source, relative: true }));
+        case "dotfile":
+            return (_jsx(ContextSourceKnownValue, { name: ".mw-context.json", source: source, relative: true }));
         default:
             return _jsx(ContextSourceUnknown, {});
     }
@@ -37,6 +39,7 @@ const GetContext = ({ ctx }) => {
     const values = {};
     let hasTerraformSource = false;
     let hasDDEVSource = false;
+    let hasDotfileSource = false;
     for (const key of [
         "project-id",
         "server-id",
@@ -51,6 +54,7 @@ const GetContext = ({ ctx }) => {
             hasTerraformSource =
                 hasTerraformSource || value.source.type === "terraform";
             hasDDEVSource = hasDDEVSource || value.source.type === "ddev";
+            hasDotfileSource = hasDotfileSource || value.source.type === "dotfile";
         }
         else {
             rows[`--${key}`] = _jsx(Value, { notSet: true });
@@ -59,10 +63,11 @@ const GetContext = ({ ctx }) => {
     if (renderAsJson) {
         return _jsx(RenderJson, { name: "context", data: values });
     }
-    return (_jsxs(Box, { flexDirection: "column", children: [_jsx(Box, { marginBottom: 1, children: _jsx(SingleResult, { title: "Current CLI context", rows: rows }) }), hasTerraformSource && _jsx(TerraformHint, {}), hasDDEVSource && _jsx(DDEVHint, {}), _jsx(ContextSetHint, {})] }));
+    return (_jsxs(Box, { flexDirection: "column", children: [_jsx(Box, { marginBottom: 1, children: _jsx(SingleResult, { title: "Current CLI context", rows: rows }) }), hasTerraformSource && _jsx(TerraformHint, {}), hasDDEVSource && _jsx(DDEVHint, {}), hasDotfileSource && _jsx(DotfileHint, {}), _jsx(ContextSetHint, {})] }));
 };
 const TerraformHint = () => (_jsx(Note, { marginBottom: 1, children: "You are in a directory that contains a terraform state file; some of the context values were read from there." }));
 const DDEVHint = () => (_jsx(Note, { marginBottom: 1, children: "You are in a directory that contains a DDEV project; some of the context values were read from there." }));
+const DotfileHint = () => (_jsx(Note, { marginBottom: 1, children: "You are in a directory that contains a .mw-context.json file; some of the context values were read from there." }));
 const ContextSetHint = () => (_jsxs(Note, { marginBottom: 1, children: ["Use the ", _jsx(Value, { children: "mw context set" }), " command to set one of the values listed above."] }));
 export class Get extends RenderBaseCommand {
     static summary = "Print an overview of currently set context parameters";

package/dist/lib/context/Context.js

@@ -1,6 +1,7 @@
 import UserContextProvider from "./UserContextProvider.js";
 import TerraformContextProvider from "./TerraformContextProvider.js";
 import DDEVContextProvider from "./DDEVContextProvider.js";
+import DotfileContextProvider from "./DotfileContextProvider.js";
 import InvalidContextError from "../error/InvalidContextError.js";
 function isWritable(p) {
     return "update" in p;
@@ -17,6 +18,7 @@ export default class Context {
             new UserContextProvider(config),
             new TerraformContextProvider(),
             new DDEVContextProvider(apiClient),
+            new DotfileContextProvider(),
         ];
         this.opts = {
             onInitError(err) {

package/dist/lib/context/DotfileContextProvider.d.ts

@@ -0,0 +1,26 @@
+import { ContextMap } from "./Context.js";
+import ContextProvider from "./ContextProvider.js";
+/**
+ * DotfileContextProvider is a ContextProvider that reads context overrides from
+ * a local .mw-context.json file; it looks for the file in the current working
+ * directory or any of its parent directories.
+ *
+ * The file format is a simple JSON object mapping context keys to string
+ * values, e.g.:
+ *
+ * ```json
+ * {
+ *   "project-id": "p-xxxxx",
+ *   "server-id": "s-xxxxx"
+ * }
+ * ```
+ */
+export default class DotfileContextProvider implements ContextProvider {
+    readonly name = "dotfile";
+    getOverrides(): Promise<ContextMap>;
+    /**
+     * Find the .mw-context.json file in the current working directory or any of
+     * its parent directories.
+     */
+    private findDotfile;
+}

package/dist/lib/context/DotfileContextProvider.js

@@ -0,0 +1,63 @@
+import fs from "fs/promises";
+import { cwd } from "process";
+import path from "path";
+import { pathExists } from "../util/fs/pathExists.js";
+import InvalidContextError from "../error/InvalidContextError.js";
+const dotfileName = ".mw-context.json";
+/**
+ * DotfileContextProvider is a ContextProvider that reads context overrides from
+ * a local .mw-context.json file; it looks for the file in the current working
+ * directory or any of its parent directories.
+ *
+ * The file format is a simple JSON object mapping context keys to string
+ * values, e.g.:
+ *
+ * ```json
+ * {
+ *   "project-id": "p-xxxxx",
+ *   "server-id": "s-xxxxx"
+ * }
+ * ```
+ */
+export default class DotfileContextProvider {
+    name = "dotfile";
+    async getOverrides() {
+        const file = await this.findDotfile();
+        if (!file) {
+            return {};
+        }
+        const contents = await fs.readFile(file, "utf-8");
+        let parsed;
+        try {
+            parsed = JSON.parse(contents);
+        }
+        catch (err) {
+            throw new InvalidContextError(`error while parsing ${file}: ${err}`, {
+                cause: err,
+            });
+        }
+        const source = { type: "dotfile", identifier: file };
+        const overrides = {};
+        for (const [key, value] of Object.entries(parsed)) {
+            if (typeof value === "string") {
+                overrides[key] = { value, source };
+            }
+        }
+        return overrides;
+    }
+    /**
+     * Find the .mw-context.json file in the current working directory or any of
+     * its parent directories.
+     */
+    async findDotfile() {
+        let currentDir = cwd();
+        while (currentDir !== path.dirname(currentDir)) {
+            const dotfile = path.join(currentDir, dotfileName);
+            if (await pathExists(dotfile)) {
+                return dotfile;
+            }
+            currentDir = path.dirname(currentDir);
+        }
+        return undefined;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mittwald/cli",
-  "version": "1.13.5",
+  "version": "1.14.0",
   "description": "Hand-crafted CLI for the mittwald API",
   "license": "MIT",
   "repository": {