@react-native-gpui/fs 0.0.0-stage → 0.0.1-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to `@react-native-gpui/fs` are listed here. Each version's section becomes the notes of its GitHub release.
+
+## 0.0.1-alpha.0 - 2026-11-01
+
+- First release.
+- File system access for desktop apps.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Streetwriters
+
+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,37 @@
-# Temporary Holding Version
+# @react-native-gpui/fs
 
-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 file system API for desktop apps, shaped like Node's `node:fs`, with file dialogs and the operating system's well-known folders.
+
+Part of [react-native-gpui](https://github.com/streetwriters/react-native-gpui), React Native for macOS, Windows and Linux.
+
+## Install
+
+```sh
+npm install @react-native-gpui/fs
+```
+
+## Usage
+
+```js
+import fs, { dialog, paths } from '@react-native-gpui/fs';
+
+const text = fs.readFileSync(`${paths.documents}/notes.txt`, 'utf8');
+await fs.promises.writeFile(
+  `${paths.appData}/state.json`,
+  JSON.stringify(state),
+);
+
+const [file] = await dialog.open({
+  filters: [{ name: 'Text', extensions: ['txt'] }],
+});
+```
+
+The default export has the synchronous, callback and promise forms of the common `node:fs` calls, with Node's encodings, `Stats`, `Dirent` and error codes. The module runs on its own thread, so slow files never block JavaScript or the interface.
+
+## Documentation
+
+[File system](https://streetwriters.github.io/react-native-gpui/docs/desktop-file-system)
+
+## License
+
+MIT. See [LICENSE](LICENSE).