sn-typescript-util 1.0.19 → 1.1.1

package/README.md

@@ -29,7 +29,7 @@ Using TypeScript, the CLI provides an enhanced developer workflow.
 - [Node.js](https://nodejs.org/)
 - [Visual Studio Code](https://code.visualstudio.com/)
 - [ServiceNow Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ServiceNow.now-vscode)
-- A [project created](https://docs.servicenow.com/bundle/quebec-application-development/page/build/applications/task/create-project.html#create-project) and [application imported](https://docs.servicenow.com/bundle/quebec-application-development/page/build/applications/task/create-project.html#vscode-import-application) in VS Code
+- A [project created](https://docs.servicenow.com/bundle/utah-application-development/page/build/applications/task/create-project.html) and [application imported](https://docs.servicenow.com/bundle/utah-application-development/page/build/applications/task/vscode-import-application.html) in VS Code
 
 **[Back to top](#table-of-contents)**
 

package/bin/snts.js

@@ -0,0 +1,123 @@
+#!/usr/bin/env node
+const childProcess = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const util = require('util');
+const exec = util.promisify(childProcess.exec);
+const { description, version } = require('./../package.json');
+const { program } = require('commander');
+const { bold, cyan, red } = require('colorette');
+const { cancel, intro, outro, spinner } = require('@clack/prompts');
+async function doBuild() {
+    const s = startPrompts('Installing configs', 'Build started');
+    return await exec(getFilePath('init.rb'), (stdout) => {
+        stopPrompt(s, 'Configs installed');
+        runSync();
+        return stdout;
+    });
+}
+async function doCompile() {
+    const s = startPrompts('Processing', 'Compile started');
+    return await exec(getFilePath('compile.rb'), (stdout) => {
+        stopPrompt(s, 'Completed');
+        return stdout;
+    });
+}
+async function doSync() {
+    const s = startPrompts('Processing', 'Sync started');
+    return await exec(getFilePath('sync.sh'), (stdout) => {
+        stopPrompt(s, 'Completed');
+        return stdout;
+    });
+}
+function getBuildName() {
+    const defaultBuild = 'utah';
+    try {
+        const workspace = JSON.parse(getWorkspaceConfig());
+        const app = workspace.ACTIVE_APPLICATION;
+        const build = workspace.ALL_APPLICATIONS[app].BUILD_NAME;
+        return Object.entries(build).length !== 0
+            ? build.toLowerCase()
+            : defaultBuild;
+    }
+    catch (e) {
+        return defaultBuild;
+    }
+}
+function getErrorMsg() {
+    var url = `https://docs.servicenow.com/bundle/${getBuildName()}-application-development/page/build/applications/task/create-project.html`;
+    var msg = `No active application detected. Please create a project with the ServiceNow Extension for VS Code.\n\n${url}`;
+    return console.error(bold(red(msg)));
+}
+function getFilePath(file) {
+    return `${path.join(__dirname, '../scripts')}/${file}`;
+}
+function getOption(opts) {
+    const option = Object.keys(opts).toString();
+    const options = {
+        build: () => {
+            doBuild();
+        },
+        compile: () => {
+            doCompile();
+        },
+        sync: () => {
+            doSync();
+        },
+        default: () => {
+            program.help();
+        }
+    };
+    return (options[option] || options['default'])();
+}
+function getWorkspaceConfig() {
+    return fs.readFileSync('./system/sn-workspace.json');
+}
+function hasApplication() {
+    try {
+        const app = JSON.parse(getWorkspaceConfig()).ACTIVE_APPLICATION;
+        return Object.entries(app).length === 0 ? getErrorMsg() : true;
+    }
+    catch (e) {
+        getErrorMsg();
+        return process.exit(1);
+    }
+}
+(() => {
+    return init();
+})();
+function init() {
+    program.description(description);
+    program.version(version);
+    program.option('-b, --build', 'build project utility files & package dependencies');
+    program.option('-c, --compile', 'compile TypeScript files to JavaScript & move to src');
+    program.option('-s, --sync', 'sync new instance-based src files to the ts directory');
+    program.parse(process.argv).opts();
+    return hasApplication() && getOption(program.opts());
+}
+function introPrompt(msg) {
+    return intro(msg);
+}
+async function runInstall() {
+    const s = startPrompts('Installing packages', null);
+    return await exec(getFilePath('install.sh'), (stdout) => {
+        stopPrompt(s, 'Packages installed');
+        outro('Completed');
+        return stdout;
+    });
+}
+async function runSync() {
+    return await exec(getFilePath('sync.sh'), (stdout) => {
+        runInstall();
+        return stdout;
+    });
+}
+function startPrompts(start, intro) {
+    intro && introPrompt(intro);
+    const s = spinner();
+    s.start(start);
+    return s;
+}
+function stopPrompt(spinner, msg) {
+    return spinner.stop(msg);
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "sn-typescript-util",
-  "version": "1.0.19",
+  "version": "1.1.1",
   "description": "A TypeScript utility for ServiceNow developers using VS Code",
   "bin": {
-    "snts": "bin/snts.ts"
+    "snts": "bin/snts.js"
   },
   "keywords": [
     "ServiceNow",
@@ -17,15 +17,14 @@
     "url": "https://github.com/stevengregory/sn-typescript-util.git"
   },
   "dependencies": {
-    "@types/node": "^18.15.11",
+    "@clack/prompts": "^0.6.3",
+    "@types/node": "^20.4.2",
     "@types/servicenow": "^10.0.1",
-    "cli-progress": "^3.12.0",
-    "colorette": "^2.0.19",
-    "commander": "^10.0.0",
-    "nodemon": "^2.0.22",
+    "colorette": "^2.0.20",
+    "commander": "^11.0.0",
+    "nodemon": "^3.0.1",
     "npm-add-script": "^1.1.0",
-    "prettier": "^2.8.7",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.0.4"
+    "prettier": "^3.0.0",
+    "typescript": "^5.1.6"
   }
 }

package/{bin → src}/snts.ts

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 
 const childProcess = require('child_process');
-const cliProgress = require('cli-progress');
 const fs = require('fs');
 const path = require('path');
 const util = require('util');
@@ -9,13 +8,35 @@ const exec = util.promisify(childProcess.exec);
 const { description, version } = require('./../package.json');
 const { program } = require('commander');
 const { bold, cyan, red } = require('colorette');
+const { cancel, intro, outro, spinner } = require('@clack/prompts');
 
-(() => {
-  return init();
-})();
+async function doBuild() {
+  const s = startPrompts('Installing configs', 'Build started');
+  return await exec(getFilePath('init.rb'), (stdout) => {
+    stopPrompt(s, 'Configs installed');
+    runSync();
+    return stdout;
+  });
+}
+
+async function doCompile() {
+  const s = startPrompts('Processing', 'Compile started');
+  return await exec(getFilePath('compile.rb'), (stdout) => {
+    stopPrompt(s, 'Completed');
+    return stdout;
+  });
+}
+
+async function doSync() {
+  const s = startPrompts('Processing', 'Sync started');
+  return await exec(getFilePath('sync.sh'), (stdout) => {
+    stopPrompt(s, 'Completed');
+    return stdout;
+  });
+}
 
 function getBuildName() {
-  const defaultBuild = 'tokyo';
+  const defaultBuild = 'utah';
   try {
     const workspace = JSON.parse(getWorkspaceConfig());
     const app = workspace.ACTIVE_APPLICATION;
@@ -34,17 +55,21 @@ function getErrorMsg() {
   return console.error(bold(red(msg)));
 }
 
+function getFilePath(file) {
+  return `${path.join(__dirname, '../scripts')}/${file}`;
+}
+
 function getOption(opts) {
   const option = Object.keys(opts).toString();
   const options = {
     build: () => {
-      startBuild();
+      doBuild();
     },
     compile: () => {
-      runScript('compile.rb');
+      doCompile();
     },
     sync: () => {
-      runProgressScript('sync.sh');
+      doSync();
     },
     default: () => {
       program.help();
@@ -53,18 +78,6 @@ function getOption(opts) {
   return (options[option] || options['default'])();
 }
 
-function getProgressBar() {
-  return new cliProgress.SingleBar({
-    format:
-      'CLI Progress |' +
-      cyan('{bar}') +
-      '| {percentage}% || {value}/{total} Chunks',
-    barCompleteChar: '\u2588',
-    barIncompleteChar: '\u2591',
-    hideCursor: true
-  });
-}
-
 function getWorkspaceConfig() {
   return fs.readFileSync('./system/sn-workspace.json');
 }
@@ -75,13 +88,13 @@ function hasApplication() {
     return Object.entries(app).length === 0 ? getErrorMsg() : true;
   } catch (e) {
     getErrorMsg();
-    return process.exit(e.code);
+    return process.exit(1);
   }
 }
 
-function getFilePath(file) {
-  return `${path.join(__dirname, '../scripts')}/${file}`;
-}
+(() => {
+  return init();
+})();
 
 function init() {
   program.description(description);
@@ -102,57 +115,33 @@ function init() {
   return hasApplication() && getOption(program.opts());
 }
 
-function progressComplete(bar) {
-  bar.update(100);
-  bar.stop();
-}
-
-function progressStart(bar) {
-  bar.start(100, 0);
-  bar.update(1);
-}
-
-async function runConfigs(bar) {
-  return await exec(getFilePath('init.rb'), (stdout) => {
-    bar.update(10);
-    runSync(bar);
-    return stdout;
-  });
+function introPrompt(msg) {
+  return intro(msg);
 }
 
-async function runInstall(bar) {
-  bar.update(50);
+async function runInstall() {
+  const s = startPrompts('Installing packages', null);
   return await exec(getFilePath('install.sh'), (stdout) => {
-    progressComplete(bar);
+    stopPrompt(s, 'Packages installed');
+    outro('Completed');
     return stdout;
   });
 }
 
-function runProgressScript(file) {
-  var bar = getProgressBar();
-  progressStart(bar);
-  return childProcess.exec(getFilePath(file), (stdout) => {
-    progressComplete(bar);
-    return stdout;
-  });
-}
-
-function runScript(file) {
-  return childProcess.exec(getFilePath(file), (stdout) => {
+async function runSync() {
+  return await exec(getFilePath('sync.sh'), (stdout) => {
+    runInstall();
     return stdout;
   });
 }
 
-async function runSync(bar) {
-  return await exec(getFilePath('sync.sh'), (stdout) => {
-    bar.update(25);
-    runInstall(bar);
-    return stdout;
-  });
+function startPrompts(start, intro) {
+  intro && introPrompt(intro);
+  const s = spinner();
+  s.start(start);
+  return s;
 }
 
-async function startBuild() {
-  var bar = getProgressBar();
-  progressStart(bar);
-  return await Promise.all([runConfigs(bar)]);
+function stopPrompt(spinner, msg) {
+  return spinner.stop(msg);
 }

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "outDir": "bin",
+    "rootDir": "src",
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}