sn-typescript-util 1.3.9 → 1.3.11

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,10 +16,13 @@ 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();
@@ -33,20 +36,20 @@ function doOptions(program, version) {
       doCompile();
     },
     help: () => {
-      program.help();
+      showHelp(program);
     },
     sync: () => {
       doSync();
     },
     default: () => {
-      program.help();
+      showHelp(program);
     }
   };
   return handleOptions(program, options, 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;
   });
@@ -55,14 +58,14 @@ function getDescription(version) {
   const title = 'SN TypeScript Util';
   const description =
     'is a TS utility for ServiceNow developers using VS Code.';
-  return `${bold(magenta(title))} ${description} ${gray(`(${version})`)}\n`;
+  return `${bold(magenta(title))} ${description} ${gray(`(v${version})`)}\n`;
 }
 function getErrorMsg() {
   const url = `https://docs.servicenow.com/bundle/vancouver-application-development/page/build/applications/task/create-project.html`;
   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}`;
@@ -80,7 +83,7 @@ function handleError() {
 function handleOptions(program, options, option, version) {
   if (option === 'help' || !option) {
     console.log(getDescription(version));
-    program.help();
+    showHelp(program);
   }
   return (
     shouldShowHelp(program, option) ||
@@ -103,7 +106,6 @@ async function init() {
   const program = new Command();
   const info = await getPackageInfo();
   const version = info.version;
-  program.version(version, '-v, --version', 'output the current version');
   program.option(
     '-b, --build',
     'build project utility files & package dependencies'
@@ -112,11 +114,12 @@ async function init() {
     '-c, --compile',
     'compile TypeScript files to JavaScript & move to src'
   );
+  program.option('-h, --help', 'display help for command');
   program.option(
     '-s, --sync',
     'sync new instance-based src files to the ts directory'
   );
-  program.option('-h, --help', 'display help for command');
+  program.version(version, '-v, --version', 'output the current version');
   program.usage(cyan('[options]'));
   return doOptions(program, version);
 }
@@ -125,7 +128,7 @@ function introPrompt(msg) {
 }
 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.9",
+  "version": "1.3.11",
   "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/util')
 
 module ServiceNow
   class Build

package/scripts/{sync.sh → build/sync.sh}

@@ -15,14 +15,14 @@ get_project_name() {
 }
 
 sync() {
-  interface_dir="Interfaces"
+  types_dir="Types"
   src_path="$(get_project_name system/sn-workspace.json ACTIVE_APPLICATION)/src"
   ts_path="$(get_project_name system/sn-workspace.json ACTIVE_APPLICATION)/ts"
   clean_build "$build_dir"
   if [ -d "$ts_path" ]; then
     find "$ts_path" -name "*.ts" -exec sh -c 'mv "$0" "${0%.ts}.js"' {} \;
   fi
-  rsync --ignore-existing --delete-after -raz --progress --prune-empty-dirs --include "*/" --include "*.js" --exclude="*" "$interface_dir" "$src_path/" "$ts_path"
+  rsync --ignore-existing --delete-after -raz --progress --prune-empty-dirs --include "*/" --include "*.js" --exclude="*" "$types_dir" "$src_path/" "$ts_path"
   find "$ts_path" -name "*.js" -exec sh -c 'mv "$0" "${0%.js}.ts"' {} \;
 }
 

package/scripts/snts.ts

@@ -7,24 +7,30 @@ 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) {
@@ -39,13 +45,13 @@ function doOptions(program: Command, version: string) {
       doCompile();
     },
     help: () => {
-      program.help();
+      showHelp(program);
     },
     sync: () => {
       doSync();
     },
     default: () => {
-      program.help();
+      showHelp(program);
     }
   };
   return handleOptions(program, options, optionKey, version);
@@ -53,17 +59,20 @@ function doOptions(program: Command, version: string) {
 
 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) {
   const title = 'SN TypeScript Util';
   const description =
     'is a TS utility for ServiceNow developers using VS Code.';
-  return `${bold(magenta(title))} ${description} ${gray(`(${version})`)}\n`;
+  return `${bold(magenta(title))} ${description} ${gray(`(v${version})`)}\n`;
 }
 
 function getErrorMsg() {
@@ -72,7 +81,7 @@ 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}`;
@@ -99,7 +108,7 @@ function handleOptions(
 ) {
   if (option === 'help' || !option) {
     console.log(getDescription(version));
-    program.help();
+    showHelp(program);
   }
   return (
     shouldShowHelp(program, option) ||
@@ -125,7 +134,6 @@ async function init() {
   const program = new Command();
   const info = await getPackageInfo();
   const version = info.version;
-  program.version(version, '-v, --version', 'output the current version');
   program.option(
     '-b, --build',
     'build project utility files & package dependencies'
@@ -134,11 +142,12 @@ async function init() {
     '-c, --compile',
     'compile TypeScript files to JavaScript & move to src'
   );
+  program.option('-h, --help', 'display help for command');
   program.option(
     '-s, --sync',
     'sync new instance-based src files to the ts directory'
   );
-  program.option('-h, --help', 'display help for command');
+  program.version(version, '-v, --version', 'output the current version');
   program.usage(cyan('[options]'));
   return doOptions(program, version);
 }
@@ -149,11 +158,14 @@ function introPrompt(msg: string) {
 
 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;
-}