sn-typescript-util 1.1.0 → 1.2.1

package/bin/snts.js

@@ -0,0 +1,129 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { execFile } from 'node:child_process';
+import path from 'path';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { bold, red } from 'colorette';
+import { intro, outro, spinner } from '@clack/prompts';
+async function doBuild() {
+    const s = startPrompts('Installing configs', 'Build started');
+    return await execFile(getFilePath('init.rb'), (stdout) => {
+        stopPrompt(s, 'Configs installed');
+        runSync();
+        return stdout;
+    });
+}
+async function doCompile() {
+    const s = startPrompts('Processing', 'Compile started');
+    return await execFile(getFilePath('compile.rb'), (stdout) => {
+        stopPrompt(s, 'Completed');
+        return stdout;
+    });
+}
+async function doSync() {
+    const s = startPrompts('Processing', 'Sync started');
+    return await execFile(getFilePath('sync.sh'), (stdout) => {
+        stopPrompt(s, 'Completed');
+        return stdout;
+    });
+}
+function getBuildName() {
+    const defaultBuild = 'utah';
+    try {
+        const workspace = getWorkspaceFile();
+        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, dir = 'scripts') {
+    const __filename = fileURLToPath(import.meta.url);
+    const __dirname = path.dirname(__filename);
+    return `${path.join(__dirname, `../${dir}`)}/${file}`;
+}
+function getOption(program) {
+    program.parse(process.argv).opts();
+    const option = Object.keys(program.opts()).toString();
+    const options = {
+        build: () => {
+            doBuild();
+        },
+        compile: () => {
+            doCompile();
+        },
+        sync: () => {
+            doSync();
+        },
+        default: () => {
+            program.help();
+        }
+    };
+    return (options[option] || options['default'])();
+}
+async function getPackageInfo() {
+    return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
+}
+function getWorkspaceFile() {
+    return JSON.parse(readFileSync('./system/sn-workspace.json').toString())
+        .ACTIVE_APPLICATION;
+}
+async function hasApplication() {
+    try {
+        const workspace = await getWorkspaceFile();
+        return Object.entries(workspace).length === 0 ? getErrorMsg() : true;
+    }
+    catch (e) {
+        getErrorMsg();
+        return process.exit(1);
+    }
+}
+(async () => {
+    return init();
+})();
+async function init() {
+    const program = new Command();
+    const info = await getPackageInfo();
+    program.description(info.description);
+    program.version(info.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');
+    return hasApplication() && getOption(program);
+}
+function introPrompt(msg) {
+    return intro(msg);
+}
+async function runInstall() {
+    const s = startPrompts('Installing packages', null);
+    return await execFile(getFilePath('install.sh'), (stdout) => {
+        stopPrompt(s, 'Packages installed');
+        outro('Completed');
+        return stdout;
+    });
+}
+async function runSync() {
+    return await execFile(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.1.0",
+  "version": "1.2.1",
   "description": "A TypeScript utility for ServiceNow developers using VS Code",
   "bin": {
-    "snts": "bin/snts.ts"
+    "snts": "bin/snts.js"
   },
   "keywords": [
     "ServiceNow",
@@ -16,16 +16,16 @@
     "type": "git",
     "url": "https://github.com/stevengregory/sn-typescript-util.git"
   },
+  "type": "module",
   "dependencies": {
     "@clack/prompts": "^0.6.3",
-    "@types/node": "^18.15.11",
+    "@types/node": "^20.4.2",
     "@types/servicenow": "^10.0.1",
-    "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/src/snts.ts

@@ -0,0 +1,154 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import { execFile } from 'node:child_process';
+import path from 'path';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { bold, red } from 'colorette';
+import { intro, outro, spinner } from '@clack/prompts';
+
+async function doBuild() {
+  const s = startPrompts('Installing configs', 'Build started');
+  return await execFile(getFilePath('init.rb'), (stdout) => {
+    stopPrompt(s, 'Configs installed');
+    runSync();
+    return stdout;
+  });
+}
+
+async function doCompile() {
+  const s = startPrompts('Processing', 'Compile started');
+  return await execFile(getFilePath('compile.rb'), (stdout) => {
+    stopPrompt(s, 'Completed');
+    return stdout;
+  });
+}
+
+async function doSync() {
+  const s = startPrompts('Processing', 'Sync started');
+  return await execFile(getFilePath('sync.sh'), (stdout: any) => {
+    stopPrompt(s, 'Completed');
+    return stdout;
+  });
+}
+
+function getBuildName() {
+  const defaultBuild: string = 'utah';
+  try {
+    const workspace = getWorkspaceFile();
+    const app: string = workspace.ACTIVE_APPLICATION;
+    const build: string = workspace.ALL_APPLICATIONS[app].BUILD_NAME;
+    return Object.entries(build).length !== 0
+      ? build.toLowerCase()
+      : defaultBuild;
+  } catch (e) {
+    return defaultBuild;
+  }
+}
+
+function getErrorMsg() {
+  var url: string = `https://docs.servicenow.com/bundle/${getBuildName()}-application-development/page/build/applications/task/create-project.html`;
+  var msg: string = `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: string, dir: string = 'scripts') {
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = path.dirname(__filename);
+  return `${path.join(__dirname, `../${dir}`)}/${file}`;
+}
+
+function getOption(program: any) {
+  program.parse(process.argv).opts();
+  const option = Object.keys(program.opts()).toString();
+  const options = {
+    build: () => {
+      doBuild();
+    },
+    compile: () => {
+      doCompile();
+    },
+    sync: () => {
+      doSync();
+    },
+    default: () => {
+      program.help();
+    }
+  };
+  return (options[option] || options['default'])();
+}
+
+async function getPackageInfo() {
+  return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
+}
+
+function getWorkspaceFile() {
+  return JSON.parse(readFileSync('./system/sn-workspace.json').toString())
+    .ACTIVE_APPLICATION;
+}
+
+async function hasApplication() {
+  try {
+    const workspace = await getWorkspaceFile();
+    return Object.entries(workspace).length === 0 ? getErrorMsg() : true;
+  } catch (e) {
+    getErrorMsg();
+    return process.exit(1);
+  }
+}
+
+(async () => {
+  return init();
+})();
+
+async function init() {
+  const program = new Command();
+  const info = await getPackageInfo();
+  program.description(info.description);
+  program.version(info.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'
+  );
+  return hasApplication() && getOption(program);
+}
+
+function introPrompt(msg: string) {
+  return intro(msg);
+}
+
+async function runInstall() {
+  const s = startPrompts('Installing packages', null);
+  return await execFile(getFilePath('install.sh'), (stdout) => {
+    stopPrompt(s, 'Packages installed');
+    outro('Completed');
+    return stdout;
+  });
+}
+
+async function runSync() {
+  return await execFile(getFilePath('sync.sh'), (stdout) => {
+    runInstall();
+    return stdout;
+  });
+}
+
+function startPrompts(start: string, intro: string) {
+  intro && introPrompt(intro);
+  const s = spinner();
+  s.start(start);
+  return s;
+}
+
+function stopPrompt(spinner: any, msg: string) {
+  return spinner.stop(msg);
+}

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "esModuleInterop": true,
+    "outDir": "bin",
+    "resolveJsonModule": true,
+    "rootDir": "src",
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}

package/bin/snts.ts

@@ -1,147 +0,0 @@
-#!/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);
-}