@visulima/fs 5.0.0-alpha.8 → 5.0.0

package/LICENSE.md

@@ -24,7 +24,7 @@ SOFTWARE.
 
 # Licenses of bundled dependencies
 The published @visulima/fs artifact additionally contains code with the following licenses:
-MIT
+ISC, MIT
 
 # Bundled dependencies:
 ## @visulima/error
@@ -57,11 +57,14 @@ Repository: git+https://github.com/visulima/visulima.git
 >
 >
 > # Licenses of bundled dependencies
+>
 > The published @visulima/error artifact additionally contains code with the following licenses:
 > MIT
 >
 > # Bundled dependencies:
+>
 > ## is-plain-obj
+>
 > License: MIT
 > By: Sindre Sorhus
 > Repository: sindresorhus/is-plain-obj
@@ -75,6 +78,33 @@ Repository: git+https://github.com/visulima/visulima.git
 > > 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.
+>
+>
+>
+>
+>
+> # Licenses of bundled types
+> The published @visulima/error artifact additionally contains code with the following licenses:
+> Apache-2.0
+>
+> # Bundled types:
+> ## ai
+> License: Apache-2.0
+> Repository: https://github.com/vercel/ai
+>
+> > Copyright 2023 Vercel, Inc.
+> >
+> > Licensed under the Apache License, Version 2.0 (the "License");
+> > you may not use this file except in compliance with the License.
+> > You may obtain a copy of the License at
+> >
+> >     http://www.apache.org/licenses/LICENSE-2.0
+> >
+> > Unless required by applicable law or agreed to in writing, software
+> > distributed under the License is distributed on an "AS IS" BASIS,
+> > WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+> > See the License for the specific language governing permissions and
+> > limitations under the License.
 
 ---------------------------------------
 
@@ -95,6 +125,73 @@ Repository: sindresorhus/detect-indent
 
 ---------------------------------------
 
+## fdir
+License: MIT
+By: thecodrr
+Repository: git+https://github.com/thecodrr/fdir.git
+
+> Copyright 2023 Abdullah Atta
+>
+> 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.
+
+---------------------------------------
+
+## glob-parent
+License: ISC
+By: Gulp Team, Elan Shanker, Blaine Bublitz
+Repository: gulpjs/glob-parent
+
+> The ISC License
+>
+> Copyright (c) 2015, 2019 Elan Shanker, 2021 Blaine Bublitz <blaine.bublitz@gmail.com>, Eric Schoffstall <yo@contra.io> and other contributors
+>
+> Permission to use, copy, modify, and/or distribute this software for any
+> purpose with or without fee is hereby granted, provided that the above
+> copyright notice and this permission notice appear in all copies.
+>
+> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+> ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+> IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---------------------------------------
+
+## is-extglob
+License: MIT
+By: Jon Schlinkert
+Repository: jonschlinkert/is-extglob
+
+> The MIT License (MIT)
+>
+> Copyright (c) 2014-2016, Jon Schlinkert
+>
+> 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.
+
+---------------------------------------
+
 ## is-fs-case-sensitive
 License: MIT
 By: Hiroki Osame
@@ -122,19 +219,103 @@ Repository: privatenumber/is-fs-case-sensitive
 > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 > SOFTWARE.
 
+---------------------------------------
+
+## is-glob
+License: MIT
+By: Jon Schlinkert, Brian Woodward, Daniel Perez
+Repository: micromatch/is-glob
+
+> The MIT License (MIT)
+>
+> Copyright (c) 2014-2017, Jon Schlinkert.
+>
+> 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.
+
+---------------------------------------
+
+## picomatch
+License: MIT
+By: Jon Schlinkert
+Repository: micromatch/picomatch
+
+> The MIT License (MIT)
+>
+> Copyright (c) 2017-present, Jon Schlinkert.
+>
+> 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.
+
+---------------------------------------
+
+## tinyglobby
+License: MIT
+By: Superchupu
+Repository: git+https://github.com/SuperchupuDev/tinyglobby.git
+
+> MIT License
+>
+> Copyright (c) 2024 Madeline Gurriarán
+>
+> 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.
+
 <!-- /DEPENDENCIES -->
 
 <!-- TYPE_DEPENDENCIES -->
 
 # Licenses of bundled types
-
 The published @visulima/fs artifact additionally contains code with the following licenses:
