Make a directory and its parents if needed - Think `mkdir -p`
npm install make-dir> Make a directory and its parents if needed - Think mkdir -p
> [!TIP]
> You probably want the built-in fsPromises.mkdir('…', {recursive: true}) instead.
- Supports a custom fs implementation.
- Promise API (Async/await ready!)
- Fixes many mkdirp issues
- CI-tested on macOS, Linux, and Windows
- Actively maintained
- Doesn't bundle a CLI
- Uses the native fs.mkdir/mkdirSync recursive option in Node.js unless overridden
``sh`
npm install make-dir
`console`
$ pwd
/Users/sindresorhus/fun
$ tree
.
`js
import {makeDirectory} from 'make-dir';
const path = await makeDirectory('unicorn/rainbow/cake');
console.log(path);
//=> '/Users/sindresorhus/fun/unicorn/rainbow/cake'
`
`console`
$ tree
.
└── unicorn
└── rainbow
└── cake
Multiple directories:
`js
import {makeDirectory} from 'make-dir';
const paths = await Promise.all([
makeDirectory('unicorn/rainbow'),
makeDirectory('foo/bar')
]);
console.log(paths);
/*
[
'/Users/sindresorhus/fun/unicorn/rainbow',
'/Users/sindresorhus/fun/foo/bar'
]
*/
`
Returns a Promise for the path to the created directory.
Returns the path to the created directory.
#### path
Type: string | URL
The directory to create.
#### options
Type: object
##### mode
Type: integer\0o777
Default:
The directory permissions.
##### fs
Type: object\import fs from 'node:fs'
Default:
Use a custom fs implementation. For example graceful-fs.
Using a custom fs implementation will block the use of the native recursive option if fs.mkdir or fs.mkdirSync` is not the native function.
- make-dir-cli - CLI for this module
- del - Delete files and directories
- globby - User-friendly glob matching
- cpy - Copy files
- cpy-cli - Copy files on the command-line
- move-file - Move a file