@diahkomalasarinpm/culpa-rem-accusamus NPM

Node.js: @diahkomalasarinpm/culpa-rem-accusamus

@diahkomalasarinpm/culpa-rem-accusamus adds file system methods that aren't included in the native fs module and adds promise support to the fs methods. It also uses graceful-fs to prevent EMFILE errors. It should be a drop in replacement for fs.

Why?

I got tired of including mkdirp, rimraf, and ncp in most of my projects.

Installation

npm install @diahkomalasarinpm/culpa-rem-accusamus

Usage

CommonJS

@diahkomalasarinpm/culpa-rem-accusamus is a drop in replacement for native fs. All methods in fs are attached to @diahkomalasarinpm/culpa-rem-accusamus. All fs methods return promises if the callback isn't passed.

You don't ever need to include the original fs module again:

const fs = require('fs') // this is no longer necessary

you can now do this:

const fs = require('@diahkomalasarinpm/culpa-rem-accusamus')

or if you prefer to make it clear that you're using @diahkomalasarinpm/culpa-rem-accusamus and not fs, you may want to name your fs variable fse like so:

const fse = require('@diahkomalasarinpm/culpa-rem-accusamus')

you can also keep both, but it's redundant:

const fs = require('fs')
const fse = require('@diahkomalasarinpm/culpa-rem-accusamus')

ESM

There is also an @diahkomalasarinpm/culpa-rem-accusamus/esm import, that supports both default and named exports. However, note that fs methods are not included in @diahkomalasarinpm/culpa-rem-accusamus/esm; you still need to import fs and/or fs/promises seperately:

import { readFileSync } from 'fs'
import { readFile } from 'fs/promises'
import { outputFile, outputFileSync } from '@diahkomalasarinpm/culpa-rem-accusamus/esm'

Default exports are supported:

import fs from 'fs'
import fse from '@diahkomalasarinpm/culpa-rem-accusamus/esm'
// fse.readFileSync is not a function; must use fs.readFileSync

but you probably want to just use regular @diahkomalasarinpm/culpa-rem-accusamus instead of @diahkomalasarinpm/culpa-rem-accusamus/esm for default exports:

import fs from '@diahkomalasarinpm/culpa-rem-accusamus'
// both fs and @diahkomalasarinpm/culpa-rem-accusamus methods are defined

Sync vs Async vs Async/Await

Most methods are async by default. All async methods will return a promise if the callback isn't passed.

Sync methods on the other hand will throw if an error occurs.

Also Async/Await will throw an error if one occurs.

Example:

const fs = require('@diahkomalasarinpm/culpa-rem-accusamus')

// Async with promises:
fs.copy('/tmp/myfile', '/tmp/mynewfile')
  .then(() => console.log('success!'))
  .catch(err => console.error(err))

// Async with callbacks:
fs.copy('/tmp/myfile', '/tmp/mynewfile', err => {
  if (err) return console.error(err)
  console.log('success!')
})

// Sync:
try {
  fs.copySync('/tmp/myfile', '/tmp/mynewfile')
  console.log('success!')
} catch (err) {
  console.error(err)
}