-MIT
+ISC, MIT
 
 # Bundled types:
-
 ## is-fs-case-sensitive
-
 License: MIT
 By: Hiroki Osame
 Repository: privatenumber/is-fs-case-sensitive
@@ -161,4 +342,54 @@ Repository: privatenumber/is-fs-case-sensitive
 > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 > SOFTWARE.
 
+---------------------------------------
+
+## tinyglobby
+License: MIT
+By: Superchupu
+Repository: git+https://github.com/SuperchupuDev/tinyglobby.git
+
+> MIT License
+>
+> Copyright (c) 2024 Madeline Gurriarán
+>
+> 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.
+
+---------------------------------------
+
+## yaml
+License: ISC
+By: Eemeli Aro
+Repository: github:eemeli/yaml
+
+> Copyright Eemeli Aro <eemeli@gmail.com>
+>
+> Permission to use, copy, modify, and/or distribute this software for any purpose
+> with or without fee is hereby granted, provided that the above copyright notice
+> and this permission notice appear in all copies.
+>
+> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+> REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+> FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+> INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+> OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+> TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+> THIS SOFTWARE.
+
 <!-- /TYPE_DEPENDENCIES -->

package/README.md

@@ -66,6 +66,71 @@ pnpm add yaml
 
 ## Usage
 
