@camjn/getargv 0.0.2 → 0.0.4

package/README.md

@@ -25,7 +25,7 @@ After checking out the repo, run `npm i` to install dependencies. Then, run `npm
 
 TS code goes in the `lib` dir, C code goes in the `src` dir.
 
-To install this module onto your local machine, run `npm install`. To release a new version, run `npm version patch` to update the version number in `package.json` and create a git tag for the version, and push git commits and the created tag to the git origin; and then run `npm publish`, which will push the module to npm.[npmjs.com](https://www.npmjs.com).
+To install this module onto your local machine, run `npm install`. To release a new version, run `npm version patch` to update the version number in `package.json` and create a git tag for the version, and push git commits and the created tag to the git origin; and then run `npm publish`, which will push the module to [npm](https://www.npmjs.com).
 
 ## Contributing
 

package/dist/binding.d.ts

@@ -0,0 +1,8 @@
+interface GetArgv {
+    readonly PID_MAX: number;
+    readonly ARG_MAX: number;
+    get_argv_of_pid(pid: number, nuls: boolean, skip: number): string;
+    get_argv_and_argc_of_pid(pid: number): Array<string>;
+}
+declare const addon: GetArgv;
+export = addon;

package/dist/binding.js

@@ -0,0 +1,7 @@
+"use strict";
+const addon = require('../build/Release/getargv_native');
+exports.PID_MAX = addon.PID_MAX;
+exports.ARG_MAX = addon.ARG_MAX;
+exports.get_argv_of_pid = addon.get_argv_of_pid;
+exports.get_argv_and_argc_of_pid = addon.get_argv_and_argc_of_pid;
+module.exports = addon;

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+declare const get_argv_of_pid: any;
+declare function exit(msg: string): void;

package/dist/cli.js

@@ -0,0 +1,33 @@
+"use strict";
+const { get_argv_of_pid } = require('./binding');
+function exit(msg) {
+    console.error(msg);
+    process.exitCode = -1;
+}
+// [node, script] are first two args
+if (process.argv.length < 3) {
+    exit("a pid argument is required");
+}
+else {
+    const pid = Number.parseInt(process.argv.pop());
+    if (!Number.isInteger(pid)) {
+        exit("pid is not a number");
+    }
+    else {
+        const nuls_index = process.argv.indexOf("-0");
+        const keep_nuls = nuls_index != -1;
+        if (keep_nuls)
+            process.argv.splice(nuls_index, 1);
+        const skip_index = process.argv.indexOf("-s");
+        let skip = 0;
+        if (skip_index > -1) {
+            skip = Number.parseInt(process.argv[skip_index + 1]);
+            if (!Number.isInteger(skip))
+                exit("argument to skip flag (-s) is not a number");
+        }
+        if (process.exitCode == undefined) {
+            const args = get_argv_of_pid(pid, !keep_nuls, skip);
+            process.stdout.write(args);
+        }
+    }
+}

package/package.json

@@ -16,15 +16,26 @@
     "name": "@camjn/getargv",
     "homepage": "https://getargv.narzt.cam/",
     "author": "Camden Narzt <getargv@narzt.cam>",
-    "version": "0.0.2",
+    "version": "0.0.4",
     "description": "This library allows you to query the arguments of other processes on macOS.",
-    "main": "lib/binding.js",
+    "main": "dist/binding.js",
     "scripts": {
         "build": "node-gyp configure build",
         "pretest": "tsc",
         "test": "node --napi-modules ./test/test_binding.js",
-        "console": "node --napi-modules -r ./build/Release/getargv_native"
+        "precli": "tsc",
+        "prepack": "tsc",
+        "cli": "node dist/cli.js",
+        "console": "node --napi-modules -r ./build/Release/getargv_native -e 'const GetArgv = require.cache[Object.keys(require.cache)[0]].exports;' -i"
     },
+    "files": [
+        "/README.md",
+        "/logo.svg",
+        "/dist",
+        "/src",
+        "/binding.gyp",
+        "/package.json"
+    ],
     "gypfile": true,
     "repository": {
         "type": "git",

package/src/getargv.c

@@ -1,45 +1,43 @@
 #include <errno.h>
 #include <libgetargv.h>
 #include <node_api.h>
-#include <stdint.h>
 #include <stdlib.h>
 #include <string.h>
-#include <sys/sysctl.h>
+#include <sys/syslimits.h>
 
-napi_value create_system_error(napi_env env, errno_t err) {
-  napi_value code;
-  if (napi_ok != napi_create_string_utf8(env, "ERR_SYSTEM_ERROR",
-                                         NAPI_AUTO_LENGTH, &code)) {
+#define STR1(x) #x
+#define STR2(x) STR1(x)
+#define ARG_MAX_STR STR2(ARG_MAX)
+
+napi_value get_undefined(napi_env env) {
+  napi_value undef;
+  if (napi_get_undefined(env, &undef) != napi_ok) {
     napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                     "Failed to create String object");
+                     "Unable to get 'undefined' constant");
   }
+  return undef;
+}
+
+napi_value create_system_error(napi_env env, errno_t err) {
+  //we skip checking status in here because we already have a failure
+  napi_value code;
+  napi_create_string_utf8(env, "ERR_SYSTEM_ERROR", NAPI_AUTO_LENGTH, &code);
 
   napi_value msg;
-  if (napi_ok !=
-      napi_create_string_utf8(env, strerror(err), NAPI_AUTO_LENGTH, &msg)) {
-    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                     "Failed to create String object");
-  }
+  napi_create_string_utf8(env, strerror(err), NAPI_AUTO_LENGTH, &msg);
 
   napi_value error;
-  if (napi_ok != napi_create_error(env, code, msg, &error)) {
-    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                     "Failed to create Error object");
-  }
+  napi_create_error(env, code, msg, &error);
 
   napi_value value;
-  if (napi_ok != napi_create_int32(env, err, &value)) {
-    napi_throw_error(env, "ERR_INTERNAL_ASSERTION", "Failed to create number");
-  }
+  napi_create_int32(env, err, &value);
+
+  napi_set_named_property(env, error, "errno", value);
 
-  if (napi_ok != napi_set_named_property(env, error, "errno", value)) {
-    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                     "Failed to set property on Error object");
-  }
   return error;
 }
 
-napi_value GetArgvOfPid(napi_env env, napi_callback_info info) {
+struct GetArgvOptions parseTripleArgs(napi_env env, napi_callback_info info) {
   size_t argc = 3;
   napi_value argv[argc];
 
@@ -83,37 +81,15 @@ napi_value GetArgvOfPid(napi_env env, napi_callback_info info) {
     if (skip < 0 || skip > ARG_MAX) {
       // or ERR_OUT_OF_RANGE
       napi_throw_range_error(env, "ERR_INVALID_ARG_VALUE",
-                             "Invalid number was passed as third argument");
+                             "Invalid number was passed as third argument, "
+                             "must be between 0 and " ARG_MAX_STR "");
     }
   }
-
-  napi_value args;
-  if (napi_get_undefined(env, &args) != napi_ok) {
-    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                     "Unable to get 'undefined' constant");
-  }
   struct GetArgvOptions options = {.pid = pid, .nuls = nuls, .skip = skip};
-  struct ArgvResult result;
-  if (!get_argv_of_pid(&options, &result)) {
-    napi_value error = create_system_error(env, errno);
-
-    napi_throw(env, error);
-  } else {
-    if (napi_create_string_utf8(env, result.start_pointer,
-                                result.end_pointer - result.start_pointer + 1,
-                                &args) != napi_ok) {
-      // args not guaranteed to be utf8 or even latin1/ascii, but ruby, swift,
-      // and node all want strings to be properly encoded
-      napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                       "Unable to create return value");
-    }
-    free(result.buffer);
-  }
-
-  return args;
+  return options;
 }
 
-napi_value GetArgvAndArgcOfPid(napi_env env, napi_callback_info info) {
+pid_t parseSingleArg(napi_env env, napi_callback_info info) {
   size_t argc = 1;
   napi_value argv[argc];
 
@@ -126,7 +102,7 @@ napi_value GetArgvAndArgcOfPid(napi_env env, napi_callback_info info) {
                           "The \"pid\" argument must be specified");
   } else if (argc > 1) {
     napi_throw_type_error(env, "ERR_TOO_MANY_ARGS",
-                          "Too many arguments were provided, max: 3");
+                          "Too many arguments were provided, max: 1");
   }
 
   pid_t pid = 0;
@@ -140,11 +116,37 @@ napi_value GetArgvAndArgcOfPid(napi_env env, napi_callback_info info) {
                            "Invalid PID was passed as first argument");
   }
 
-  napi_value args;
-  if (napi_get_undefined(env, &args) != napi_ok) {
-    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
-                     "Unable to get 'undefined' constant");
+  return pid;
+}
+
+napi_value GetArgvOfPid(napi_env env, napi_callback_info info) {
+  struct GetArgvOptions options = parseTripleArgs(env, info);
+  napi_value args = get_undefined(env);
+
+  struct ArgvResult result;
+  if (!get_argv_of_pid(&options, &result)) {
+    napi_value error = create_system_error(env, errno);
+
+    napi_throw(env, error);
+  } else {
+    if (napi_create_string_utf8(env, result.start_pointer,
+                                result.end_pointer - result.start_pointer + 1,
+                                &args) != napi_ok) {
+      // args not guaranteed to be utf8 or even latin1/ascii, but ruby, swift,
+      // and node all want strings to be properly encoded
+      napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
+                       "Unable to create return value");
+    }
+    free(result.buffer);
   }
+
+  return args;
+}
+
+napi_value GetArgvAndArgcOfPid(napi_env env, napi_callback_info info) {
+  pid_t pid = parseSingleArg(env, info);
+  napi_value args = get_undefined(env);
+
   struct ArgvArgcResult result;
   if (!get_argv_and_argc_of_pid(pid, &result)) {
     napi_value error = create_system_error(env, errno);
@@ -180,7 +182,6 @@ napi_value GetArgvAndArgcOfPid(napi_env env, napi_callback_info info) {
 }
 
 napi_value Init(napi_env env, napi_value exports) {
-  // Module initialization code goes here
   napi_value get_argv_of_pid_fn;
   if (napi_create_function(env, "get_argv_of_pid", NAPI_AUTO_LENGTH,
                            GetArgvOfPid, NULL,
@@ -207,6 +208,27 @@ napi_value Init(napi_env env, napi_value exports) {
                      "Unable to populate exports");
   }
 
+  napi_value pid_max_constant;
+  if (napi_create_uint32(env, _PID_MAX, &pid_max_constant) != napi_ok) {
+    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
+                     "Unable to create constant");
+  }
+  if (napi_set_named_property(env, exports, "PID_MAX", pid_max_constant) !=
+      napi_ok) {
+    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
+                     "Unable to populate exports");
+  }
+  napi_value arg_max_constant;
+  if (napi_create_uint32(env, ARG_MAX, &arg_max_constant) != napi_ok) {
+    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
+                     "Unable to create constant");
+  }
+  if (napi_set_named_property(env, exports, "ARG_MAX", arg_max_constant) !=
+      napi_ok) {
+    napi_throw_error(env, "ERR_INTERNAL_ASSERTION",
+                     "Unable to populate exports");
+  }
+
   return exports;
 }
 

package/.github/workflows/node.yml

@@ -1,44 +0,0 @@
-name: Node.js
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-jobs:
-  build:
-    runs-on: macos-latest
-    strategy:
-      matrix:
-        node-version:
-          - 16.x
-          - 18.x
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-    steps:
-    - uses: actions/checkout@v3
-      with:
-        repository: getargv/getargv
-        path: getargv
-        token: ${{ secrets.GH_PAT }}
-    - name: Build libgetargv
-      run: make install_dylib
-      working-directory: getargv
-    - uses: actions/checkout@v3
-      with:
-        path: getargv.js
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-        check-latest: true
-        cache-dependency-path: ./getargv.js/package-lock.json
-    - run: npm ci
-      working-directory: getargv.js
-    - run: cat /Users/runner/.npm/_logs/*-debug.log && false
-      if: ${{ failure() }}
-    - run: npm run build --if-present
-      working-directory: getargv.js
-    - run: npm test
-      working-directory: getargv.js

package/lib/binding.ts

@@ -1,11 +0,0 @@
-interface CBinding {
-
-    get_argv_of_pid(pid: number, nuls: boolean, skip: number): string
-
-    get_argv_and_argc_of_pid(pid: number): Array<string>
-
-}
-
-const addon: CBinding = require('../build/Release/getargv_native');
-
-export = addon

package/test/test_binding.js

@@ -1,24 +0,0 @@
-const Getargv = require("../dist/binding.js");
-const assert = require("assert");
-const process = require("process");
-
-function expected_args() {
-    return [process.argv0, ...process.execArgv, ...process.argv.slice(1)].map(a => a.replace(process.cwd(), "."));
-}
-
-assert(Getargv, "The export is undefined");
-
-function test_Get_Argv_Of_Pid() {
-    const result = Getargv.get_argv_of_pid(process.pid);
-    assert.strictEqual(result, expected_args().join("\0") + "\0", "Unexpected value returned");
-}
-
-function test_Get_Argv_And_Argc_Of_Pid() {
-    const result = Getargv.get_argv_and_argc_of_pid(process.pid);
-    assert.deepStrictEqual(result, expected_args(), "Unexpected value returned");
-}
-
-assert.doesNotThrow(test_Get_Argv_Of_Pid, undefined, "test_Get_Argv_Of_Pid threw an expection");
-assert.doesNotThrow(test_Get_Argv_And_Argc_Of_Pid, undefined, "test_Get_Argv_And_Argc_Of_Pid threw an expection");
-
-console.log("Tests passed & everything looks OK!");

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "declaration": true,
-    "lib": [ "esnext" ],
-    "module": "commonjs",
-    "outDir": "./dist",
-    "rootDir": "./lib",
-    "strict": true,
-    "target": "es6",
-    "types": [
-      "node"
-    ],
-    "typeRoots": [
-      "node_modules/@types"
-    ]
-  }
-}