pepr 0.1.29 → 0.1.31

package/dist/package.json

@@ -1,11 +1,11 @@
 {
     "name": "pepr",
-    "version": "0.1.29",
+    "version": "0.1.31",
     "description": "Kubernetes application engine",
     "author": "Defense Unicorns",
     "homepage": "https://github.com/defenseunicorns/pepr",
     "license": "Apache-2.0",
-    "bin": "dist/pepr-cli.js",
+    "bin": "dist/cli.js",
     "repository": "defenseunicorns/pepr",
     "engines": {
         "node": ">=18.0.0"

package/dist/src/cli/index.js

@@ -26,8 +26,9 @@ program
 });
 (0, init_1.default)(program);
 (0, build_1.default)(program);
-(0, capability_1.default)(program);
-(0, test_1.default)(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);
 program.parse();

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

@@ -15,7 +15,9 @@ function default_1(program) {
     program
         .command("init")
         .description("Initialize a new Pepr Module")
-        .action(async () => {
+        // skip auto npm install and git init
+        .option("--skip-post-init", "Skip npm install, git init and VSCode launch")
+        .action(async (opts) => {
         const response = await (0, walkthrough_1.walkthrough)();
         const dirName = (0, utils_1.sanitizeName)(response.name);
         const packageJSON = (0, templates_1.genPkgJSON)(response);
@@ -33,13 +35,29 @@ function default_1(program) {
                 await (0, utils_1.write)((0, path_1.resolve)(dirName, templates_1.readme.path), templates_1.readme.data);
                 await (0, utils_1.write)((0, path_1.resolve)(dirName, templates_1.tsConfig.path), templates_1.tsConfig.data);
                 await (0, utils_1.write)((0, path_1.resolve)(dirName, peprTS.path), peprTS.data);
-                await (0, utils_1.write)((0, path_1.resolve)(dirName, ".vscode", templates_1.capabilitySnippet.path), templates_1.capabilitySnippet.data);
-                await (0, utils_1.write)((0, path_1.resolve)(dirName, "capabilities", templates_1.capabilityHelloPeprTS.path), templates_1.capabilityHelloPeprTS.data);
-                // run npm install from the new directory
-                process.chdir(dirName);
-                (0, child_process_1.execSync)("npm install", {
-                    stdio: "inherit",
-                });
+                await (0, utils_1.write)((0, path_1.resolve)(dirName, ".vscode", templates_1.snippet.path), templates_1.snippet.data);
+                await (0, utils_1.write)((0, path_1.resolve)(dirName, "capabilities", templates_1.samplesYaml.path), templates_1.samplesYaml.data);
+                await (0, utils_1.write)((0, path_1.resolve)(dirName, "capabilities", templates_1.helloPeprTS.path), templates_1.helloPeprTS.data);
+                if (!opts.skipPostInit) {
+                    // run npm install from the new directory
+                    process.chdir(dirName);
+                    (0, child_process_1.execSync)("npm install", {
+                        stdio: "inherit",
+                    });
+                    // setup git
+                    (0, child_process_1.execSync)("git init", {
+                        stdio: "inherit",
+                    });
+                    // try to open vscode
+                    try {
+                        (0, child_process_1.execSync)("code .", {
+                            stdio: "inherit",
+                        });
+                    }
+                    catch (e) {
+                        // vscode not found, do nothing
+                    }
+                }
                 console.log(`New Pepr module created at ${dirName}`);
                 console.log(`Open VSCode or your editor of choice in ${dirName} to get started!`);
             }

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

@@ -72,11 +72,15 @@ export declare const readme: {
     path: string;
     data: string;
 };
-export declare const capabilityHelloPeprTS: {
+export declare const samplesYaml: {
     path: string;
     data: string;
 };
-export declare const capabilitySnippet: {
+export declare const helloPeprTS: {
+    path: string;
+    data: string;
+};
+export declare const snippet: {
     path: string;
     data: string;
 };

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

@@ -2,11 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Pepr Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.capabilitySnippet = exports.capabilityHelloPeprTS = exports.readme = exports.prettierRC = exports.gitIgnore = exports.tsConfig = exports.genPkgJSON = exports.genPeprTS = void 0;
+exports.snippet = exports.helloPeprTS = exports.samplesYaml = exports.readme = exports.prettierRC = exports.gitIgnore = exports.tsConfig = exports.genPkgJSON = exports.genPeprTS = void 0;
 const util_1 = require("util");
 const uuid_1 = require("uuid");
 const package_json_1 = require("../../../package.json");
 const utils_1 = require("./utils");
+const client_node_1 = require("@kubernetes/client-node");
 function genPeprTS() {
     return {
         path: "pepr.ts",
@@ -85,9 +86,10 @@ exports.tsConfig = {
 };
 exports.gitIgnore = {
     path: ".gitignore",
-    data: `# Ignore node_modules
-  node_modules
-  dist
+    data: `# Ignore node_modules and Pepr build artifacts
+node_modules
+dist
+insecure*
 `,
 };
 exports.prettierRC = {
@@ -131,10 +133,63 @@ Module Root
 \`\`\`
 `,
 };
-exports.capabilityHelloPeprTS = {
+exports.samplesYaml = {
+    path: "samples.yaml",
+    data: (0, client_node_1.dumpYaml)([
+        {
+            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",
+            },
+        },
+    ]),
+};
+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.",
@@ -181,11 +236,12 @@ When(a.ConfigMap)
 
 /**
  * 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\`. Note that all conditions added such as \`WithName()\`,
- * \`WithLabel()\`, \`InNamespace()\`, are ANDs so all conditions must be true for the request to be procssed.
+ * 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)
-  .IsCreated()
+  .IsCreatedOrUpdated()
   .WithLabel("change", "by-label")
   .Then(request => {
     // The K8s object e are going to mutate
@@ -203,7 +259,7 @@ When(a.ConfigMap)
   });    
 `,
 };
-exports.capabilitySnippet = {
+exports.snippet = {
     path: "pepr.code-snippets",
     data: `{
   "Create a new Pepr capability": {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "pepr",
-  "version": "0.1.29",
+  "version": "0.1.31",
   "description": "Kubernetes application engine",
   "author": "Defense Unicorns",
   "homepage": "https://github.com/defenseunicorns/pepr",
   "license": "Apache-2.0",
-  "bin": "dist/pepr-cli.js",
+  "bin": "dist/cli.js",
   "repository": "defenseunicorns/pepr",
   "engines": {
     "node": ">=18.0.0"