@socketsecurity/cli 0.4.0 → 0.4.2

package/LICENSE

@@ -1,4 +1,4 @@
-The MIT License (MIT)
+MIT License
 
 Copyright (c) 2022 Socket Inc
 

package/README.md

@@ -1,6 +1,6 @@
 # Socket CLI
 
-[![Socket Badge](https://socket.dev/api/badge/npm/pkg/@socketsecurity/cli)](https://socket.dev/npm/package/@socketsecurity/cli)
+[![Socket Badge](https://socket.dev/api/badge/npm/package/@socketsecurity/cli)](https://socket.dev/npm/package/@socketsecurity/cli)
 [![npm version](https://img.shields.io/npm/v/@socketsecurity/cli.svg?style=flat)](https://www.npmjs.com/package/@socketsecurity/cli)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/SocketDev/eslint-config)
 [![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
@@ -34,6 +34,12 @@ socket report view QXU8PmK7LfH608RAwfIKdbcHgwEd_ZeWJ9QEGv05FJUQ
 
 * `socket report view <report-id>` - looks up issues and scores from a report
 
+## Aliases
+
+All aliases supports flags and arguments of the commands they alias.
+
+* `socket ci` - alias for `socket report create --view --strict` which creates a report and quits with an exit code if the result is unhealthy. Use like eg. `socket ci .` for a report for the current folder
+
 ## Flags
 
 ### Command specific flags

package/cli.js

@@ -18,6 +18,12 @@ try {
   await meowWithSubcommands(
     cliCommands,
     {
+      aliases: {
+        ci: {
+          description: 'Alias for "report create --view --strict"',
+          argv: ['report', 'create', '--view', '--strict']
+        },
+      },
       argv: process.argv.slice(2),
       name: 'socket',
       importMeta: import.meta

package/lib/utils/meow-with-subcommands.js

@@ -1,7 +1,14 @@
 import meow from 'meow'
 
 import { printFlagList, printHelpList } from './formatting.js'
-import { ensureIsKeyOf } from './type-helpers.js'
+
+/**
+ * @typedef CliAlias
+ * @property {string} description
+ * @property {readonly string[]} argv
+ */
+
+/** @typedef {Record<string, CliAlias>} CliAliases */
 
 /**
  * @callback CliSubcommandRun
@@ -20,39 +27,51 @@ import { ensureIsKeyOf } from './type-helpers.js'
 /**
  * @template {import('meow').AnyFlags} Flags
  * @param {Record<string, CliSubcommand>} subcommands
- * @param {import('meow').Options<Flags> & { argv: readonly string[], name: string }} options
+ * @param {import('meow').Options<Flags> & { aliases?: CliAliases, argv: readonly string[], name: string }} options
  * @returns {Promise<void>}
  */
 export async function meowWithSubcommands (subcommands, options) {
   const {
+    aliases = {},
     argv,
     name,
     importMeta,
     ...additionalOptions
   } = options
-  const [rawCommandName, ...commandArgv] = argv
-
-  const commandName = ensureIsKeyOf(subcommands, rawCommandName)
-  const command = commandName ? subcommands[commandName] : undefined
-
-  // If a valid command has been specified, run it...
-  if (command) {
-    return await command.run(
-      commandArgv,
-      importMeta,
-      {
-        parentName: name
-      }
-    )
+
+  const [commandOrAliasName, ...rawCommandArgv] = argv
+
+  // If we got at least some args, then lets find out if we can find a command
+  if (commandOrAliasName) {
+    const alias = aliases[commandOrAliasName]
+
+    // First: Resolve argv data from alias if its an alias that's been given
+    const [commandName, ...commandArgv] = alias
+      ? [...alias.argv, ...rawCommandArgv]
+      : [commandOrAliasName, ...rawCommandArgv]
+
+    // Second: Find a command definition using that data
+    const commandDefinition = commandName ? subcommands[commandName] : undefined
+
+    // Third: If a valid command has been found, then we run it...
+    if (commandDefinition) {
+      return await commandDefinition.run(
+        commandArgv,
+        importMeta,
+        {
+          parentName: name
+        }
+      )
+    }
   }
 
-  // ...else provide basic instructions and help
+  // ...else we provide basic instructions and help
   const cli = meow(`
     Usage
       $ ${name} <command>
 
     Commands
-      ${printHelpList(subcommands, 6)}
+      ${printHelpList({ ...subcommands, ...aliases }, 6)}
 
     Options
       ${printFlagList({}, 6)}

package/lib/utils/path-resolve.js

@@ -39,6 +39,9 @@ const GLOB_IGNORE = [
  * @throws {InputError}
  */
 export async function getPackageFiles (cwd, inputPaths, config, debugLog) {
+  debugLog(`Globbed resolving ${inputPaths.length} paths:`, inputPaths)
+
+  // TODO: Does not support `~/` paths
   const entries = await globby(inputPaths, {
     absolute: true,
     cwd,

package/lib/utils/sdk.js

@@ -9,10 +9,17 @@ import prompts from 'prompts'
 import { AuthError } from './errors.js'
 
 /**
- * @returns {Promise<import('@socketsecurity/sdk').SocketSdk>}
+ * The API key should be stored globally for the duration of the CLI execution
+ *
+ * @type {string | undefined}
  */
+let apiKey
+
+/** @returns {Promise<import('@socketsecurity/sdk').SocketSdk>} */
 export async function setupSdk () {
-  let apiKey = process.env['SOCKET_SECURITY_API_KEY']
+  if (!apiKey) {
+    apiKey = process.env['SOCKET_SECURITY_API_KEY']
+  }
 
   if (!apiKey && isInteractive()) {
     const input = await prompts({

package/lib/utils/type-helpers.js

@@ -1,13 +1,3 @@
-/**
- * @template T
- * @param {T} obj
- * @param {string|undefined} key
- * @returns {(keyof T) | undefined}
- */
-export function ensureIsKeyOf (obj, key) {
-  return /** @type {keyof T} */ (key && Object.prototype.hasOwnProperty.call(obj, key) ? key : undefined)
-}
-
 /**
  * @param {unknown} value
  * @returns {value is NodeJS.ErrnoException}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socketsecurity/cli",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "CLI tool for Socket.dev",
   "homepage": "http://github.com/SocketDev/socket-cli-js",
   "repository": {
@@ -38,7 +38,7 @@
     "test": "run-s check test:*"
   },
   "devDependencies": {
-    "@socketsecurity/eslint-config": "^1.0.0",
+    "@socketsecurity/eslint-config": "^2.0.0",
     "@tsconfig/node14": "^1.0.3",
     "@types/chai": "^4.3.3",
     "@types/chai-as-promised": "^7.1.5",
@@ -46,22 +46,22 @@
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^14.18.31",
     "@types/prompts": "^2.4.1",
-    "@types/update-notifier": "^6.0.1",
-    "@typescript-eslint/eslint-plugin": "^5.48.2",
-    "@typescript-eslint/parser": "^5.48.2",
+    "@types/update-notifier": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
     "c8": "^7.12.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "dependency-check": "^5.0.0-7",
-    "eslint": "^8.32.0",
+    "eslint": "^8.34.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-config-standard-jsx": "^11.0.0",
     "eslint-import-resolver-typescript": "^3.5.3",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^39.5.0",
+    "eslint-plugin-jsdoc": "^40.0.0",
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.32.1",
+    "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-unicorn": "^45.0.2",
     "husky": "^8.0.1",
@@ -71,7 +71,7 @@
     "nock": "^13.3.0",
     "npm-run-all2": "^6.0.2",
     "type-coverage": "^2.24.1",
-    "typescript": "~4.9.4"
+    "typescript": "~4.9.5"
   },
   "dependencies": {
     "@apideck/better-ajv-errors": "^0.3.6",