fast-process-list 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 fast-process-list contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,54 @@
-# Temporary Holding Version
+# fast-process-list
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A tiny Windows Node-API addon for listing process executable paths.
+
+```js
+import { getProcessPaths } from 'fast-process-list'
+
+const paths = getProcessPaths()
+// ['C:\\Windows\\explorer.exe', 'C:\\Program Files\\Microsoft VS Code\\Code.exe', ...]
+```
+
+## API
+
+`getProcessPaths(): string[]`
+
+Returns full Win32 executable paths for processes accessible to the current user.
+Unicode characters and spaces are preserved. Multiple processes using the same
+executable produce duplicate paths. Ordering is unspecified.
+
+Processes that exit or cannot be opened or queried are skipped. A process can
+also exit immediately after its path is read. Snapshot creation, enumeration, or
+buffer allocation failures throw an `Error` with code `ERR_WINDOWS_PROCESS_LIST`.
+
+Image paths and enumeration order can differ from PowerShell/CIM's
+`ExecutablePath` values, for example for executable aliases or renamed images.
+
+## Platform support
+
+Windows x64 and ARM64 with Node.js 20+.
+
+## Development
+
+```sh
+pnpm install --frozen-lockfile
+pnpm run build
+pnpm test
+pnpm run check
+pnpm run lint
+pnpm run format
+```
+
+## Releases
+
+From a clean checkout on `main`:
+
+```sh
+git pull --ff-only
+pnpm version patch -m "release: v%s"
+git push origin main --follow-tags
+```
+
+## License
+
+MIT.

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Lists accessible Windows process executable paths without spawning a subprocess.
+ *
+ * Paths retain Unicode characters and may repeat when multiple processes use the
+ * same executable. Ordering is unspecified. Processes that exit or cannot be
+ * queried are skipped; a process may also exit immediately after being queried.
+ *
+ * @throws {Error} If the process snapshot or path buffer cannot be created, or
+ * enumerating the snapshot fails.
+ */
+export declare function getProcessPaths(): string[];

package/dist/index.js

@@ -0,0 +1,25 @@
+import { createRequire } from "node:module";
+// index.ts
+if (process.platform !== "win32" || !["x64", "arm64"].includes(process.arch)) throw new Error(`fast-process-list supports Windows x64 and ARM64; received ${process.platform}/${process.arch}`);
+const require = createRequire(import.meta.url);
+const filename = `../native/fast-process-list.win32-${process.arch}.node`;
+let binding;
+try {
+	binding = require(filename);
+} catch (cause) {
+	throw new Error(`Cannot load ${filename}. When using a source checkout, run pnpm run build with Rust and the MSVC build tools installed.`, { cause });
+}
+/**
+* Lists accessible Windows process executable paths without spawning a subprocess.
+*
+* Paths retain Unicode characters and may repeat when multiple processes use the
+* same executable. Ordering is unspecified. Processes that exit or cannot be
+* queried are skipped; a process may also exit immediately after being queried.
+*
+* @throws {Error} If the process snapshot or path buffer cannot be created, or
+* enumerating the snapshot fails.
+*/
+function getProcessPaths() {
+	return binding.getProcessPaths();
+}
+export { getProcessPaths };

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "fast-process-list",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Tiny native addon for listing Windows process executable paths",
+  "keywords": [
+    "napi",
+    "node-api",
+    "process",
+    "process-list",
+    "windows"
+  ],
+  "homepage": "https://github.com/sapphi-red/fast-process-list#readme",
+  "bugs": {
+    "url": "https://github.com/sapphi-red/fast-process-list/issues"
+  },
+  "license": "MIT",
+  "files": [
+    "dist",
+    "native/*.node"
+  ],
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "type": "module",
+  "exports": "./dist/index.js",
+  "devDependencies": {
+    "@types/node": "^26.6.6",
+    "oxfmt": "^0.78.0",
+    "oxlint": "^1.93.0",
+    "oxlint-tsgolint": "^7.0.2006",
+    "tsdown": "^0.23.7",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.12"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "build:js": "tsdown --on-success \"\"",
+    "test": "pnpm run build && vitest run",
+    "check": "pnpm run format:check && pnpm run lint && cargo fmt --check && cargo clippy --lib --locked -- -D warnings",
+    "lint": "oxlint",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check"
+  }
 }