\n\n \n\n# @-xun/project-fs\n\n\n\nThe filesystem utilities available to consumers of the `@-xun/project` package.\n\nWraps [@-xun/fs][1].\n\n\n\n---\n\n\n\n\n\n\n- [Install](#install)\n- [Usage](#usage)\n- [Appendix](#appendix)\n - [Published Package Details](#published-package-details)\n - [License](#license)\n- [Contributing and Support](#contributing-and-support)\n - [Contributors](#contributors)\n\n\n\n\n\n \n\n## Install\n\n\n\nTo install:\n\n```shell\nnpm install @-xun/project-fs\n```\n\n## Usage\n\n\n\nTODO\n\n\n\n## Appendix\n\n\n\nFurther documentation can be found under [`docs/`][x-repo-docs].\n\n\n\n\n### Published Package Details\n\nThis is a [CJS2 package][x-pkg-cjs-mojito] with statically-analyzable exports\nbuilt by Babel for use in Node.js versions that are not end-of-life. For\nTypeScript users, this package supports both `\"Node10\"` and `\"Node16\"` module\nresolution strategies.\n\n\n\n\n\nExpand details\n\nThat means both CJS2 (via `require(...)`) and ESM (via `import { ... } from ...`\nor `await import(...)`) source will load this package from the same entry points\nwhen using Node. This has several benefits, the foremost being: less code\nshipped/smaller package size, avoiding [dual package\nhazard][x-pkg-dual-package-hazard] entirely, distributables are not\npacked/bundled/uglified, a drastically less complex build process, and CJS\nconsumers aren't shafted.\n\nEach entry point (i.e. `ENTRY`) in [`package.json`'s\n`exports[ENTRY]`][x-repo-package-json] object includes one or more [export\nconditions][x-pkg-exports-conditions]. These entries may or may not include: an\n[`exports[ENTRY].types`][x-pkg-exports-types-key] condition pointing to a type\ndeclaration file for TypeScript and IDEs, a\n[`exports[ENTRY].module`][x-pkg-exports-module-key] condition pointing to\n(usually ESM) source for Webpack/Rollup, a `exports[ENTRY].node` and/or\n`exports[ENTRY].default` condition pointing to (usually CJS2) source for Node.js\n`require`/`import` and for browsers and other environments, and [other\nconditions][x-pkg-exports-conditions] not enumerated here. Check the\n[package.json][x-repo-package-json] file to see which export conditions are\nsupported.\n\nNote that, regardless of the [`{ \"type\": \"...\" }`][x-pkg-type] specified in\n[`package.json`][x-repo-package-json], any JavaScript files written in ESM\nsyntax (including distributables) will always have the `.mjs` extension. Note\nalso that [`package.json`][x-repo-package-json] may include the\n[`sideEffects`][x-pkg-side-effects-key] key, which is almost always `false` for\noptimal [tree shaking][x-pkg-tree-shaking] where appropriate.\n\n\n\n\n\n\n\n### License\n\n\n\nSee [LICENSE][x-repo-license].\n\n\n\n\n## Contributing and Support\n\n**[New issues][x-repo-choose-new-issue] and [pull requests][x-repo-pr-compare]\nare always welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟\nthis project][x-badge-repo-link] to let me know you found it useful! ✊🏿 Or [buy\nme a beer][x-repo-sponsor], I'd appreciate it. Thank you!\n\nSee [CONTRIBUTING.md][x-repo-contributing] and [SUPPORT.md][x-repo-support] for\nmore information.\n\n\n\n\n\n### Contributors\n\n\n\n\n\n\n\nSee the [table of contributors][x-repo-contributors].\n\n\n\n[x-badge-blm-image]: https://xunn.at/badge-blm 'Join the movement!'\n[x-badge-blm-link]: https://xunn.at/donate-blm\n[x-badge-codecov-image]:\n https://img.shields.io/codecov/c/github/Xunnamius/project-utils/main?style=flat-square&token=HWRIOBAAPW&flag=package.main_fs\n 'Is this package well-tested?'\n[x-badge-codecov-link]: https://codecov.io/gh/Xunnamius/project-utils\n[x-badge-downloads-image]:\n https://img.shields.io/npm/dm/@-xun/project-fs?style=flat-square\n 'Number of times this package has been downloaded per month'\n[x-badge-downloads-link]: https://npmtrends.com/@-xun/project-fs\n[x-badge-lastcommit-image]:\n https://img.shields.io/github/last-commit/Xunnamius/project-utils?style=flat-square\n 'Latest commit timestamp'\n[x-badge-license-image]:\n https://img.shields.io/npm/l/@-xun/project-fs?style=flat-square\n \"This package's source license\"\n[x-badge-license-link]:\n https://github.com/Xunnamius/project-utils/blob/main/LICENSE\n[x-badge-npm-image]:\n https://xunn.at/npm-pkg-version/@-xun/project-fs\n 'Install this package using npm or yarn!'\n[x-badge-npm-link]: https://npm.im/@-xun/project-fs\n[x-badge-repo-link]: https://github.com/Xunnamius/project-utils\n[x-badge-semanticrelease-image]:\n https://xunn.at/badge-semantic-release\n 'This repo practices continuous integration and deployment!'\n[x-badge-semanticrelease-link]:\n https://github.com/semantic-release/semantic-release\n[x-pkg-cjs-mojito]:\n https://dev.to/jakobjingleheimer/configuring-commonjs-es-modules-for-nodejs-12ed#publish-only-a-cjs-distribution-with-property-exports\n[x-pkg-dual-package-hazard]:\n https://nodejs.org/api/packages.html#dual-package-hazard\n[x-pkg-exports-conditions]:\n https://webpack.js.org/guides/package-exports#reference-syntax\n[x-pkg-exports-module-key]:\n https://webpack.js.org/guides/package-exports#providing-commonjs-and-esm-version-stateless\n[x-pkg-exports-types-key]:\n https://devblogs.microsoft.com/typescript/announcing-typescript-4-5-beta#packagejson-exports-imports-and-self-referencing\n[x-pkg-side-effects-key]:\n https://webpack.js.org/guides/tree-shaking#mark-the-file-as-side-effect-free\n[x-pkg-tree-shaking]: https://webpack.js.org/guides/tree-shaking\n[x-pkg-type]:\n https://github.com/nodejs/node/blob/8d8e06a345043bec787e904edc9a2f5c5e9c275f/doc/api/packages.md#type\n[x-repo-choose-new-issue]:\n https://github.com/Xunnamius/project-utils/issues/new/choose\n[x-repo-contributing]: /CONTRIBUTING.md\n[x-repo-contributors]: /README.md#contributors\n[x-repo-docs]: docs\n[x-repo-license]: ./LICENSE\n[x-repo-package-json]: package.json\n[x-repo-pr-compare]: https://github.com/Xunnamius/project-utils/compare\n[x-repo-sponsor]: https://github.com/sponsors/Xunnamius\n[x-repo-support]: /.github/SUPPORT.md\n[1]: https://npm.im/@-xun/fs\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/Xunnamius/project-utils/refs/heads/main/packages/fs/logo.png\"){kind=logo}
\n