sn-typescript-util 1.4.2 → 1.5.1

package/README.md

@@ -29,7 +29,7 @@ Using TypeScript, the CLI provides an enhanced developer workflow.
 
 - [Node.js](https://nodejs.org/)
 - [ServiceNow Extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ServiceNow.now-vscode)
-- An [imported application](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/washingtondc-application-development/page/build/applications/task/vscode-import-application.html) in VS Code
 
 **[Back to top](#table-of-contents)**
 
@@ -59,7 +59,7 @@ After installation & setup, simply run the TypeScript compiler `--watch` command
 tsc --watch
 ```
 
-Any JavaScript ES2015 (ES6) code added will get converted down to ES5 and moved to the `src` directory. Then changes are ready to sync with the target instance using the ServiceNow Extension for VS Code.
+The TypeScript will get transpiled to ES5 (or other ECMAScript target) and moved to the `src` directory. Then changes are ready to sync with the target instance using the ServiceNow Extension for VS Code.
 
 **[Back to top](#table-of-contents)**
 

package/bin/snts.js

@@ -3,21 +3,63 @@ import { $ } from 'execa';
 import { Command } from 'commander';
 import { execFile } from 'node:child_process';
 import path from 'path';
-import { readFileSync, writeFileSync } from 'fs';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
 import { fileURLToPath } from 'url';
-import { bold, cyan, gray, magenta, red } from 'colorette';
-import { intro, outro, spinner } from '@clack/prompts';
+import { bold, cyan, gray, green, magenta, red } from 'colorette';
+import { confirm, intro, outro, select, spinner } from '@clack/prompts';
+async function addFile(sourcefile, sourceDir, targetFile, targetDir, message) {
+  if (await confirmFile(message)) {
+    const file = await getTargetPath(targetFile, targetDir);
+    const filePath = getFilePath(sourcefile, sourceDir);
+    createFile(file, filePath);
+  }
+}
+async function addInterfaceFile() {
+  return await addFile(
+    'base-table.ts',
+    'scripts/templates',
+    'BaseTable.ts',
+    'ts/Types',
+    `${getConstants().confirmInterfaceMsg}`
+  );
+}
+async function addPrettierFile() {
+  return await addFile(
+    '.prettierrc.json',
+    'scripts/templates',
+    '.prettierrc.json',
+    null,
+    `${getConstants().confirmPrettierMsg}`
+  );
+}
+async function confirmFile(msg) {
+  return await confirm({
+    message: `${msg}`
+  });
+}
+async function createFile(file, path) {
+  const template = readFileSync(path, 'utf8');
+  return await writeFile(file, template);
+}
 async function createTemplate(file, path) {
   const project = await getProject();
   const template = readFileSync(path, 'utf8');
-  const updatedContent = template.replace(/@project/g, project);
-  return await writeFile(file, updatedContent);
+  const data = template.replace(/@project/g, project);
+  return await writeFile(file, data);
 }
 async function doBuild() {
-  const s = startPrompts('Installing configs', 'Build started');
+  introPrompt(`${bold(magenta(getConstants().projectName))}: Build`);
+  const esVersion = await getConfigTypes();
+  await addInterfaceFile();
+  await addPrettierFile();
+  await initGitRepo();
+  const s = startPrompts('Installing config(s)', null);
   const filePath = getFilePath('tsconfig.json', 'scripts/templates');
   await createTemplate('tsconfig.json', filePath);
-  stopPrompt(s, 'Configs installed');
+  const template = readFileSync('tsconfig.json', 'utf8');
+  const data = template.replace(/@version/g, esVersion);
+  await writeFile('tsconfig.json', data);
+  stopPrompt(s, `The ${cyan('tsconfig.json')} file was bootstrapped.`);
   runSync();
 }
 async function doClean() {
@@ -43,16 +85,37 @@ async function doSync() {
     return stdout;
   });
 }
+function getConfigTargets() {
+  return [
+    { value: 'es5', label: 'ES5', hint: 'recommended' },
+    { value: 'es6', label: 'ES2015', hint: 'ES6' },
+    { value: 'es2021', label: 'ES2021' }
+  ];
+}
+async function getConfigTypes() {
+  return select({
+    message: 'Please pick a ECMAScript target.',
+    options: getConfigTargets()
+  });
+}
 function getConstants() {
   let Constants;
   (function (Constants) {
     Constants['projectName'] = 'SN TypeScript Util';
     Constants['projectDescription'] =
       'is a TS utility for ServiceNow developers using VS Code.';
+    Constants[
+      (Constants['confirmInterfaceMsg'] =
+        `Add a ${cyan('BaseTable.ts')} interface with global default fields?`)
+    ] = 'confirmInterfaceMsg';
+    Constants[
+      (Constants['confirmPrettierMsg'] =
+        `Add a ${cyan('.prettierrc.json')} default config?`)
+    ] = 'confirmPrettierMsg';
     Constants['errorMsg'] =
       'No active application detected. Please create a project with the ServiceNow Extension for VS Code.';
     Constants['docsUrl'] =
-      'https://docs.servicenow.com/bundle/vancouver-application-development/page/build/applications/task/create-project.html';
+      'https://docs.servicenow.com/bundle/washingtondc-application-development/page/build/applications/task/create-project.html';
     Constants['buildOption'] =
       'Build project utility files & package dependencies';
     Constants['compileOption'] =
@@ -76,7 +139,7 @@ function getErrorMsg() {
   const msg = `${constants.errorMsg}\n\n${constants.docsUrl}`;
   return console.error(bold(red(msg)));
 }
-function getFilePath(file, dir = 'scripts/build') {
+function getFilePath(file, dir) {
   const fileName = fileURLToPath(import.meta.url);
   const dirName = path.dirname(fileName);
   return `${path.join(dirName, `../${dir}`)}/${file}`;
@@ -110,6 +173,12 @@ async function getProject() {
   const workspace = await getWorkspace();
   return workspace.ACTIVE_APPLICATION;
 }
+async function getTargetPath(file, dir) {
+  const project = await getProject();
+  const path = dir ? `${project}/${dir}/` : '.';
+  dir && !existsSync(path) && mkdirSync(path, { recursive: true });
+  return `${path}/${file}`;
+}
 async function getVersion() {
   const info = await getPackageInfo();
   return info.version;
@@ -157,6 +226,10 @@ async function init() {
   program.usage(cyan('[options]'));
   return doOptions(program);
 }
+async function initGitRepo() {
+  const msg = `Initialize a new git repository?`;
+  return (await confirmFile(msg)) && (await $`git init`);
+}
 function introPrompt(msg) {
   return intro(msg);
 }
@@ -165,10 +238,14 @@ function parseOptions(program) {
   return options && Object.keys(program.opts()).toString();
 }
 async function runSync() {
+  const project = await getProject();
   const s = startPrompts('Syncing', null);
   return await execFile(getFilePath('sync.sh', 'scripts/build'), (stdout) => {
-    stopPrompt(s, 'Sync completed');
-    outro('Completed');
+    stopPrompt(
+      s,
+      `TypeScript files constructed in the ${cyan(project + '/ts')} directory.`
+    );
+    outro(`${green('Done!')}`);
     return stdout;
   });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sn-typescript-util",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "description": "A TypeScript utility for ServiceNow developers using VS Code",
   "bin": {
     "snts": "bin/snts.js"
@@ -27,15 +27,15 @@
     "@clack/prompts": "^0.7.0",
     "colorette": "^2.0.20",
     "commander": "^12.0.0",
-    "execa": "^8.0.1",
+    "execa": "^9.1.0",
     "typescript": "^5.4.5"
   },
   "devDependencies": {
-    "@eslint/js": "^9.0.0",
+    "@eslint/js": "^9.3.0",
     "@types/commander": "^2.12.2",
-    "bun-types": "^1.1.3",
-    "eslint": "^9.0.0",
+    "bun-types": "^1.1.8",
+    "eslint": "^9.3.0",
     "prettier": "^3.2.5",
-    "typescript-eslint": "^7.7.0"
+    "typescript-eslint": "^7.9.0"
   }
 }

package/scripts/snts.ts

@@ -4,25 +4,78 @@ import { $ } from 'execa';
 import { Command } from 'commander';
 import { execFile } from 'node:child_process';
 import path from 'path';
-import { readFileSync, writeFileSync } from 'fs';
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
 import { fileURLToPath } from 'url';
-import { bold, cyan, gray, magenta, red } from 'colorette';
-import { intro, outro, spinner } from '@clack/prompts';
+import { bold, cyan, gray, green, magenta, red } from 'colorette';
+import { confirm, intro, outro, select, spinner } from '@clack/prompts';
 import { Options } from './types/options.js';
 import { Workspace } from './types/workspace.js';
 
+async function addFile(
+  sourcefile: string,
+  sourceDir: string,
+  targetFile: string,
+  targetDir: string | any,
+  message: string
+) {
+  if (await confirmFile(message)) {
+    const file = await getTargetPath(targetFile, targetDir);
+    const filePath = getFilePath(sourcefile, sourceDir);
+    createFile(file, filePath);
+  }
+}
+
+async function addInterfaceFile() {
+  return await addFile(
+    'base-table.ts',
+    'scripts/templates',
+    'BaseTable.ts',
+    'ts/Types',
+    `${getConstants().confirmInterfaceMsg}`
+  );
+}
+
+async function addPrettierFile() {
+  return await addFile(
+    '.prettierrc.json',
+    'scripts/templates',
+    '.prettierrc.json',
+    null,
+    `${getConstants().confirmPrettierMsg}`
+  );
+}
+
+async function confirmFile(msg: string) {
+  return await confirm({
+    message: `${msg}`
+  });
+}
+
+async function createFile(file: string, path: string): Promise<void> {
+  const template = readFileSync(path, 'utf8');
+  return await writeFile(file, template);
+}
+
 async function createTemplate(file: string, path: string): Promise<void> {
   const project = await getProject();
   const template = readFileSync(path, 'utf8');
-  const updatedContent = template.replace(/@project/g, project);
-  return await writeFile(file, updatedContent);
+  const data = template.replace(/@project/g, project);
+  return await writeFile(file, data);
 }
 
 async function doBuild() {
-  const s = startPrompts('Installing configs', 'Build started');
+  introPrompt(`${bold(magenta(getConstants().projectName))}: Build`);
+  const esVersion: any = await getConfigTypes();
+  await addInterfaceFile();
+  await addPrettierFile();
+  await initGitRepo();
+  const s = startPrompts('Installing config(s)', null);
   const filePath = getFilePath('tsconfig.json', 'scripts/templates');
   await createTemplate('tsconfig.json', filePath);
-  stopPrompt(s, 'Configs installed');
+  const template = readFileSync('tsconfig.json', 'utf8');
+  const data = template.replace(/@version/g, esVersion);
+  await writeFile('tsconfig.json', data);
+  stopPrompt(s, `The ${cyan('tsconfig.json')} file was bootstrapped.`);
   runSync();
 }
 
@@ -56,12 +109,29 @@ async function doSync() {
   );
 }
 
+function getConfigTargets() {
+  return [
+    { value: 'es5', label: 'ES5', hint: 'recommended' },
+    { value: 'es6', label: 'ES2015', hint: 'ES6' },
+    { value: 'es2021', label: 'ES2021' }
+  ];
+}
+
+async function getConfigTypes() {
+  return select({
+    message: 'Please pick a ECMAScript target.',
+    options: getConfigTargets()
+  });
+}
+
 function getConstants() {
   enum Constants {
     projectName = 'SN TypeScript Util',
     projectDescription = 'is a TS utility for ServiceNow developers using VS Code.',
+    confirmInterfaceMsg = `Add a ${cyan('BaseTable.ts')} interface with global default fields?`,
+    confirmPrettierMsg = `Add a ${cyan('.prettierrc.json')} default config?`,
     errorMsg = 'No active application detected. Please create a project with the ServiceNow Extension for VS Code.',
-    docsUrl = 'https://docs.servicenow.com/bundle/vancouver-application-development/page/build/applications/task/create-project.html',
+    docsUrl = 'https://docs.servicenow.com/bundle/washingtondc-application-development/page/build/applications/task/create-project.html',
     buildOption = 'Build project utility files & package dependencies',
     compileOption = 'Compile TypeScript files to JavaScript & move to src',
     helpOption = 'Display help for command',
@@ -85,7 +155,7 @@ function getErrorMsg() {
   return console.error(bold(red(msg)));
 }
 
-function getFilePath(file: string, dir: string = 'scripts/build') {
+function getFilePath(file: string, dir: string) {
   const fileName = fileURLToPath(import.meta.url);
   const dirName = path.dirname(fileName);
   return `${path.join(dirName, `../${dir}`)}/${file}`;
@@ -123,6 +193,13 @@ async function getProject() {
   return workspace.ACTIVE_APPLICATION;
 }
 
+async function getTargetPath(file: string, dir: string) {
+  const project = await getProject();
+  const path = dir ? `${project}/${dir}/` : '.';
+  dir && !existsSync(path) && mkdirSync(path, { recursive: true });
+  return `${path}/${file}`;
+}
+
 async function getVersion() {
   const info = await getPackageInfo();
   return info.version;
@@ -181,6 +258,11 @@ async function init() {
   return doOptions(program);
 }
 
+async function initGitRepo() {
+  const msg = `Initialize a new git repository?`;
+  return (await confirmFile(msg)) && (await $`git init`);
+}
+
 function introPrompt(msg: string) {
   return intro(msg);
 }
@@ -191,12 +273,16 @@ function parseOptions(program: Command) {
 }
 
 async function runSync() {
+  const project = await getProject();
   const s = startPrompts('Syncing', null);
   return await execFile(
     getFilePath('sync.sh', 'scripts/build'),
     (stdout: unknown) => {
-      stopPrompt(s, 'Sync completed');
-      outro('Completed');
+      stopPrompt(
+        s,
+        `TypeScript files constructed in the ${cyan(project + '/ts')} directory.`
+      );
+      outro(`${green('Done!')}`);
       return stdout;
     }
   );

package/scripts/templates/base-table.ts

@@ -0,0 +1,8 @@
+interface BaseTable {
+  readonly sys_created_on?: Date;
+  readonly sys_created_by?: string;
+  readonly sys_id?: string;
+  readonly sys_mod_count?: number;
+  readonly sys_updated_by?: string;
+  readonly sys_updated_on?: Date;
+}

package/scripts/templates/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "es5",
+    "target": "@version",
     "outDir": "@project/src",
     "baseUrl": ".",
     "skipLibCheck": true