Welcome to mirror list, hosted at ThFree Co, Russian Federation.

package.json « fs-vacuum « node_modules - github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 559b7bf2bd37663d5301a1f7f8c26ce7f4e63ca3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
  "name": "fs-vacuum",
  "version": "1.2.5",
  "description": "recursively remove empty directories -- to a point",
  "main": "vacuum.js",
  "scripts": {
    "test": "tap test/*.js"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/npm/fs-vacuum.git"
  },
  "keywords": [
    "rm",
    "rimraf",
    "clean"
  ],
  "author": {
    "name": "Forrest L Norvell",
    "email": "ogd@aoaioxxysz.net"
  },
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/npm/fs-vacuum/issues"
  },
  "homepage": "https://github.com/npm/fs-vacuum",
  "devDependencies": {
    "mkdirp": "^0.5.0",
    "tap": "^0.4.11",
    "tmp": "0.0.24"
  },
  "dependencies": {
    "graceful-fs": "^3.0.2",
    "path-is-inside": "^1.0.1",
    "rimraf": "^2.2.8"
  },
  "readme": "# fs-vacuum\n\nRemove the empty branches of a directory tree, optionally up to (but not\nincluding) a specified base directory. Optionally nukes the leaf directory.\n\n## Usage\n\n```javascript\nvar logger = require(\"npmlog\");\nvar vacuum = require(\"fs-vacuum\");\n\nvar options = {\n  base  : \"/path/to/my/tree/root\",\n  purge : true,\n  log   : logger.silly.bind(logger, \"myCleanup\")\n};\n\n/* Assuming there are no other files or directories in \"out\", \"to\", or \"my\",\n * the final path will just be \"/path/to/my/tree/root\".\n */\nvacuum(\"/path/to/my/tree/root/out/to/my/files\", function (error) {\n  if (error) console.error(\"Unable to cleanly vacuum:\", error.message);\n});\n```\n# vacuum(directory, options, callback)\n\n* `directory` {String} Leaf node to remove. **Must be a directory, symlink, or file.**\n* `options` {Object}\n  * `base` {String} No directories at or above this level of the filesystem will be removed.\n  * `purge` {Boolean} If set, nuke the whole leaf directory, including its contents.\n  * `log` {Function} A logging function that takes `npmlog`-compatible argument lists.\n* `callback` {Function} Function to call once vacuuming is complete.\n  * `error` {Error} What went wrong along the way, if anything.\n",
  "readmeFilename": "README.md",
  "gitHead": "4911a38a65b6a6cb19fc980d18304e1cfca91fbf",
  "_id": "fs-vacuum@1.2.5",
  "_shasum": "a5cbaa844b4b3a7cff139f3cc90e7f7007e5fbb8",
  "_from": "fs-vacuum@~1.2.5"
}