+### Quickstart by subpath
+
+`@visulima/fs` ships one entry per concern. Import from the narrowest subpath you
+need so the optional parser peers (`yaml`, `smol-toml`, `jsonc-parser`, `json5`,
+`ini`) stay tree-shaken.
+
+```typescript
+// Core fs surface: walk, glob, findUp, ensure*, read/writeFile, copy, move, remove, emptyDir, isAccessible, sanitize, EOL.
+import { copy, ensureDir, findUp, readFile, walk, writeFile } from "@visulima/fs";
+
+// Typed error classes (NotFoundError, AlreadyExistsError, PermissionError, …).
+import { NotFoundError } from "@visulima/fs/error";
+
+// Parser-backed helpers — each needs its peer dependency installed.
+import { readYaml, writeYaml } from "@visulima/fs/yaml";
+import { readJsonc, writeJsonc } from "@visulima/fs/jsonc";
+
+// Glob primitives and size/eol helpers.
+import { glob } from "@visulima/fs/glob";
+import { gzipSize } from "@visulima/fs/size";
+```
+
+### Copy a file or directory
+
+```typescript
+import { copy } from "@visulima/fs";
+
+// Copy a template directory, skipping node_modules and overwriting existing files.
+await copy("templates/app", "out/app", {
+    filter: (source) => !source.includes("node_modules"),
+});
+
+// Refuse to overwrite an existing destination.
+import { AlreadyExistsError } from "@visulima/fs/error";
+
+try {
+    await copy("a.txt", "b.txt", { overwrite: false });
+} catch (error) {
+    if (error instanceof AlreadyExistsError) {
+        console.error("destination already exists");
+    }
+}
+```
+
+### Coming from `fs-extra`?
+
+| `fs-extra`                     | `@visulima/fs`                                                          |
+| ------------------------------ | ----------------------------------------------------------------------- |
+| `copy` / `copySync`            | `copy` / `copySync`                                                     |
+| `move` / `moveSync`            | `move` / `moveSync`                                                     |
+| `remove` / `removeSync`        | `remove` / `removeSync` (real `EACCES`/`EBUSY` errors propagate)        |
+| `emptyDir` / `emptyDirSync`    | `emptyDir` / `emptyDirSync`                                             |
+| `ensureFile` / `ensureDir` / … | `ensureFile` / `ensureDir` / `ensureLink` / `ensureSymlink` (+ `*Sync`) |
+| `readJson` / `writeJson`       | `readJson` / `writeJson` (+ `*Sync`)                                    |
+| `pathExists`                   | `isAccessible` / `isAccessibleSync`                                     |
+
+> **`writeFile` notes:** `overwrite` defaults to `true`. With `overwrite: false`,
+> `writeFile` throws `AlreadyExistsError` if the target exists instead of
+> overwriting it. To keep a copy of the previous file before overwriting, pass
+> `{ backup: true }` — the old contents are renamed to `${path}.bak`.
+>
+> **`readFile` errors:** a missing file throws `NotFoundError` (`ENOENT`); a file
+> that cannot be read for permission reasons throws `PermissionError`
+> (`EACCES`/`EPERM`).
+
 ## walk
 
 ```typescript

package/dist/eol.d.ts

@@ -1,35 +1,36 @@
 /** End-of-line character for POSIX platforms such as macOS and Linux. */
-export declare const LF: "\n";
+declare const LF: "\n";
 /** End-of-line character for Windows platforms. */
-export declare const CRLF: "\r\n";
+declare const CRLF: "\r\n";
 /**
- * End-of-line character evaluated for the current platform.
- */
-export declare const EOL: "\n" | "\r\n";
+* End-of-line character evaluated for the current platform.
+*/
+declare const EOL: "\n" | "\r\n";
 /**
- * Detect the EOL character for string input.
- * Returns null if no newline.
- * @param content The string content to detect the EOL from.
- * @example
- * ```javascript
- * import { detect } from "@visulima/fs/eol";
- *
- * detect("Hello\r\nWorld"); // "\r\n"
- * detect("Hello\nWorld"); // "\n"
- * detect("HelloWorld"); // null
- * ```
- */
-export declare const detect: (content: string) => typeof EOL | null;
+* Detect the EOL character for string input.
+* Returns null if no newline.
+* @param content The string content to detect the EOL from.
+* @example
+* ```javascript
+* import { detect } from "@visulima/fs/eol";
+*
+* detect("Hello\r\nWorld"); // "\r\n"
+* detect("Hello\nWorld"); // "\n"
+* detect("HelloWorld"); // null
+* ```
+*/
+declare const detect: (content: string) => typeof EOL | null;
 /**
- * Format the file to the targeted EOL.
- * @param content The string content to format.
- * @param eol The target EOL character.
- * @example
- * ```javascript
- * import { format, LF, CRLF } from "@visulima/fs/eol";
- *
- * format("Hello\r\nWorld\nUnix", LF); // "Hello\nWorld\nUnix"
- * format("Hello\nWorld\r\nWindows", CRLF); // "Hello\r\nWorld\r\nWindows"
- * ```
- */
-export declare const format: (content: string, eol: typeof EOL) => string;
+* Format the file to the targeted EOL.
+* @param content The string content to format.
+* @param eol The target EOL character.
+* @example
+* ```javascript
+* import { format, LF, CRLF } from "@visulima/fs/eol";
+*
+* format("Hello\r\nWorld\nUnix", LF); // "Hello\nWorld\nUnix"
+* format("Hello\nWorld\r\nWindows", CRLF); // "Hello\r\nWorld\r\nWindows"
+* ```
+*/
+declare const format: (content: string, eol: typeof EOL) => string;
+export { CRLF, EOL, LF, detect, format };

package/dist/eol.js

@@ -1,26 +1,3 @@
-import { createRequire as __cjs_createRequire } from "node:module";
-
-const __cjs_require = __cjs_createRequire(import.meta.url);
-
-const __cjs_getProcess = typeof globalThis !== "undefined" && typeof globalThis.process !== "undefined" ? globalThis.process : process;
-
-const {
-  platform
-} = __cjs_getProcess;
-
-const regDetect = /\r?\n/g;
-const LF = "\n";
-const CRLF = "\r\n";
-const EOL = platform === "win32" ? CRLF : LF;
-const detect = (content) => {
-  const matched = content.match(regDetect);
-  if (!matched || matched.length === 0) {
-    return null;
-  }
-  const crlf = matched.filter((newline) => newline === CRLF).length;
-  const lf = matched.length - crlf;
-  return crlf > lf ? CRLF : LF;
-};
-const format = (content, eol) => content.replaceAll(regDetect, eol);
-
-export { CRLF, EOL, LF, detect, format };
+import{createRequire as i}from"node:module";const u=i(import.meta.url),a=typeof globalThis<"u"&&typeof globalThis.process<"u"?globalThis.process:process,{platform:p}=a,s=/\r?\n/g,c=`
+`,r=`\r
+`,_=p==="win32"?r:c,g=t=>{const e=t.match(s);if(!e||e.length===0)return null;const o=e.filter(l=>l===r).length,n=e.length-o;return o>n?r:c},h=(t,e)=>t.replaceAll(s,e);export{r as CRLF,_ as EOL,c as LF,g as detect,h as format};