feat(cli): typescript - yarn run upgrade & upgrade:next

add some commands for upgrading your project

Author: Elad Ben-Israel

packages/cdk8s-cli/templates/typescript-app/.hooks.sscaff.js

@@ -2,43 +2,47 @@ const { execSync } = require('child_process');
 const { readFileSync, symlinkSync, mkdirSync } = require('fs');
 const path = require('path');
 
+const version = require('../../package.json').version;
+
 exports.pre = () => {
   if (process.env.CLI_TEST) {
     console.error(`CLI_TEST=1`);
   }
 };
 
 exports.post = () => {
-  const deps = [ '@aws-cdk/core', '@aws-cdk/cx-api', 'cdk8s' ];
-  const devDeps = [ 'cdk8s-cli', '@types/node' ];
-
-  deps.forEach(d => installDep(d));
-  devDeps.forEach(d => installDep(d, true));
+  installDeps([ '@aws-cdk/core', '@aws-cdk/cx-api', `cdk8s@^${version}` ]);
+  installDeps([ `cdk8s-cli@^${version}`, '@types/node' ], true);
 
   // build to make sure all is good
   execSync('yarn build', { stdio: 'inherit' });
 
-  console.log(readFileSync('./help.txt', 'utf-8'));
+  console.log(readFileSync('./help', 'utf-8'));
 };
 
-function installDep(dep, isDev) {
-
+function installDeps(deps, isDev) {
   // if we are in a CLI test, install the dependency from the local repo instead
   // of from the public registry.
   if (process.env.CLI_TEST) {
-    installLocalDep(dep);
+    for (const dep of deps) {
+      installLocalDep(dep);
+    }
     return;
   }
 
   const devDep = isDev ? '-D' : '';
-  execSync(`yarn add ${devDep} ${dep}`, { stdio: 'inherit' });
+  execSync(`yarn add ${devDep} ${deps.join(' ')}`, { stdio: 'inherit' });
 }
 
-function installLocalDep(dep) {
+function installLocalDep(depWithVer) {
+  const dep = depWithVer.split('@')[0];
+
   const pkgfile = require.resolve(`${dep}/package.json`);
   const target = path.dirname(pkgfile);
   const source = path.join('node_modules', dep);
   mkdirSync(path.dirname(source), { recursive: true });
+
+  console.error(`symlinking: ${source} => ${target}`);
   symlinkSync(target, source);
 
   const pkg = JSON.parse(readFileSync(pkgfile, 'utf-8'));
@@ -49,6 +53,7 @@ function installLocalDep(dep) {
     const binsource = path.join(localbin, program);
     const bintarget = path.join(target, relpath);
 
+    console.error(`symlinking: ${binsource} => ${binsource}`);
     symlinkSync(bintarget, binsource);
   }
 }

packages/cdk8s-cli/templates/typescript-app/help

@@ -0,0 +1,21 @@
+========================================================================================================
+
+ Your cdk8s typescript project is ready!
+
+   cat help         print this message
+ 
+   yarn run import  import k8s api objects and store them under imports/k8s.ts
+   yarn compile     compile typescript code to javascript
+   yarn watch       watch for changes and compile typescript in the background
+   yarn test        run a very rigorous test suite (tbd)
+   yarn synth       synthesize k8s manifests from charts to dist/ (ready for 'kubectl apply -f')
+   yarn build       all together now: import + compile + test + synth
+
+ deploy:
+   kubectl apply -f dist/*.k8s.yaml
+
+ upgrades:
+   yarn run upgrade       upgrade cdk8s modules to latest version
+   yarn run upgrade:next  upgrade cdk8s modules to latest "@next" version (last commit)
+
+========================================================================================================

packages/cdk8s-cli/templates/typescript-app/help.txt

@@ -11,6 +11,8 @@
     "test": "echo ok",
     "synth": "cdk8s synth --app 'node main.js'",
     "build": "yarn run import && yarn compile && yarn test && yarn synth",
-    "watch": "tsc -w"
+    "watch": "tsc -w",
+    "upgrade": "yarn upgrade -L cdk8s cdk8s-cli",
+    "upgrade:next": "yarn upgrade -L cdk8s@next cdk8s-cli@next"
   }
 }