sn-typescript-util 1.3.12 → 1.3.14

package/.eslintignore

@@ -1 +1,2 @@
 node_modules
+tmp

package/.eslintrc.yml

@@ -1,4 +1,3 @@
-
 extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended']
 parser: '@typescript-eslint/parser'
 plugins: ['@typescript-eslint']

package/README.md

@@ -54,14 +54,10 @@ In the application directory created by the ServiceNow Extension for VS Code, th
 
 ## Basic Workflow
 
-After installation & setup, simply run the `watch` script to start looking for TypeScript code changes in the `ts` directory.
+After installation & setup, simply run the TypeScript compiler `--watch` command to start looking for TypeScript code changes in the `ts` directory.
 
 ```bash
-npm run watch
-
-# or
-
-yarn watch
+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.

package/bin/snts.js

@@ -24,10 +24,10 @@ async function doCompile() {
     }
   );
 }
-function doOptions(program, version) {
+function doOptions(program) {
   const options = parseOptions(program);
   const optionKey = options;
-  return handleOptions(program, getOptions(program), optionKey, version);
+  return handleOptions(program, getOptions(program), optionKey);
 }
 async function doSync() {
   const s = startPrompts('Processing', 'Sync started');
@@ -36,15 +36,36 @@ async function doSync() {
     return stdout;
   });
 }
+function getConstants() {
+  let Constants;
+  (function (Constants) {
+    Constants['projectName'] = 'SN TypeScript Util';
+    Constants['projectDescription'] =
+      'is a TS utility for ServiceNow developers using VS Code.';
+    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';
+    Constants['buildOption'] =
+      'Build project utility files & package dependencies';
+    Constants['compileOption'] =
+      'Compile TypeScript files to JavaScript & move to src';
+    Constants['helpOption'] = 'Display help for command';
+    Constants['syncOption'] =
+      'Sync new instance-based src files to the ts directory';
+    Constants['versionOption'] = 'Output the current version';
+  })(Constants || (Constants = {}));
+  return Constants;
+}
 function getDescription(version) {
-  const title = 'SN TypeScript Util';
-  const description =
-    'is a TS utility for ServiceNow developers using VS Code.';
+  const constants = getConstants();
+  const title = constants.projectName;
+  const description = constants.projectDescription;
   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}`;
+  const constants = getConstants();
+  const msg = `${constants.errorMsg}\n\n${constants.docsUrl}`;
   return console.error(bold(red(msg)));
 }
 function getFilePath(file, dir = 'scripts/build') {
@@ -74,6 +95,10 @@ function getOptions(program) {
 async function getPackageInfo() {
   return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
 }
+async function getVersion() {
+  const info = await getPackageInfo();
+  return info.version;
+}
 function getWorkspace() {
   return JSON.parse(readFileSync('./system/sn-workspace.json').toString());
 }
@@ -81,8 +106,9 @@ function handleError() {
   getErrorMsg();
   return process.exit(1);
 }
-function handleOptions(program, options, option, version) {
+async function handleOptions(program, options, option) {
   if (option === 'help' || !option) {
+    const version = await getVersion();
     console.log(getDescription(version));
     showHelp(program);
   }
@@ -105,24 +131,15 @@ async function hasApplication() {
 })();
 async function init() {
   const program = new Command();
-  const info = await getPackageInfo();
-  const 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('-h, --help', 'display help for command');
-  program.option(
-    '-s, --sync',
-    'sync new instance-based src files to the ts directory'
-  );
-  program.version(version, '-v, --version', 'output the current version');
+  const constants = getConstants();
+  const version = await getVersion();
+  program.option('-b, --build', constants.buildOption);
+  program.option('-c, --compile', constants.compileOption);
+  program.option('-h, --help', constants.helpOption);
+  program.option('-s, --sync', constants.syncOption);
+  program.version(version, '-v, --version', constants.versionOption);
   program.usage(cyan('[options]'));
-  return doOptions(program, version);
+  return doOptions(program);
 }
 function introPrompt(msg) {
   return intro(msg);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sn-typescript-util",
-  "version": "1.3.12",
+  "version": "1.3.14",
   "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/utils/release.sh",
+    "release": "bun ./scripts/utils/release.ts",
     "watch": "tsc --watch"
   },
   "type": "module",
@@ -28,15 +28,14 @@
     "@types/servicenow": "^10.0.4",
     "colorette": "^2.0.20",
     "commander": "^11.1.0",
-    "npm-add-script": "^1.1.0",
     "typescript": "^5.3.3"
   },
   "devDependencies": {
     "@types/commander": "^2.12.2",
-    "@typescript-eslint/eslint-plugin": "^6.18.1",
-    "@typescript-eslint/parser": "^6.18.1",
-    "bun-types": "^1.0.22",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "bun-types": "^1.0.23",
     "eslint": "^8.56.0",
-    "prettier": "^3.1.1"
+    "prettier": "^3.2.2"
   }
 }

package/scripts/snts.ts

@@ -33,10 +33,10 @@ async function doCompile() {
   );
 }
 
