@snyk/axi 0.1.0

package/README.md

@@ -0,0 +1,44 @@
+# @snyk/axi
+
+Lightweight npm wrapper around the [Snyk CLI](https://github.com/snyk/cli).
+
+Automatically prepends `agent-scan` (configurable) to every invocation, then delegates to the `snyk` binary from the `snyk` npm package.
+
+## Install
+
+```sh
+npm install -g @snyk/axi
+```
+
+## Usage
+
+```sh
+# Equivalent to: snyk agent-scan --json
+snyk-axi --json
+
+# Equivalent to: snyk agent-scan /path/to/project
+snyk-axi /path/to/project
+```
+
+## How it works
+
+1. Depends on the `snyk` npm package (which downloads the native CLI binary on install).
+2. Resolves the `snyk` binary from `node_modules`.
+3. Prepends configured arguments, appends user arguments, and executes.
+
+## Customizing prepended args
+
+Edit `PREPEND_ARGS` in `src/index.ts`:
+
+```ts
+const PREPEND_ARGS: string[] = ['agent-scan'];
+```
+
+## Development
+
+```sh
+npm install
+npm run build
+node bin/snyk-axi --help
+```
+# axi

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+// Args to prepend before the user's arguments.
+// Customize this array to inject subcommands or flags.
+const PREPEND_ARGS = ['agent'];
+function resolveSnykBinary() {
+    // Resolve the snyk binary from the 'snyk' npm dependency.
+    // The 'snyk' package registers bin/snyk which ends up in node_modules/.bin/
+    const snykPkgDir = path.dirname(require.resolve('snyk/package.json'));
+    const snykBin = path.join(snykPkgDir, 'bin', 'snyk');
+    if (!fs.existsSync(snykBin)) {
+        throw new Error(`Could not find snyk binary at ${snykBin}. ` +
+            'Make sure the "snyk" package is installed.');
+    }
+    return snykBin;
+}
+function main() {
+    const userArgs = process.argv.slice(2);
+    const allArgs = [...PREPEND_ARGS, ...userArgs];
+    const snykBin = resolveSnykBinary();
+    const result = (0, child_process_1.spawnSync)(process.execPath, [snykBin, ...allArgs], {
+        stdio: 'inherit',
+        env: process.env,
+    });
+    if (result.error) {
+        console.error('Failed to execute snyk:', result.error.message);
+        process.exit(2);
+    }
+    process.exit(result.status ?? 1);
+}
+main();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,iDAA0C;AAC1C,2CAA6B;AAC7B,uCAAyB;AAEzB,+CAA+C;AAC/C,uDAAuD;AACvD,MAAM,YAAY,GAAa,CAAC,OAAO,CAAC,CAAC;AAEzC,SAAS,iBAAiB;IACxB,0DAA0D;IAC1D,4EAA4E;IAC5E,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IAErD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,iCAAiC,OAAO,IAAI;YAC1C,4CAA4C,CAC/C,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,IAAI;IACX,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,CAAC,GAAG,YAAY,EAAE,GAAG,QAAQ,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;IAEpC,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,EAAE;QAChE,KAAK,EAAE,SAAS;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,IAAI,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@snyk/axi",
+  "version": "0.1.0",
+  "description": "Lightweight wrapper around the Snyk CLI",
+  "license": "Apache-2.0",
+  "author": "snyk.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/snyk/axi.git"
+  },
+  "bin": {
+    "snyk-axi": "dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "snyk": "1.1306.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}