nspragg / file-js

Abstract representation of a pathname

file-js

Abstract representation of a pathname

• Installation
• Features
• Demo
• Usage
• API
• Instance methods
• Test
• Contributing

Installation

npm install --save file-js

Demo

Features

• File glob matching
• File listings
• Assert file permissions
• Supports promises
• Supports synchronous and asynchronous methods
• Supports recursive operations (copy/delete)

Usage

const File = require('file-js');

const file = File.create('myDir');
const files = await file.getList();
files.forEach(console.log);

const file = File.create('myDirectory');
if (file.isDirectorySync()) {
  console.log('processing directory');
}

Documentation

For more examples and API details, see API documentation

Test

npm test

To generate a test coverage report:

npm run coverage

file-js's Issues

Update README and contributions

• Create separate contributions file and remove from README.
• Modify licence to Apache - see filehound

Delete recursively

Add support for deleteRecursively - delete file/dir and all of its children. Returns true if successful.

const dir = new File('dir');
dir.deleteRecursively();

Support deleteLine

Support deleteLine(number, string) for removing lines from a file:

const File = require("file-js");

new File("myFile")
  .deleteLine(1, "my line1")
  .deleteLine(10, "my line2")
  .save();

• Should be chainable
• .save() to commit changes.

Support setLine

Support setLine(number, string) for overriding a given line with text:

const File = require("file-js");

new File("myFile")
  .setLine(1, "my line1")
  .setLine(10, "my line2")
  .save();

• Should be chainable
• .save() to commit changes.

Review Test coverage

Review test coverage and patch any absent test cases.

Copy Recursively

Add support for copyRecursively.

const source = new File('sourceDir');
const dest = new File('destination');
source.copyRecursively(dest, options);

Supported options:

• overwrite (boolean, false by default)

Support file concatenation

Support .concat(file):

Example:

const f = new File('a').concat('b');

Support `getLines`

Support get lines via getLines(...n):

Example:

const lines = new File('someFile').getLines(1, 5, 10);
console.log(lines) // lines 1, 5, 10

Support `asString`

const File = require("file-js");

const f = new File("someFile");
console.log(f.asString()); // prints file contents

mkdir -p

Add support for mkdir -p

Use native Promises

Remove bluebird as a dep.