pepr 0.1.41 → 0.1.42

package/dist/package.json

@@ -9,7 +9,7 @@
     "engines": {
         "node": ">=18.0.0"
     },
-    "version": "0.1.41",
+    "version": "0.1.42",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "pepr": {
@@ -24,7 +24,8 @@
         }
     },
     "scripts": {
-        "build": "rm -fr dist/* && tsc -p tsconfig.build.json",
+        "prebuild": "rm -fr dist/* && node hack/build-template-data.js",
+        "build": "tsc -p tsconfig.build.json",
         "test": "npm run build && ava && node dist/cli.js -V",
         "lint": "npx eslint src",
         "lint:fix": "npm run lint -- --fix",

package/dist/src/cli/index.js

@@ -8,12 +8,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const package_json_1 = require("../../package.json");
 const banner_1 = require("./banner");
 const build_1 = __importDefault(require("./build"));
-const capability_1 = __importDefault(require("./capability"));
 const deploy_1 = __importDefault(require("./deploy"));
 const dev_1 = __importDefault(require("./dev"));
 const init_1 = __importDefault(require("./init"));
 const root_1 = require("./root");
-const test_1 = __importDefault(require("./test"));
 const program = new root_1.RootCmd();
 program
     .version(package_json_1.version)
@@ -29,6 +27,6 @@ program
 (0, deploy_1.default)(program);
 (0, dev_1.default)(program);
 // @todo: finish/re-evaluate these commands
-(0, test_1.default)(program);
-(0, capability_1.default)(program);
+// test(program);
+// capability(program);
 program.parse();

package/dist/src/cli/init/templates/data.json

@@ -0,0 +1 @@
+{ "gitignore": "# Ignore node_modules and Pepr build artifacts\nnode_modules\ndist\ninsecure*\n", "readme": "# Pepr Module\n\nThis is a Pepr Module. [Pepr](https://github.com/defenseunicorns/pepr) is a Kubernetes tranformation system\nwritten in Typescript.\n\nThe `capabilities` directory contains all the capabilities for this module. By default,\na capability is a single typescript file in the format of `capability-name.ts` that is\nimported in the root `pepr.ts` file as `import { HelloPepr } from \"./capabilities/hello-pepr\";`.\nBecause this is typescript, you can organize this however you choose, e.g. creating a sub-folder\nper-capability or common logic in shared files or folders.\n\nExample Structure:\n\n```\nModule Root\n├── package.json\n├── pepr.ts\n└── capabilities\n    ├── example-one.ts\n    ├── example-three.ts\n    └── example-two.ts\n```\n", "peprTS": "import { PeprModule } from \"pepr\";\nimport { HelloPepr } from \"./capabilities/hello-pepr\";\nimport cfg from \"./package.json\";\n\n/**\n * This is the main entrypoint for the Pepr module. It is the file that is run when the module is started.\n * This is where you register your configurations and capabilities with the module.\n */\nnew PeprModule(cfg, [\n  // \"HelloPepr\" is a demo capability that is included with Pepr. You can remove it if you want.\n  HelloPepr,\n\n  // Your additional capabilities go here\n]);\n", "helloPeprTS": "import { Capability, a } from \"pepr\";\n\n/**\n *  The HelloPepr Capability is an example capability to demonstrate some general concepts of Pepr.\n *  To test this capability you can run `pepr dev` or `npm start` and then run the following command:\n *  `kubectl apply -f capabilities/hello-pepr.samples.yaml`\n */\nexport const HelloPepr = new Capability({\n  name: \"hello-pepr\",\n  description: \"A simple example capability to show how things work.\",\n  namespaces: [\"pepr-demo\"],\n});\n\n// Use the 'When' function to create a new Capability Action\nconst { When } = HelloPepr;\n\n/**\n * This is a single Capability Action. They can be in the same file or imported from other files.\n * In this exmaple, when a ConfigMap is created with the name `example-1`, we add a label and annotation.\n *\n * Equivelant to manually running:\n * `kubectl label configmap example-1 pepr=was-here`\n * `kubectl annotate configmap example-1 pepr.dev=annotations-work-too`\n */\nWhen(a.ConfigMap)\n  .IsCreated()\n  .WithName(\"example-1\")\n  .Then(request => {\n    request.SetLabel(\"pepr\", \"was-here\").SetAnnotation(\"pepr.dev\", \"annotations-work-too\");\n  });\n\n/**\n * This Capabiility Action does the exact same changes for example-2, except this time it uses the `.ThenSet()` feature.\n * You can stack multiple `.Then()` calls, but only a single `.ThenSet()`\n */\nWhen(a.ConfigMap)\n  .IsCreated()\n  .WithName(\"example-2\")\n  .ThenSet({\n    metadata: {\n      labels: {\n        pepr: \"was-here\",\n      },\n      annotations: {\n        \"pepr.dev\": \"annotations-work-too\",\n      },\n    },\n  });\n\n/**\n * This Capability Action combines different styles. Unlike the previous actions, this one will look for any ConfigMap\n * in the `pepr-demo` namespace that has the label `change=by-label` during either CREATE or UPDATE. Note that all\n * conditions added such as `WithName()`, `WithLabel()`, `InNamespace()`, are ANDs so all conditions must be true\n * for the request to be procssed.\n */\nWhen(a.ConfigMap)\n  .IsCreatedOrUpdated()\n  .WithLabel(\"change\", \"by-label\")\n  .Then(request => {\n    // The K8s object e are going to mutate\n    const cm = request.Raw;\n\n    // Get the username and uid of the K8s reuest\n    const { username, uid } = request.Request.userInfo;\n\n    // Store some data about the request in the configmap\n    cm.data[\"username\"] = username;\n    cm.data[\"uid\"] = uid;\n\n    // You can still mix other ways of making changes too\n    request.SetAnnotation(\"pepr.dev\", \"making-waves\");\n  });\n" }

package/dist/src/cli/init/templates/pepr.code-snippets.json

@@ -0,0 +1,21 @@
+{
+    "Create a new Pepr capability": {
+        "prefix": "create pepr capability",
+        "body": [
+            "import { Capability, a } from 'pepr';",
+            "",
+            "export const ${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/} = new Capability({",
+            "\tname: '${TM_FILENAME_BASE}',",
+            "\tdescription: '${1:A brief description of this capability.}',",
+            "\tnamespaces: [${2:}],",
+            "});",
+            "",
+            "// Use the 'When' function to create a new Capability Action",
+            "const { When } = ${TM_FILENAME_BASE/(.*)/${1:/pascalcase}/};",
+            "",
+            "// When(a.<Kind>).Is<Event>().Then(change => change.<changes>",
+            "When(${3:})"
+        ],
+        "description": "Creates a new Pepr capability with a specified description, and optional namespaces, and adds a When statement for the specified value."
+    }
+}

package/dist/src/cli/init/templates/prettierrc.json

@@ -0,0 +1,13 @@
+{
+    "arrowParens": "avoid",
+    "bracketSameLine": false,
+    "bracketSpacing": true,
+    "embeddedLanguageFormatting": "auto",
+    "insertPragma": false,
+    "printWidth": 80,
+    "quoteProps": "as-needed",
+    "requirePragma": false,
+    "semi": true,
+    "tabWidth": 2,
+    "useTabs": false
+}

package/dist/src/cli/init/templates/samples.json

@@ -0,0 +1,45 @@
+[
+    {
+        "apiVersion": "v1",
+        "kind": "Namespace",
+        "metadata": {
+            "name": "pepr-demo"
+        }
+    },
+    {
+        "apiVersion": "v1",
+        "kind": "ConfigMap",
+        "metadata": {
+            "name": "example-1",
+            "namespace": "pepr-demo"
+        },
+        "data": {
+            "key": "ex-1-val"
+        }
+    },
+    {
+        "apiVersion": "v1",
+        "kind": "ConfigMap",
+        "metadata": {
+            "name": "example-2",
+            "namespace": "pepr-demo"
+        },
+        "data": {
+            "key": "ex-2-val"
+        }
+    },
+    {
+        "apiVersion": "v1",
+        "kind": "ConfigMap",
+        "metadata": {
+            "name": "example-3",
+            "namespace": "pepr-demo",
+            "labels": {
+                "change": "by-label"
+            }
+        },
+        "data": {
+            "key": "ex-3-val"
+        }
+    }
+]

package/dist/src/cli/init/templates.d.ts

@@ -1,8 +1,4 @@
 import { InitOptions } from "./walkthrough";
-export declare function genPeprTS(): {
-    path: string;
-    data: string;
-};
 export declare function genPkgJSON(opts: InitOptions): {
     data: {
         name: string;
@@ -20,6 +16,7 @@ export declare function genPkgJSON(opts: InitOptions): {
             };
         };
         scripts: {
+            "k3d-setup": string;
             build: string;
             start: string;
         };
@@ -33,6 +30,36 @@ export declare function genPkgJSON(opts: InitOptions): {
     path: string;
     print: string;
 };
+export declare function genPeprTS(): {
+    path: string;
+    data: string;
+};
+export declare const readme: {
+    path: string;
+    data: string;
+};
+export declare const helloPeprTS: {
+    path: string;
+    data: string;
+};
+export declare const gitIgnore: {
+    path: string;
+    data: string;
+};
+export declare const samplesYaml: {
+    path: string;
+    data: string;
+};
+export declare const snippet: {
+    path: string;
+    data: {
+        "Create a new Pepr capability": {
+            prefix: string;
+            body: string[];
+            description: string;
+        };
+    };
+};
 export declare const tsConfig: {
     path: string;
     data: {
@@ -48,10 +75,6 @@ export declare const tsConfig: {
         include: string[];
     };
 };
-export declare const gitIgnore: {
-    path: string;
-    data: string;
-};
 export declare const prettierRC: {
     path: string;
     data: {
@@ -68,19 +91,3 @@ export declare const prettierRC: {
         useTabs: boolean;
     };
 };
-export declare const readme: {
-    path: string;
-    data: string;
-};
-export declare const samplesYaml: {
-    path: string;
-    data: string;
-};
-export declare const helloPeprTS: {
-    path: string;
-    data: string;
-};
-export declare const snippet: {
-    path: string;
-    data: string;
-};

package/dist/src/cli/init/templates.js

@@ -1,34 +1,21 @@
 "use strict";
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.snippet = exports.helloPeprTS = exports.samplesYaml = exports.readme = exports.prettierRC = exports.gitIgnore = exports.tsConfig = exports.genPkgJSON = exports.genPeprTS = void 0;
+exports.prettierRC = exports.tsConfig = exports.snippet = exports.samplesYaml = exports.gitIgnore = exports.helloPeprTS = exports.readme = exports.genPeprTS = exports.genPkgJSON = void 0;
 const client_node_1 = require("@kubernetes/client-node");
 const util_1 = require("util");
 const uuid_1 = require("uuid");
 const package_json_1 = require("../../../package.json");
+const data_json_1 = __importDefault(require("./templates/data.json"));
+const pepr_code_snippets_json_1 = __importDefault(require("./templates/pepr.code-snippets.json"));
+const prettierrc_json_1 = __importDefault(require("./templates/prettierrc.json"));
+const samples_json_1 = __importDefault(require("./templates/samples.json"));
+const tsconfig_json_1 = __importDefault(require("./templates/tsconfig.json"));
 const utils_1 = require("./utils");
-function genPeprTS() {
-    return {
-        path: "pepr.ts",
-        data: `import { PeprModule } from "pepr";
-import cfg from "./package.json";
-import { HelloPepr } from "./capabilities/hello-pepr";
-
-/**
- * This is the main entrypoint for the Pepr module. It is the file that is run when the module is started.
- * This is where you register your configurations and capabilities with the module.
- */
-new PeprModule(cfg, [
-  // "HelloPepr" is a demo capability that is included with Pepr. You can remove it if you want.
-  HelloPepr,
-
-  // Your additional capabilities go here
-]);
-`,
-    };
-}
-exports.genPeprTS = genPeprTS;
 function genPkgJSON(opts) {
     // Generate a random UUID for the module based on the module name
     const uuid = (0, uuid_1.v5)(opts.name, (0, uuid_1.v4)());
@@ -52,6 +39,7 @@ function genPkgJSON(opts) {
             },
         },
         scripts: {
+            "k3d-setup": package_json_1.scripts["e2e-dev-setup"],
             build: "pepr build",
             start: "pepr dev",
         },
@@ -69,219 +57,38 @@ function genPkgJSON(opts) {
     };
 }
 exports.genPkgJSON = genPkgJSON;
-exports.tsConfig = {
-    path: "tsconfig.json",
-    data: {
-        compilerOptions: {
-            esModuleInterop: true,
-            lib: ["ES2020"],
-            moduleResolution: "node",
-            resolveJsonModule: true,
-            rootDir: ".",
-            strict: false,
-            target: "ES2020",
-        },
-        include: ["**/*.ts"],
-    },
+function genPeprTS() {
+    return {
+        path: "pepr.ts",
+        data: data_json_1.default.peprTS,
+    };
+}
+exports.genPeprTS = genPeprTS;
+exports.readme = {
+    path: "README.md",
+    data: data_json_1.default.readme,
+};
+exports.helloPeprTS = {
+    path: "hello-pepr.ts",
+    data: data_json_1.default.helloPeprTS,
 };
 exports.gitIgnore = {
     path: ".gitignore",
-    data: `# Ignore node_modules and Pepr build artifacts
-node_modules
-dist
-insecure*
-`,
-};
-exports.prettierRC = {
-    path: ".prettierrc",
-    data: {
-        arrowParens: "avoid",
-        bracketSameLine: false,
-        bracketSpacing: true,
-        embeddedLanguageFormatting: "auto",
-        insertPragma: false,
-        printWidth: 80,
-        quoteProps: "as-needed",
-        requirePragma: false,
-        semi: true,
-        tabWidth: 2,
-        useTabs: false,
-    },
-};
-exports.readme = {
-    path: "README.md",
-    data: `# Pepr Module
-
-This is a Pepr module. It is a module that can be used with the [Pepr]() framework.
-
-The \`capabilities\` directory contains all the capabilities for this module. By default, 
-a capability is a single typescript file in the format of \`capability-name.ts\` that is 
-imported in the root \`pepr.ts\` file as \`import { HelloPepr } from "./capabilities/hello-pepr";\`. 
-Because this is typescript, you can organize this however you choose, e.g. creating a sub-folder 
-per-capability or common logic in shared files or folders.
-
-Example Structure:
-
-\`\`\`
-Module Root
-├── package.json
-├── pepr.ts
-└── capabilities
-    ├── example-one.ts
-    ├── example-three.ts
-    └── example-two.ts
-\`\`\`
-`,
+    data: data_json_1.default.gitignore,
 };
 exports.samplesYaml = {
     path: "hello-pepr.samples.yaml",
-    data: [
-        {
-            apiVersion: "v1",
-            kind: "Namespace",
-            metadata: {
-                name: "pepr-demo",
-            },
-        },
-        {
-            apiVersion: "v1",
-            kind: "ConfigMap",
-            metadata: {
-                name: "example-1",
-                namespace: "pepr-demo",
-            },
-            data: {
-                key: "ex-1-val",
-            },
-        },
-        {
-            apiVersion: "v1",
-            kind: "ConfigMap",
-            metadata: {
-                name: "example-2",
-                namespace: "pepr-demo",
-            },
-            data: {
-                key: "ex-2-val",
-            },
-        },
-        {
-            apiVersion: "v1",
-            kind: "ConfigMap",
-            metadata: {
-                name: "example-3",
-                namespace: "pepr-demo",
-                labels: {
-                    change: "by-label",
-                },
-            },
-            data: {
-                key: "ex-3-val",
-            },
-        },
-    ]
-        .map(r => (0, client_node_1.dumpYaml)(r, { noRefs: true }))
-        .join("---\n"),
-};
-exports.helloPeprTS = {
-    path: "hello-pepr.ts",
-    data: `import { Capability, a } from "pepr";
-
-/**
- *  The HelloPepr is an example capability to demonstrate some general concepts of Pepr.
- *  To test this capability you can run \`pepr dev\` and then run the following command:
- *  \`kubectl apply -f capabilities/hello-pepr.samples.yaml\`
- */ 
-export const HelloPepr = new Capability({
-  name: "hello-pepr",
-  description: "A simple example capability to show how things work.",
-  namespaces: ["pepr-demo"],
-});
-
-// Use the 'When' function to create a new Capability Action
-const { When } = HelloPepr;
-  
-/**
- * This is a single Capability Action. They can be in the same file or put imported from other files.
- * In this exmaple, when a ConfigMap is created with the name \`example-1\`, then add a label and annotation.
- *
- * Equivelant to manually running:
- * \`kubectl label configmap example-1 pepr=was-here\`
- * \`kubectl annotate configmap example-1 pepr.dev=annotations-work-too\`
- */
-When(a.ConfigMap)
-  .IsCreated()
-  .WithName("example-1")
-  .Then(request =>
-    request
-      .SetLabel("pepr", "was-here")
-      .SetAnnotation("pepr.dev", "annotations-work-too")
-  );
-
-/**
- * This Capabiility Action does the exact same changes for example-2, except this time it uses the \`.ThenSet()\` feature.
- * You can stack multiple \`.Then()\` calls, but only a single \`.ThenSet()\`
- */
-When(a.ConfigMap)
-  .IsCreated()
-  .WithName("example-2")
-  .ThenSet({
-    metadata: {
-      labels: {
-        pepr: "was-here",
-      },
-      annotations: {
-        "pepr.dev": "annotations-work-too",
-      },
-    },
-  });
-
-/**
- * This Capability Action combines different styles. Unlike the previous actions, this one will look for any ConfigMap
- * in the \`pepr-demo\` namespace that has the label \`change=by-label\` during either CREATE or UPDATE. Note that all 
- * conditions added such as \`WithName()\`, \`WithLabel()\`, \`InNamespace()\`, are ANDs so all conditions must be true 
- * for the request to be procssed.
- */
-When(a.ConfigMap)
-  .IsCreatedOrUpdated()
-  .WithLabel("change", "by-label")
-  .Then(request => {
-    // The K8s object e are going to mutate
-    const cm = request.Raw;
-
-    // Get the username and uid of the K8s reuest
-    const { username, uid } = request.Request.userInfo;
-
-    // Store some data about the request in the configmap
-    cm.data["username"] = username;
-    cm.data["uid"] = uid;
-
-    // You can still mix other ways of making changes too
-    request.SetAnnotation("pepr.dev", "making-waves");
-  });    
-`,
+    data: samples_json_1.default.map(r => (0, client_node_1.dumpYaml)(r, { noRefs: true })).join("---\n"),
 };
 exports.snippet = {
     path: "pepr.code-snippets",
-    data: `{
-  "Create a new Pepr capability": {
-    "prefix": "create pepr capability",
-    "body": [
-      "import { Capability, a } from 'pepr';",
-      "",
-      "export const $\{TM_FILENAME_BASE/(.*)/$\{1:/pascalcase}/} = new Capability({",
-      "\\tname: '$\{TM_FILENAME_BASE}',",
-      "\\tdescription: '$\{1:A brief description of this capability.}',",
-      "\\tnamespaces: [$\{2:}],",
-      "});",
-      "",
-      "// Use the 'When' function to create a new Capability Action",
-      "const { When } = $\{TM_FILENAME_BASE/(.*)/$\{1:/pascalcase}/};",
-      "",
-      "// When(a.<Kind>).Is<Event>().Then(change => change.<changes>",
-      "When($\{3:})"
-    ],
-    "description": "Creates a new Pepr capability with a specified description, and optional namespaces, and adds a When statement for the specified value."
-  }
-}`,
+    data: pepr_code_snippets_json_1.default,
+};
+exports.tsConfig = {
+    path: "tsconfig.json",
+    data: tsconfig_json_1.default,
+};
+exports.prettierRC = {
+    path: ".prettierrc",
+    data: prettierrc_json_1.default,
 };

package/hack/build-template-data.js

@@ -0,0 +1,23 @@
+// This is a helper script to collect the contents of the template files before building the CLI
+
+/* eslint-disable */
+const fs = require("fs");
+const path = require("path");
+
+const baseDir = path.join(__dirname, "..", "src", "cli", "init", "templates");
+
+// Read the text file
+const gitignore = fs.readFileSync(path.join(baseDir, "gitignore"), "utf8");
+const readme = fs.readFileSync(path.join(baseDir, "README.md"), "utf8");
+const peprTS = fs.readFileSync(path.join(baseDir, "pepr.ts"), "utf8");
+const helloPeprTS = fs.readFileSync(path.join(baseDir, "hello-pepr.ts"), "utf8");
+
+fs.writeFileSync(
+  path.join(baseDir, "data.json"),
+  JSON.stringify({
+    gitignore,
+    readme,
+    peprTS,
+    helloPeprTS,
+  })
+);

package/package.json

@@ -9,7 +9,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "0.1.41",
+  "version": "0.1.42",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "pepr": {
@@ -24,7 +24,8 @@
     }
   },
   "scripts": {
-    "build": "rm -fr dist/* && tsc -p tsconfig.build.json",
+    "prebuild": "rm -fr dist/* && node hack/build-template-data.js",
+    "build": "tsc -p tsconfig.build.json",
     "test": "npm run build && ava && node dist/cli.js -V",
     "lint": "npx eslint src",
     "lint:fix": "npm run lint -- --fix",

package/tsconfig.build.json

@@ -1,4 +1,4 @@
 {
-    "extends": "./tsconfig.json",
-    "exclude": ["node_modules", "dist", "fixtures", "**/*.test.ts"]
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "dist", "fixtures", "**/*.test.ts", "src/cli/init/templates"]
 }