sn-typescript-util 1.2.3 → 1.2.5

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/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
+- A [project created](https://docs.servicenow.com/bundle/vancouver-application-development/page/build/applications/task/create-project.html) and [application imported](https://docs.servicenow.com/bundle/vancouver-application-development/page/build/applications/task/vscode-import-application.html) in VS Code
 
 **[Back to top](#table-of-contents)**
 

package/bin/snts.js

@@ -7,125 +7,119 @@ 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;
-    });
+  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;
-    });
+  const s = startPrompts('Processing', 'Compile started');
+  return await execFile(getFilePath('compile.rb'), (stdout) => {
+    stopPrompt(s, 'Completed');
+    return stdout;
+  });
 }
 function doOptions(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 ((hasApplication() && options[option]) || options['default'])();
+  program.parse(process.argv).opts();
+  const option = Object.keys(program.opts()).toString();
+  const options = {
+    build: () => {
+      doBuild();
+    },
+    compile: () => {
+      doCompile();
+    },
+    sync: () => {
+      doSync();
+    },
+    default: () => {
+      program.help();
+    }
+  };
+  return ((hasApplication() && options[option]) || options['default'])();
 }
 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 = getWorkspace();
-        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;
-    }
+  const s = startPrompts('Processing', 'Sync started');
+  return await execFile(getFilePath('sync.sh'), (stdout) => {
+    stopPrompt(s, 'Completed');
+    return stdout;
+  });
 }
 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)));
+  var url = `https://docs.servicenow.com/bundle/vancouver-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}`;
+  const fileName = fileURLToPath(import.meta.url);
+  const dirName = path.dirname(fileName);
+  return `${path.join(dirName, `../${dir}`)}/${file}`;
 }
 async function getPackageInfo() {
-    return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
+  return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
 }
 function getWorkspace() {
-    return JSON.parse(readFileSync('./system/sn-workspace.json').toString());
+  return JSON.parse(readFileSync('./system/sn-workspace.json').toString());
 }
 async function hasApplication() {
-    try {
-        const workspace = await getWorkspace();
-        var app = workspace.ACTIVE_APPLICATION;
-        return Object.entries(app).length === 0 ? getErrorMsg() : true;
-    }
-    catch (e) {
-        getErrorMsg();
-        return process.exit(1);
-    }
+  try {
+    const workspace = await getWorkspace();
+    var app = workspace.ACTIVE_APPLICATION;
+    return Object.entries(app).length === 0 ? getErrorMsg() : true;
+  } catch (e) {
+    getErrorMsg();
+    return process.exit(1);
+  }
 }
 (async () => {
-    return init();
+  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 doOptions(program);
+  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 doOptions(program);
 }
 function introPrompt(msg) {
-    return intro(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;
-    });
+  const s = startPrompts('Installing packages', null);
+  return await execFile(getFilePath('install.sh'), (stdout) => {
+    stopPrompt(s, 'Packages installed');
+    outro('Completed');
+    return stdout;
+  });
 }
 async function runSync() {
-    const s = startPrompts('Syncing', null);
-    return await execFile(getFilePath('sync.sh'), (stdout) => {
-        stopPrompt(s, 'Sync completed');
-        runInstall();
-        return stdout;
-    });
+  const s = startPrompts('Syncing', null);
+  return await execFile(getFilePath('sync.sh'), (stdout) => {
+    stopPrompt(s, 'Sync completed');
+    runInstall();
+    return stdout;
+  });
 }
 function startPrompts(start, intro) {
-    intro && introPrompt(intro);
-    const s = spinner();
-    s.start(start);
-    return s;
+  intro && introPrompt(intro);
+  const s = spinner();
+  s.start(start);
+  return s;
 }
 function stopPrompt(spinner, msg) {
-    return spinner.stop(msg);
+  return spinner.stop(msg);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sn-typescript-util",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "A TypeScript utility for ServiceNow developers using VS Code",
   "bin": {
     "snts": "bin/snts.js"
@@ -16,6 +16,11 @@
     "type": "git",
     "url": "https://github.com/stevengregory/sn-typescript-util.git"
   },
+  "scripts": {
+    "format": "prettier --write ./bin/*.js ./scripts/*.ts",
+    "release": "./scripts/release.sh",
+    "watch": "tsc --watch"
+  },
   "type": "module",
   "dependencies": {
     "@clack/prompts": "^0.6.3",

package/scripts/release.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+bump_version() {
+  version=$(npm version "$1" --no-git-tag-version)
+  echo "version bumped to $version"
+  do_git_operation
+}
+
+do_git_operation() {
+  git commit -a -m "chore: bump the version"
+  git tag $(get_package_version)
+}
+
+get_package_version() {
+  version=`node -p "require('./package.json').version"`
+  echo "v$version"
+}
+
+bump_version "$1"

package/{src → scripts}/snts.ts

@@ -28,8 +28,8 @@ async function doCompile() {
 
 function doOptions(program: any) {
   program.parse(process.argv).opts();
-  const option = Object.keys(program.opts()).toString();
-  const options = {
+  const option: string = Object.keys(program.opts()).toString();
+  const options: any = {
     build: () => {
       doBuild();
     },
@@ -54,22 +54,8 @@ async function doSync() {
   });
 }
 
-function getBuildName() {
-  const defaultBuild: string = 'utah';
-  try {
-    const workspace: Workspace = getWorkspace();
-    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 url: string = `https://docs.servicenow.com/bundle/vancouver-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)));
 }
@@ -145,7 +131,7 @@ async function runSync() {
   });
 }
 
-function startPrompts(start: string, intro: string) {
+function startPrompts(start: string, intro: string | null) {
   intro && introPrompt(intro);
   const s = spinner();
   s.start(start);

package/tsconfig.json

@@ -2,10 +2,11 @@
   "compilerOptions": {
     "target": "ESNext",
     "module": "NodeNext",
+    "noImplicitAny": true,
     "esModuleInterop": true,
     "outDir": "bin",
     "resolveJsonModule": true,
     "skipLibCheck": true
   },
-  "include": ["src"]
+  "include": ["scripts"]
 }