sn-typescript-util 1.3.2 → 1.3.4

package/README.md

@@ -11,6 +11,7 @@ A [TypeScript](https://www.typescriptlang.org/) CLI utility that works on-top of
 1. [Installation and Setup](#installation-and-setup)
 1. [Basic Workflow](#basic-workflow)
 1. [Commands](#commands)
+1. [Project Structure](#project-structure)
 1. [License](#license)
 
 ## Benefits
@@ -27,9 +28,9 @@ Using TypeScript, the CLI provides an enhanced developer workflow.
 ## Prerequisites
 
 - [Node.js](https://nodejs.org/)
-- [Visual Studio Code](https://code.visualstudio.com/)
+- [Ruby](https://www.ruby-lang.org/en/documentation/installation/)
 - [ServiceNow Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ServiceNow.now-vscode)
-- 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
+- An [imported application](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)**
 
@@ -137,6 +138,52 @@ snts -V
 
 **[Back to top](#table-of-contents)**
 
+## Project Structure
+
+Inside of the application directory (after the build), the project structure will look something like this.
+
+```text
+/
+├── background scripts/
+├── scratch/
+├── src/
+│   ├── Server Development/
+│   │   └── Script Includes/
+│   │       └── DataService.script.js
+│   │       └── Utils.script.js
+│   └── Service Portal/
+│       └── Widgets/
+│           └── Dashboard/
+│               └── Dashboard.client_script.js
+│               └── Dashboard.css.scss
+│               └── Dashboard.demo_data.json
+│               └── Dashboard.link.js
+│               └── Dashboard.option_schema.json
+│               └── Dashboard.script.js
+│               └── Dashboard.template.html
+├── system/
+├── ts/
+│   ├── Server Development/
+│   │   └── Script Includes/
+│   │       └── DataService.script.ts
+│   │       └── Utils.script.ts
+│   ├── Service Portal/
+│   │   └── Widgets/
+│   │       └── Dashboard/
+│   │            └── Dashboard.client_script.ts
+│   │            └── Dashboard.link.ts
+│   │            └── Dashboard.script.ts
+│   └── Types/
+│       └── Table.ts
+│       └── User.ts
+├── .eslintrc
+└── app.config.json
+```
+
+This example project has two script includes, a widget, and a `Types` directory for interfaces & types.
+
+**[Back to top](#table-of-contents)**
+
 ## License
 
 [MIT License](LICENSE)

package/bin/snts.js

@@ -7,111 +7,113 @@ 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 handleOptions(program, options, option);
 }
 async function doSync() {
-  const s = startPrompts('Processing', 'Sync started');
-  return await execFile(getFilePath('sync.sh'), (stdout) => {
-    stopPrompt(s, 'Completed');
-    return stdout;
-  });
+    const s = startPrompts('Processing', 'Sync started');
+    return await execFile(getFilePath('sync.sh'), (stdout) => {
+        stopPrompt(s, 'Completed');
+        return stdout;
+    });
 }
 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)));
+    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') {
-  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());
+}
+function handleOptions(program, options, option) {
+    return (shouldShowHelp(program, option) ||
+        ((hasApplication() && options[option]) || showHelp(program))());
 }
 async function hasApplication() {
-  try {
-    const workspace = await getWorkspace();
-    const app = workspace.ACTIVE_APPLICATION;
-    return Object.entries(app).length === 0 ? getErrorMsg() : true;
-  } catch (e) {
-    getErrorMsg();
-    return process.exit(1);
-  }
+    try {
+        const workspace = await getWorkspace();
+        const 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 runSync() {
-  const s = startPrompts('Syncing', null);
-  return await execFile(getFilePath('sync.sh'), (stdout) => {
-    stopPrompt(s, 'Sync completed');
-    outro('Completed');
-    return stdout;
-  });
+    const s = startPrompts('Syncing', null);
+    return await execFile(getFilePath('sync.sh'), (stdout) => {
+        stopPrompt(s, 'Sync completed');
+        outro('Completed');
+        return stdout;
+    });
+}
+function shouldShowHelp(program, option) {
+    return !option && showHelp(program);
+}
+function showHelp(program) {
+    return program.help();
 }
 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.3.2",
+  "version": "1.3.4",
   "description": "A TypeScript utility for ServiceNow developers using VS Code",
   "bin": {
     "snts": "bin/snts.js"
@@ -25,17 +25,17 @@
   "type": "module",
   "dependencies": {
     "@clack/prompts": "^0.7.0",
-    "@types/servicenow": "^10.0.2",
+    "@types/servicenow": "^10.0.4",
     "colorette": "^2.0.20",
     "commander": "^11.1.0",
     "npm-add-script": "^1.1.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.3"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.8.0",
-    "@typescript-eslint/parser": "^6.8.0",
-    "bun-types": "^1.0.6",
-    "eslint": "^8.51.0",
-    "prettier": "^3.0.3"
+    "@typescript-eslint/eslint-plugin": "^6.15.0",
+    "@typescript-eslint/parser": "^6.15.0",
+    "bun-types": "^1.0.18-1",
+    "eslint": "^8.56.0",
+    "prettier": "^3.1.1"
   }
 }

package/scripts/options.ts

@@ -0,0 +1,6 @@
+export type Options = {
+  build: () => void;
+  compile: () => void;
+  sync: () => void;
+  default: () => void;
+};

package/scripts/snts.ts

@@ -7,11 +7,12 @@ import { readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
 import { bold, red } from 'colorette';
 import { intro, outro, spinner } from '@clack/prompts';
+import { Options } from './options.js';
 import { Workspace } from './workspace.js';
 
 async function doBuild() {
   const s = startPrompts('Installing configs', 'Build started');
-  return await execFile(getFilePath('init.rb'), (stdout) => {
+  return await execFile(getFilePath('init.rb'), (stdout: unknown) => {
     stopPrompt(s, 'Configs installed');
     runSync();
     return stdout;
@@ -20,7 +21,7 @@ async function doBuild() {
 
 async function doCompile() {
   const s = startPrompts('Processing', 'Compile started');
-  return await execFile(getFilePath('compile.rb'), (stdout) => {
+  return await execFile(getFilePath('compile.rb'), (stdout: unknown) => {
     stopPrompt(s, 'Completed');
     return stdout;
   });
@@ -29,7 +30,7 @@ async function doCompile() {
 function doOptions(program: any) {
   program.parse(process.argv).opts();
   const option: string = Object.keys(program.opts()).toString();
-  const options: any = {
+  const options: Options = {
     build: () => {
       doBuild();
     },
@@ -43,12 +44,12 @@ function doOptions(program: any) {
       program.help();
     }
   };
-  return ((hasApplication() && options[option]) || options['default'])();
+  return handleOptions(program, options, option);
 }
 
 async function doSync() {
   const s = startPrompts('Processing', 'Sync started');
-  return await execFile(getFilePath('sync.sh'), (stdout: any) => {
+  return await execFile(getFilePath('sync.sh'), (stdout: unknown) => {
     stopPrompt(s, 'Completed');
     return stdout;
   });
@@ -74,6 +75,13 @@ function getWorkspace() {
   return JSON.parse(readFileSync('./system/sn-workspace.json').toString());
 }
 
+function handleOptions(program: any, options: Options, option: string) {
+  return (
+    shouldShowHelp(program, option) ||
+    ((hasApplication() && options[option]) || showHelp(program))()
+  );
+}
+
 async function hasApplication() {
   try {
     const workspace: Workspace = await getWorkspace();
@@ -115,13 +123,21 @@ function introPrompt(msg: string) {
 
 async function runSync() {
   const s = startPrompts('Syncing', null);
-  return await execFile(getFilePath('sync.sh'), (stdout) => {
+  return await execFile(getFilePath('sync.sh'), (stdout: unknown) => {
     stopPrompt(s, 'Sync completed');
     outro('Completed');
     return stdout;
   });
 }
 
+function shouldShowHelp(program: any, option: string) {
+  return !option && showHelp(program);
+}
+
+function showHelp(program: any) {
+  return program.help();
+}
+
 function startPrompts(start: string, intro: string | null) {
   intro && introPrompt(intro);
   const s = spinner();