// Async/Await:
async function copyFiles () {
  try {
    await fs.copy('/tmp/myfile', '/tmp/mynewfile')
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

copyFiles()

Methods

Async

Sync

NOTE: You can still use the native Node.js methods. They are promisified and copied over to @diahkomalasarinpm/culpa-rem-accusamus. See notes on fs.read(), fs.write(), & fs.writev()

What happened to `walk()` and `walkSync()`?

They were removed from @diahkomalasarinpm/culpa-rem-accusamus in v2.0.0. If you need the functionality, walk and walkSync are available as separate packages, klaw and klaw-sync.

Third Party

CLI

fse-cli allows you to run @diahkomalasarinpm/culpa-rem-accusamus from a console or from npm scripts.

TypeScript

If you like TypeScript, you can use @diahkomalasarinpm/culpa-rem-accusamus with it: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/@diahkomalasarinpm/culpa-rem-accusamus

File / Directory Watching

If you want to watch for changes to files or directories, then you should use chokidar.

Obtain Filesystem (Devices, Partitions) Information

fs-filesystem allows you to read the state of the filesystem of the host on which it is run. It returns information about both the devices and the partitions (volumes) of the system.

Misc.

@diahkomalasarinpm/culpa-rem-accusamus-debug - Send your @diahkomalasarinpm/culpa-rem-accusamus calls to debug.
mfs - Monitor your @diahkomalasarinpm/culpa-rem-accusamus calls.

Hacking on @diahkomalasarinpm/culpa-rem-accusamus

Wanna hack on @diahkomalasarinpm/culpa-rem-accusamus? Great! Your help is needed! @diahkomalasarinpm/culpa-rem-accusamus is one of the most depended upon Node.js packages. This project uses JavaScript Standard Style - if the name or style choices bother you, you're gonna have to get over it :) If standard is good enough for npm, it's good enough for @diahkomalasarinpm/culpa-rem-accusamus.

What's needed?

First, take a look at existing issues. Those are probably going to be where the priority lies.
More tests for edge cases. Specifically on different platforms. There can never be enough tests.
Improve test coverage.

Note: If you make any big changes, you should definitely file an issue for discussion first.

Running the Test Suite

@diahkomalasarinpm/culpa-rem-accusamus contains hundreds of tests.

npm run lint: runs the linter (standard)
npm run unit: runs the unit tests
npm run unit-esm: runs tests for @diahkomalasarinpm/culpa-rem-accusamus/esm exports
npm test: runs the linter and all tests

When running unit tests, set the environment variable CROSS_DEVICE_PATH to the absolute path of an empty directory on another device (like a thumb drive) to enable cross-device move tests.

Windows

If you run the tests on the Windows and receive a lot of symbolic link EPERM permission errors, it's because on Windows you need elevated privilege to create symbolic links. You can add this to your Windows's account by following the instructions here: http://superuser.com/questions/104845/permission-to-make-symbolic-links-in-windows-7 However, I didn't have much luck doing this.

Since I develop on Mac OS X, I use VMWare Fusion for Windows testing. I create a shared folder that I map to a drive on Windows. I open the Node.js command prompt and run as Administrator. I then map the network drive running the following command:

net use z: "\\vmware-host\Shared Folders"

I can then navigate to my @diahkomalasarinpm/culpa-rem-accusamus directory and run the tests.

Naming

I put a lot of thought into the naming of these functions. Inspired by @coolaj86's request. So he deserves much of the credit for raising the issue. See discussion(s) here:

First, I believe that in as many cases as possible, the Node.js naming schemes should be chosen. However, there are problems with the Node.js own naming schemes.

For example, fs.readFile() and fs.readdir(): the F is capitalized in File and the d is not capitalized in dir. Perhaps a bit pedantic, but they should still be consistent. Also, Node.js has chosen a lot of POSIX naming schemes, which I believe is great. See: fs.mkdir(), fs.rmdir(), fs.chown(), etc.

We have a dilemma though. How do you consistently name methods that perform the following POSIX commands: cp, cp -r, mkdir -p, and rm -rf?

My perspective: when in doubt, err on the side of simplicity. A directory is just a hierarchical grouping of directories and files. Consider that for a moment. So when you want to copy it or remove it, in most cases you'll want to copy or remove all of its contents. When you want to create a directory, if the directory that it's suppose to be contained in does not exist, then in most cases you'll want to create that too.

So, if you want to remove a file or a directory regardless of whether it has contents, just call fs.remove(path). If you want to copy a file or a directory whether it has contents, just call fs.copy(source, destination). If you want to create a directory regardless of whether its parent directories exist, just call fs.mkdirs(path) or fs.mkdirp(path).

Credit

@diahkomalasarinpm/culpa-rem-accusamus wouldn't be possible without using the modules from the following authors:

License

Licensed under MIT

japanese parse art toSorted ECMAScript 2018 redux-toolkit browserlist rangeerror ECMAScript 2023 command-line shebang mixins 256 ie findLast full-width colour idle enumerable crypto some TypeScript ES5 telephone computed-types higher-order sorted Int8Array compile less lesscss babel node ECMAScript 2016 fetch file system concatMap rm sanitize $.extend hardlinks accessibility await eventEmitter ES2020 start link format break tc39 setter arguments yup path toArray write user-streams toobject [[Prototype]]macos byteOffset es5 Object.values iterator tap joi exe tools interrupts auth exit east-asian-width getOwnPropertyDescriptor metadata testing censor bootstrap css which callback karma jsonpath robust findLastIndex Float32Array URLSearchParams buffers popmotion property merge YAML deterministic ajax animation look-up private data private diff inspect sharedarraybuffer batch fastcopy dataview ECMAScript 6 trimEnd buffer cli glob coercible ansi tester define chinese estree env concurrency css nesting input real-time superagent css less ponyfill utilities framework arktype fast-clone callbound starter Microsoft form make once rmdir encryption module forms shrinkwrap move structuredClone safe validator password asserts writable whatwg watchFile eslint keys korean trimLeft ECMAScript 2022 crypt toStringTag deep-clone RxJS sigterm call-bound Object.defineProperty moment filter phone exec ES2023 es-abstract xhr curried id weakset busy preserve-symlinks HyBi limited react flags WeakSet type regular expression Object.fromEntries symlink StyleSheet gradients css negative zero stable Array.prototype.findLast open typeerror jasmine signal concat immutable names jest framer bound lint json-schema forEach 0 core console irq js es6 every Uint8Array escape logging syntax ES2015 pnpm9 directory commander Promise protobuf css variable limit package.json pure xss indicator functional error url shim immer airbnb assert minimal call-bind workspace:*jsdom cmd const less css descriptors mocha eslint-plugin color opens spawn argv es2017 react pose stream __proto__variables fast-deep-copy copy transpile middleware cache 6to5 efficient defineProperty picomatch ECMAScript 2015 multi-package output typescript config regexp reduce ascii cjk spinner tacit ArrayBuffer#slice bcrypt mkdirp stateless point-free getintrinsic ES8 walk less compiler async default typed descriptor eventDispatcher reducer redux extension executable figlet pose stylesheet TypeBox mime eslintplugin apollo streams side es8 web debugger term transpiler spinners offset dotenv package manager types optimist String.prototype.trim bundler curl style up spec collection.es6 runtime classnames fast-copy Object.is equality ES2022 match json-schema-validation byteLength throttle patch nope getter intrinsic child rm -rf install ES6 Object.keys folder matchAll values jwt trimStart worker Stream TypedArray mimetypes express jsonschema fantasy-land time chai optimizer progress duplex zod characters ArrayBuffer.prototype.slice website text xdg full browser contains from status consume pyyaml codes Object io-ts recursive cors valid Array.prototype.includes ECMAScript 7 generics shell operating-system JSON-Schema scheme length ESnext loading scheme-validation client sigint class-validator performant WebSockets dom-testing-library less mixins option promises three arrays request view proto bdd react-hooks harmony CSS Array.prototype.filter WeakMap find-up task l10n fast-deep-clone yaml RegExp.prototype.flags styleguide postcss array getPrototypeOf es RFC-6455 validation pretty Array.prototype.contains drop iteration parent package Underscore file object serializer visual Set signals fullwidth let gradients css3 modules dir logger ES3 ES2018 fastify qs syntaxerror ava ES2016 Function.prototype.name sequence symlinks ECMAScript 2019 assertion prototype preprocessor flatten hooks terminal fp String.prototype.matchAll configurable es-shims es2016 toolkit URL mobile i18n editor react-testing-library queueMicrotask read sort json-schema-validator postcss-plugin groupBy querystring debug regular expressions jQuery superstruct handlers var vest hookform uninstall babel-core walking number sanitization rate ES7 ratelimit core-js ECMAScript 3 jsdiff command negative quote exit-code character deepclone @@toStringTag ReactiveX call 3d autoprefixer bootstrap less AsyncIterator rm -fr sham BigInt64Array ender Array.prototype.findLastIndex validate installer Float64Array setPrototypeOf extend Object.assign import function search reuse omit serialization ts speed wait parents tostringtag https Observables Observable fsevents readable fastclone persistent Reflect.getPrototypeOf ES query prune ajv ES2017 push regular typedarray create protocol-buffers util .env argparse prefix Uint32Array waapi dependency manager warning hasOwn react animation Map helpers process typed array Array set mime-db typeof events stringify RegExp#flags slice flag width emoji graphql Uint8ClampedArray serialize collection npm util.inspect has less watch zero javascript sameValueZero watcher callbind trim fs fast -0 rgb mru tslib dayjs wrap expression Push unicode weakmap es2015 lazy stringifier resolve symbol eslintconfig app queue matches mkdir look styled-components wget wordwrap ast key channel es2018 bind positive json Array.prototype.flatMap lockfile hash dataView utils language error-handling entries xterm Array.prototype.flatten environment chromium dependencies flat arraybuffer variables in css pipe Object.entries typanion regex dom description take deep-copy streams2

1.0.0

11 days ago