@socketsecurity/cli 0.4.2 → 0.5.2

package/lib/utils/api-helpers.js

@@ -4,12 +4,13 @@ import { ErrorWithCause } from 'pony-cause'
 import { AuthError } from './errors.js'
 
 /**
- * @template T
+ * @template {import('@socketsecurity/sdk').SocketSdkOperations} T
+ * @param {T} _name
  * @param {import('@socketsecurity/sdk').SocketSdkErrorType<T>} result
  * @param {import('ora').Ora} spinner
  * @returns {void}
  */
-export function handleUnsuccessfulApiResponse (result, spinner) {
+export function handleUnsuccessfulApiResponse (_name, result, spinner) {
   const resultError = 'error' in result && result.error && typeof result.error === 'object' ? result.error : {}
   const message = 'message' in resultError && typeof resultError.message === 'string' ? resultError.message : 'No error message returned'
 

package/lib/utils/flags.js

@@ -0,0 +1,27 @@
+/**
+ * @typedef FlagExtensions
+ * @property {string} description
+ */
+
+/**
+ * @template {import('meow').FlagType} Type
+ * @template Default
+ * @template {boolean} [IsMultiple=false]
+ * @typedef {import('meow').Flag<Type, Default, IsMultiple> & FlagExtensions} Flag
+ */
+
+/** @typedef {Flag<'string', string> | Flag<'string', string[], true>} StringFlag */
+/** @typedef {Flag<'boolean', boolean> | Flag<'boolean', boolean[], true>} BooleanFlag */
+/** @typedef {Flag<'number', number> | Flag<'number', number[], true>} NumberFlag */
+/** @typedef {StringFlag | BooleanFlag | NumberFlag} AnyFlag */
+/** @typedef {Record<string, AnyFlag>} AnyFlags */
+
+/**
+ * @template {AnyFlags} Flags
+ * @param {Flags} flags
+ * @returns {Readonly<Flags>}
+ */
+export function prepareFlags (flags) {
+  // As we can't do "satisfies AnyFlags" in JS yet (+ we add a bonus through Readonly<>)
+  return flags
+}

package/lib/utils/formatting.js

@@ -1,12 +1,23 @@
 /** @typedef {string|{ description: string }} ListDescription */
 
+/**
+ * @typedef HelpListOptions
+ * @property {string} [keyPrefix]
+ * @property {number} [padName]
+ */
+
 /**
  * @param {Record<string,ListDescription>} list
  * @param {number} indent
- * @param {number} padName
+ * @param {HelpListOptions} options
  * @returns {string}
  */
-export function printHelpList (list, indent, padName = 18) {
+export function printHelpList (list, indent, options = {}) {
+  const {
+    keyPrefix = '',
+    padName = 18,
+  } = options
+
   const names = Object.keys(list).sort()
 
   let result = ''
@@ -15,22 +26,22 @@ export function printHelpList (list, indent, padName = 18) {
     const rawDescription = list[name]
     const description = (typeof rawDescription === 'object' ? rawDescription.description : rawDescription) || ''
 
-    result += ''.padEnd(indent) + name.padEnd(padName) + description + '\n'
+    result += ''.padEnd(indent) + (keyPrefix + name).padEnd(padName) + description + '\n'
   }
 
   return result.trim()
 }
 
 /**
- * @param {Record<string,ListDescription>} list
+ * @param {Record<string, ListDescription>} list
  * @param {number} indent
- * @param {number} padName
+ * @param {HelpListOptions} options
  * @returns {string}
  */
- export function printFlagList (list, indent, padName = 18) {
+export function printFlagList (list, indent, options = {}) {
   return printHelpList({
-    '--help': 'Print this help and exits.',
-    '--version': 'Prints current version and exits.',
+    'help': 'Print this help and exits.',
+    'version': 'Prints current version and exits.',
     ...list,
-  }, indent, padName)
+  }, indent, { keyPrefix: '--', ...options })
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socketsecurity/cli",
-  "version": "0.4.2",
+  "version": "0.5.2",
   "description": "CLI tool for Socket.dev",
   "homepage": "http://github.com/SocketDev/socket-cli-js",
   "repository": {
@@ -15,18 +15,24 @@
   },
   "license": "MIT",
   "engines": {
-    "node": "^14.18.0 || >=16.0.0"
+    "node": "^14.18.0 || ^16.13.0 || >=18.0.0"
   },
   "type": "module",
   "bin": {
-    "socket": "cli.js"
+    "socket": "cli.js",
+    "socket-npm": "lib/shadow/npm-cli.cjs",
+    "socket-npx": "lib/shadow/npx-cli.cjs"
   },
   "files": [
     "cli.js",
-    "lib/**/*.js"
+    "lib/**/*.js",
+    "lib/**/*.json",
+    "lib/**/*.cjs",
+    "lib/shadow/**"
   ],
   "scripts": {
-    "check:dependency-check": "dependency-check '*.js' 'test/**/*.js' --no-dev",
+    "echo": "echo $PATH",
+    "check:dependency-check": "dependency-check '*.js' 'lib/shadow/*.cjs' '*.mjs' 'test/**/*.js' --no-dev",
     "check:installed-check": "installed-check -i eslint-plugin-jsdoc",
     "check:lint": "eslint --report-unused-disable-directives .",
     "check:tsc": "tsc",
@@ -45,8 +51,11 @@
     "@types/mocha": "^10.0.0",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^14.18.31",
+    "@types/npm": "^7.19.0",
+    "@types/npmcli__arborist": "^5.6.1",
     "@types/prompts": "^2.4.1",
     "@types/update-notifier": "^6.0.2",
+    "@types/which": "^2.0.2",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "@typescript-eslint/parser": "^5.51.0",
     "c8": "^7.12.0",
@@ -76,7 +85,7 @@
   "dependencies": {
     "@apideck/better-ajv-errors": "^0.3.6",
     "@socketsecurity/config": "^2.0.0",
-    "@socketsecurity/sdk": "^0.5.2",
+    "@socketsecurity/sdk": "^0.5.4",
     "chalk": "^5.1.2",
     "globby": "^13.1.3",
     "hpagent": "^1.2.0",
@@ -89,6 +98,7 @@
     "pony-cause": "^2.1.8",
     "prompts": "^2.4.2",
     "terminal-link": "^3.0.0",
-    "update-notifier": "^6.0.2"
+    "update-notifier": "^6.0.2",
+    "which": "^3.0.0"
   }
 }