@trenskow/atomic-write-stream 0.1.0

package/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2025 Kristian Trenskow
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,23 @@
+@trenskow/atomic-write-stream
+----
+
+A writeable file stream that writes atomically.
+
+# Usage
+
+Usage is works in exactly the same way as Node's build-in `createWriteStream` except it writes atomically and supports some options.
+
+````javascript
+import createAtomicWriteStream from '@trenskow/atomic-write-stram';
+
+const stream = createAtomicWriteStream('hello.txt', {
+	tmpDirectory: '/some/tmp/directory' /* defaults to `os.tmpdir()`. */
+});
+
+stream.write('Hello, World!');
+stream.end();
+````
+
+# LICENSE
+
+See license in LICENSE.

package/eslint.config.js

@@ -0,0 +1,54 @@
+import globals from 'globals';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import js from '@eslint/js';
+import { FlatCompat } from '@eslint/eslintrc';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all
+});
+
+export default [...compat.extends('eslint:recommended'), {
+	languageOptions: {
+		globals: {
+			...globals.node,
+			...globals.mocha,
+		},
+
+		ecmaVersion: 'latest',
+		sourceType: 'module',
+	},
+
+	rules: {
+		indent: ['error', 'tab', {
+			SwitchCase: 1,
+		}],
+
+		'linebreak-style': ['error', 'unix'],
+		quotes: ['error', 'single'],
+		semi: ['error', 'always'],
+
+		'no-console': ['error', {
+			allow: ['warn', 'error', 'info'],
+		}],
+
+		'no-unused-vars': ['error', {
+			argsIgnorePattern: '^_',
+		}],
+
+		'no-empty': ['error', {
+			allowEmptyCatch: true,
+		}],
+
+		'no-trailing-spaces': ['error', {
+			ignoreComments: true,
+		}],
+
+		'require-atomic-updates': 'off',
+		'eol-last': ['error', 'always'],
+	},
+}];

package/index.js

@@ -0,0 +1,11 @@
+//
+// index.js
+// @trenskow/signed-stream
+//
+// Created by Kristian Trenskow on 2025/01/01
+// See license in LICENSE.
+//
+
+import createAtomicWriteStream from './lib/index.js';
+
+export default createAtomicWriteStream;

package/lib/index.js

@@ -0,0 +1,92 @@
+//
+// index.js
+// @trenskow/signed-stream
+//
+// Created by Kristian Trenskow on 2025/01/01
+// See license in LICENSE.
+//
+
+import { createWriteStream } from 'fs';
+import { rename, unlink, stat } from 'fs/promises';
+import { tmpdir } from 'os';
+import { basename } from 'path';
+import { randomBytes } from 'crypto';
+import { Transform } from 'stream';
+
+class AtomicStream extends Transform {
+
+	constructor(path, { tmpDirectory = tmpdir() } = {}) {
+
+		super();
+
+		this._path = path;
+		this._birthPath = `${tmpDirectory}/${basename(path)}.${randomBytes(4).toString('hex')}`;
+		this._gravePath = `${tmpDirectory}/${basename(path)}.${randomBytes(4).toString('hex')}`;
+
+		this.once('error', () => this._cleanup());
+
+	}
+
+	_cleanup() {
+		unlink(this._birthPath).catch(() => {});
+	}
+
+	_finish(callback) {
+
+		(async () => {
+
+			let isOverwrite = true;
+
+			try {
+				await stat(this._path);
+			} catch (_) {
+				isOverwrite = false;
+			}
+
+			if (isOverwrite) {
+				try {
+					await rename(this._path, this._gravePath);
+				} catch (error) {
+					this._cleanup();
+					throw error;
+				}
+			}
+
+			try {
+				await rename(this._birthPath, this._path);
+			} catch (error) {
+
+				if (isOverwrite) {
+					await rename(this._gravePath, this._path);
+				}
+
+				this._cleanup();
+
+				throw error;
+
+			}
+
+			if (isOverwrite) {
+
+				try {
+					await unlink(this._gravePath);
+				} catch (_) { }
+
+			}
+
+		})().then(() => callback()).catch((error) => callback(error));
+
+	}
+
+};
+
+export default createAtomicWriteStream = (path, { tmpDirectory = tmpdir() } = {}) => {
+
+	const writeStream = createWriteStream(path);
+	const atomicStream = new AtomicStream(path, { tmpDirectory });
+
+	atomicStream.pipe(writeStream);
+
+	return atomicStream;
+
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@trenskow/atomic-write-stream",
+  "version": "0.1.0",
+  "description": "A writeable file stream that writes atomically.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/trenskow/atomic-write-stream.git"
+  },
+  "keywords": [
+    "createWriteStream",
+    "write",
+    "stream",
+    "atomic",
+    "file"
+  ],
+  "author": "Kristian Trenskow <this.is@kristians.email>",
+  "license": "BSD-3-Clause",
+  "bugs": {
+    "url": "https://github.com/trenskow/atomic-write-stream/issues"
+  },
+  "homepage": "https://github.com/trenskow/atomic-write-stream#readme",
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.17.0",
+    "eslint": "^9.17.0",
+    "globals": "^15.14.0"
+  }
+}