-function doOptions(program: Command, version: string) {
+function doOptions(program: Command) {
   const options = parseOptions(program);
   const optionKey = options as keyof Options;
-  return handleOptions(program, getOptions(program), optionKey, version);
+  return handleOptions(program, getOptions(program), optionKey);
 }
 
 async function doSync() {
@@ -50,16 +50,31 @@ async function doSync() {
   );
 }
 
+function getConstants() {
+  enum Constants {
+    projectName = 'SN TypeScript Util',
+    projectDescription = 'is a TS utility for ServiceNow developers using VS Code.',
+    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',
+    buildOption = 'Build project utility files & package dependencies',
+    compileOption = 'Compile TypeScript files to JavaScript & move to src',
+    helpOption = 'Display help for command',
+    syncOption = 'Sync new instance-based src files to the ts directory',
+    versionOption = 'Output the current version'
+  }
+  return Constants;
+}
+
 function getDescription(version: string) {
-  const title = 'SN TypeScript Util';
-  const description =
-    'is a TS utility for ServiceNow developers using VS Code.';
+  const constants = getConstants();
+  const title: string = constants.projectName;
+  const description: string = constants.projectDescription;
   return `${bold(magenta(title))} ${description} ${gray(`(v${version})`)}\n`;
 }
 
 function getErrorMsg() {
-  const url: string = `https://docs.servicenow.com/bundle/vancouver-application-development/page/build/applications/task/create-project.html`;
-  const msg: string = `No active application detected. Please create a project with the ServiceNow Extension for VS Code.\n\n${url}`;
+  const constants = getConstants();
+  const msg: string = `${constants.errorMsg}\n\n${constants.docsUrl}`;
   return console.error(bold(red(msg)));
 }
 
@@ -93,6 +108,11 @@ async function getPackageInfo() {
   return JSON.parse(readFileSync(getFilePath('package.json', '.')).toString());
 }
 
+async function getVersion() {
+  const info = await getPackageInfo();
+  return info.version;
+}
+
 function getWorkspace() {
   return JSON.parse(readFileSync('./system/sn-workspace.json').toString());
 }
@@ -102,13 +122,13 @@ function handleError() {
   return process.exit(1);
 }
 
-function handleOptions(
+async function handleOptions(
   program: Command,
   options: Options,
-  option: keyof Options,
-  version: string
+  option: keyof Options
 ) {
   if (option === 'help' || !option) {
+    const version = await getVersion();
     console.log(getDescription(version));
     showHelp(program);
   }
@@ -134,24 +154,15 @@ async function hasApplication() {
 
 async function init() {
   const program = new Command();
-  const info = await getPackageInfo();
-  const 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('-h, --help', 'display help for command');
-  program.option(
-    '-s, --sync',
-    'sync new instance-based src files to the ts directory'
-  );
-  program.version(version, '-v, --version', 'output the current version');
+  const constants = getConstants();
+  const version = await getVersion();
+  program.option('-b, --build', constants.buildOption);
+  program.option('-c, --compile', constants.compileOption);
+  program.option('-h, --help', constants.helpOption);
+  program.option('-s, --sync', constants.syncOption);
+  program.version(version, '-v, --version', constants.versionOption);
   program.usage(cyan('[options]'));
-  return doOptions(program, version);
+  return doOptions(program);
 }
 
 function introPrompt(msg: string) {

package/scripts/types/version.ts

@@ -0,0 +1,6 @@
+type VersionType = 'patch' | 'minor' | 'major';
+
+export interface Version {
+  value: VersionType;
+  label: Capitalize<VersionType>;
+}

package/scripts/utils/release.ts

@@ -0,0 +1,80 @@
+import { $ } from 'execa';
+import path from 'path';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { cancel, confirm, intro, outro, select, spinner } from '@clack/prompts';
+import { Version } from './../types/version.js';
+
+async function bumpVersion(releaseType) {
+  return await $`npm version ${releaseType} --no-git-tag-version`;
+}
+
+async function confirmVersion(version: string) {
+  return await confirm({
+    message: `Bump to ${version}?`
+  });
+}
+
+async function doGitOperation(version: string) {
+  const msg = 'chore: bump the version';
+  await $`git commit -a -m ${msg}`;
+  await $`git tag ${version}`;
+  await $`git push`;
+  await $`git push origin ${version}`;
+}
+
+async function doOperation(shouldContinue, version: string) {
+  if (shouldContinue) {
+    const s = spinner();
+    s.start('Start release');
+    await doGitOperation(version);
+    await doPublish();
+    s.stop('Done.');
+    outro("You're all set!");
+  } else {
+    cancel('Operation cancelled.');
+    await $`git checkout package.json`;
+  }
+}
+
+async function doPublish() {
+  return await $`npm publish`;
+}
+
+function getFilePath(file: string, dir: string) {
+  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());
+}
+
+async function getReleaseTypes() {
+  return select({
+    message: 'Please pick a release type.',
+    options: getOptions()
+  });
+}
+
+function getOptions(): Version[] {
+  return [
+    { value: 'patch', label: 'Patch' },
+    { value: 'minor', label: 'Minor' },
+    { value: 'major', label: 'Major' }
+  ];
+}
+
+async function getVersion() {
+  const file = await getPackageInfo();
+  return file.version;
+}
+
+(async function init() {
+  intro('Release Utils');
+  const releaseType = await getReleaseTypes();
+  const version = (await bumpVersion(releaseType)) && (await getVersion());
+  const shouldContinue = await confirmVersion(version);
+  return await doOperation(shouldContinue, version);
+})();

package/scripts/utils/release.sh

@@ -1,21 +0,0 @@
-#!/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)
-  git push
-  git push origin $(get_package_version)
-}
-
-get_package_version() {
-  version=`node -p "require('./package.json').version"`
-  echo "v$version"
-}
-
-bump_version "$1"