@altano/disposable-directory 0.0.0-beta.1

package/README.md

@@ -0,0 +1,21 @@
+# disposable-directory
+
+[![npm](https://badgen.net/npm/v/@altano/disposable-directory)](https://www.npmjs.com/package/@altano/disposable-directory) ![Typed with TypeScript](https://badgen.net/npm/types/@altano/disposable-directory) ![ESM only](https://badgen.net/badge/module/esm%20only?icon=js)
+
+Simple utility for getting a disposable, temporary directory in a Node.js-compatible environment. Directory is cleaned up automatically when the function scope exists.
+
+Uses the new `Symbol.asyncDispose` API and therefore requires Node.js 24+.
+
+## Example
+
+```ts
+async function doSomething() {
+  // This creates a directory
+  await using tempDir = await getDisposableDirectory();
+
+  // the directory exists for the scope of this function
+  console.log(tempDir);
+
+  // No cleanup is required. The directory will implicitly be deleted when this function exits (or throws an error).
+}
+```

package/dist/getDisposableDirectory.d.ts

@@ -0,0 +1,9 @@
+//#region src/getDisposableDirectory.d.ts
+type DisposableDirectory = {
+  path: string;
+  [Symbol.asyncDispose](): Promise<void>;
+};
+declare function getDisposableDirectory(prefix?: string): Promise<DisposableDirectory>;
+//#endregion
+export { getDisposableDirectory };
+//# sourceMappingURL=getDisposableDirectory.d.ts.map

package/dist/getDisposableDirectory.js

@@ -0,0 +1,21 @@
+import fs from "node:fs/promises";
+import nodePath from "node:path";
+import os from "node:os";
+
+//#region src/getDisposableDirectory.ts
+async function getDisposableDirectory(prefix = "disposable-directory-") {
+	const tempDir = await fs.mkdtemp(nodePath.join(os.tmpdir(), prefix));
+	return {
+		path: tempDir,
+		[Symbol.asyncDispose]() {
+			return fs.rm(tempDir, {
+				recursive: true,
+				force: true
+			});
+		}
+	};
+}
+
+//#endregion
+export { getDisposableDirectory };
+//# sourceMappingURL=getDisposableDirectory.js.map

package/dist/getDisposableDirectory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDisposableDirectory.js","names":[],"sources":["../src/getDisposableDirectory.ts"],"sourcesContent":["import fs from \"node:fs/promises\";\nimport nodePath from \"node:path\";\nimport os from \"node:os\";\n\ntype DisposableDirectory = {\n  path: string;\n  [Symbol.asyncDispose](): Promise<void>;\n};\n\nexport async function getDisposableDirectory(\n  prefix: string = \"disposable-directory-\",\n): Promise<DisposableDirectory> {\n  const tempDir = await fs.mkdtemp(nodePath.join(os.tmpdir(), prefix));\n  return {\n    path: tempDir,\n    [Symbol.asyncDispose]() {\n      return fs.rm(tempDir, { recursive: true, force: true });\n    },\n  };\n}\n"],"mappings":";;;;;AASA,eAAsB,uBACpB,SAAiB,yBACa;CAC9B,MAAM,UAAU,MAAM,GAAG,QAAQ,SAAS,KAAK,GAAG,QAAQ,EAAE,OAAO,CAAC;AACpE,QAAO;EACL,MAAM;EACN,CAAC,OAAO,gBAAgB;AACtB,UAAO,GAAG,GAAG,SAAS;IAAE,WAAW;IAAM,OAAO;IAAM,CAAC;;EAE1D"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { getDisposableDirectory } from "./getDisposableDirectory.js";
+export { getDisposableDirectory };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { getDisposableDirectory } from "./getDisposableDirectory.js";
+
+export { getDisposableDirectory };

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@altano/disposable-directory",
+  "version": "0.0.0-beta.1",
+  "description": "Create a temporary, disposable directory that automatically gets cleaned up when the function scope exits. Uses the new `Symbol.asyncDispose` APIs",
+  "keywords": [
+    "directory",
+    "temporary",
+    "disposable"
+  ],
+  "homepage": "https://github.com/altano/npm-packages/tree/main/packages/disposable-directory",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/altano/npm-packages",
+    "directory": "packages/disposable-directory"
+  },
+  "license": "ISC",
+  "author": {
+    "name": "Alan Norbauer",
+    "email": "altano@gmail.com",
+    "url": "https://alan.norbauer.com"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./*": "./dist/*"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "tsdown --config-loader unrun --config ../build-config/tsdown.config.node.ts",
+    "check:exports": "attw --pack . --profile esm-only --quiet",
+    "check:types:src": "tsc --noEmit",
+    "check:types:test": "tsc --noEmit --project ./tests/tsconfig.json",
+    "check:unused-dependencies": "depcheck",
+    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist",
+    "dev": "pnpm run build --watch",
+    "format": "prettier --check src",
+    "format:fix": "prettier --write src",
+    "lint": "eslint",
+    "lint:fix": "TIMING=1 pnpm lint --fix",
+    "lint:timing": "TIMING=1 pnpm lint",
+    "test:build": "./tests/scripts/createRepositoryBundles.ts",
+    "test:unit": "vitest --run",
+    "test:unit:watch": "vitest"
+  },
+  "devDependencies": {
+    "@altano/build-config": "workspace:*",
+    "@altano/testing": "workspace:*",
+    "@altano/tsconfig": "workspace:*",
+    "@arethetypeswrong/cli": "catalog:",
+    "@types/node": "catalog:",
+    "@vitest/coverage-v8": "catalog:",
+    "@vitest/expect": "catalog:",
+    "depcheck": "catalog:",
+    "eslint": "catalog:",
+    "prettier": "catalog:",
+    "tsdown": "catalog:",
+    "typescript": "catalog:",
+    "vite": "catalog:",
+    "vitest": "catalog:"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}