sn-typescript-util 1.3.10 → 1.3.12

package/bin/snts.js

@@ -8,7 +8,7 @@ import { bold, cyan, gray, magenta, 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) => {
+  return await execFile(getFilePath('init.rb', 'scripts/build'), (stdout) => {
     stopPrompt(s, 'Configs installed');
     runSync();
     return stdout;
@@ -16,37 +16,22 @@ async function doBuild() {
 }
 async function doCompile() {
   const s = startPrompts('Processing', 'Compile started');
-  return await execFile(getFilePath('compile.rb'), (stdout) => {
-    stopPrompt(s, 'Completed');
-    return stdout;
-  });
+  return await execFile(
+    getFilePath('compile.rb', 'scripts/build'),
+    (stdout) => {
+      stopPrompt(s, 'Completed');
+      return stdout;
+    }
+  );
 }
 function doOptions(program, version) {
-  program.parse(process.argv).opts();
-  const option = Object.keys(program.opts()).toString();
-  const optionKey = option;
-  const options = {
-    build: () => {
-      doBuild();
-    },
-    compile: () => {
-      doCompile();
-    },
-    help: () => {
-      showHelp(program);
-    },
-    sync: () => {
-      doSync();
-    },
-    default: () => {
-      showHelp(program);
-    }
-  };
-  return handleOptions(program, options, optionKey, version);
+  const options = parseOptions(program);
+  const optionKey = options;
+  return handleOptions(program, getOptions(program), optionKey, version);
 }
 async function doSync() {
   const s = startPrompts('Processing', 'Sync started');
-  return await execFile(getFilePath('sync.sh'), (stdout) => {
+  return await execFile(getFilePath('sync.sh', 'scripts/build'), (stdout) => {
     stopPrompt(s, 'Completed');
     return stdout;
   });
@@ -62,11 +47,30 @@ function getErrorMsg() {
   const 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') {
+function getFilePath(file, dir = 'scripts/build') {
   const fileName = fileURLToPath(import.meta.url);
   const dirName = path.dirname(fileName);
   return `${path.join(dirName, `../${dir}`)}/${file}`;
 }
+function getOptions(program) {
+  return {
+    build: () => {
+      doBuild();
+    },
+    compile: () => {
+      doCompile();
+    },
+    help: () => {
+      showHelp(program);
+    },
+    sync: () => {
+      doSync();
+    },
+    default: () => {
+      showHelp(program);
+    }
+  };
+}
 async function getPackageInfo() {
   return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
 }
@@ -123,9 +127,13 @@ async function init() {
 function introPrompt(msg) {
   return intro(msg);
 }
+function parseOptions(program) {
+  const options = program.parse(process.argv).opts();
+  return options && Object.keys(program.opts()).toString();
+}
 async function runSync() {
   const s = startPrompts('Syncing', null);
-  return await execFile(getFilePath('sync.sh'), (stdout) => {
+  return await execFile(getFilePath('sync.sh', 'scripts/build'), (stdout) => {
     stopPrompt(s, 'Sync completed');
     outro('Completed');
     return stdout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sn-typescript-util",
-  "version": "1.3.10",
+  "version": "1.3.12",
   "description": "A TypeScript utility for ServiceNow developers using VS Code",
   "bin": {
     "snts": "bin/snts.js"
@@ -19,7 +19,7 @@
   "scripts": {
     "format": "prettier --write ./bin/*.js ./scripts/*.ts",
     "lint": "eslint .",
-    "release": "./scripts/release.sh",
+    "release": "./scripts/utils/release.sh",
     "watch": "tsc --watch"
   },
   "type": "module",
@@ -33,9 +33,9 @@
   },
   "devDependencies": {
     "@types/commander": "^2.12.2",
-    "@typescript-eslint/eslint-plugin": "^6.17.0",
-    "@typescript-eslint/parser": "^6.17.0",
-    "bun-types": "^1.0.21",
+    "@typescript-eslint/eslint-plugin": "^6.18.1",
+    "@typescript-eslint/parser": "^6.18.1",
+    "bun-types": "^1.0.22",
     "eslint": "^8.56.0",
     "prettier": "^3.1.1"
   }

package/scripts/{build.rb → build/build.rb}

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require_relative File.join(__dir__, 'utils')
+require_relative File.join(__dir__, './../utils/utils')
 
 module ServiceNow
   class Build

package/scripts/snts.ts

@@ -7,56 +7,47 @@ import { readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
 import { bold, cyan, gray, magenta, red } from 'colorette';
 import { intro, outro, spinner } from '@clack/prompts';
-import { Options } from './options.js';
-import { Workspace } from './workspace.js';
+import { Options } from './types/options.js';
+import { Workspace } from './types/workspace.js';
 
 async function doBuild() {
   const s = startPrompts('Installing configs', 'Build started');
-  return await execFile(getFilePath('init.rb'), (stdout: unknown) => {
-    stopPrompt(s, 'Configs installed');
-    runSync();
-    return stdout;
-  });
+  return await execFile(
+    getFilePath('init.rb', 'scripts/build'),
+    (stdout: unknown) => {
+      stopPrompt(s, 'Configs installed');
+      runSync();
+      return stdout;
+    }
+  );
 }
 
 async function doCompile() {
   const s = startPrompts('Processing', 'Compile started');
-  return await execFile(getFilePath('compile.rb'), (stdout: unknown) => {
-    stopPrompt(s, 'Completed');
-    return stdout;
-  });
+  return await execFile(
+    getFilePath('compile.rb', 'scripts/build'),
+    (stdout: unknown) => {
+      stopPrompt(s, 'Completed');
+      return stdout;
+    }
+  );
 }
 
 function doOptions(program: Command, version: string) {
-  program.parse(process.argv).opts();
-  const option: string = Object.keys(program.opts()).toString();
-  const optionKey = option as keyof Options;
-  const options: Options = {
-    build: () => {
-      doBuild();
-    },
-    compile: () => {
-      doCompile();
-    },
-    help: () => {
-      showHelp(program);
-    },
-    sync: () => {
-      doSync();
-    },
-    default: () => {
-      showHelp(program);
-    }
-  };
-  return handleOptions(program, options, optionKey, version);
+  const options = parseOptions(program);
+  const optionKey = options as keyof Options;
+  return handleOptions(program, getOptions(program), optionKey, version);
 }
 
 async function doSync() {
   const s = startPrompts('Processing', 'Sync started');
-  return await execFile(getFilePath('sync.sh'), (stdout: unknown) => {
-    stopPrompt(s, 'Completed');
-    return stdout;
-  });
+  return await execFile(
+    getFilePath('sync.sh', 'scripts/build'),
+    (stdout: unknown) => {
+      stopPrompt(s, 'Completed');
+      return stdout;
+    }
+  );
 }
 
 function getDescription(version: string) {
@@ -72,12 +63,32 @@ function getErrorMsg() {
   return console.error(bold(red(msg)));
 }
 
-function getFilePath(file: string, dir: string = 'scripts') {
+function getFilePath(file: string, dir: string = 'scripts/build') {
   const fileName = fileURLToPath(import.meta.url);
   const dirName = path.dirname(fileName);
   return `${path.join(dirName, `../${dir}`)}/${file}`;
 }
 
+function getOptions(program: Command): Options {
+  return {
+    build: () => {
+      doBuild();
+    },
+    compile: () => {
+      doCompile();
+    },
+    help: () => {
+      showHelp(program);
+    },
+    sync: () => {
+      doSync();
+    },
+    default: () => {
+      showHelp(program);
+    }
+  };
+}
+
 async function getPackageInfo() {
   return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
 }
@@ -147,13 +158,21 @@ function introPrompt(msg: string) {
   return intro(msg);
 }
 
+function parseOptions(program: Command) {
+  const options = program.parse(process.argv).opts();
+  return options && Object.keys(program.opts()).toString();
+}
+
 async function runSync() {
   const s = startPrompts('Syncing', null);
-  return await execFile(getFilePath('sync.sh'), (stdout: unknown) => {
-    stopPrompt(s, 'Sync completed');
-    outro('Completed');
-    return stdout;
-  });
+  return await execFile(
+    getFilePath('sync.sh', 'scripts/build'),
+    (stdout: unknown) => {
+      stopPrompt(s, 'Sync completed');
+      outro('Completed');
+      return stdout;
+    }
+  );
 }
 
 function shouldShowHelp(program: Command, option: string) {

package/scripts/types/metadata.ts

@@ -0,0 +1,8 @@
+export interface Metadata {
+  readonly sys_id: string;
+  readonly sys_scope: string;
+  readonly package_type: string;
+  readonly PROJECT_STATE: string;
+  readonly INSTANCE_ID: string;
+  readonly BUILD_NAME: string;
+}

package/scripts/types/workspace.ts

@@ -0,0 +1,8 @@
+import { Metadata } from './metadata.js';
+
+export interface Workspace {
+  readonly ALL_APPLICATIONS: {
+    [appName: string]: Metadata;
+  };
+  readonly ACTIVE_APPLICATION: string;
+}

package/scripts/workspace.ts

@@ -1,4 +0,0 @@
-export interface Workspace {
-  readonly ACTIVE_APPLICATION: string;
-  readonly ALL_APPLICATIONS: string;
-}