📦🚀 @aotu/fs

Useful file system utilities.

✅ An experimental project applying several cool stuffs, a boilerplate for writing new NPM packages.

✓ Auto-release with semantic-release

✓ Fast Unit Tests with ava

✓ Coverage with nyc

✓ Automated Code reviews with codacy

✓ Elegant documents via jsdoc-to-markdown along with gitbook

✓ Scoped NPM package

✓ Publish gh-pages automatically via travis-ci

✓ Semantic git commits via semantic-git-commit-cli

Unit Tests

npm test
// Or the watching mode
npm run test1

Debug

1. Write a debug file at test/debugs/your.debug.js
2. Run the debug command

node --inspect-brk test/debugs/your.debug.js

3. Open the Chrome inspector interface

chrome://inspect/

You will see the files listed for inspcecting.

4. Add the fs folder to the chrome-devtools's workspace

Docs

The documents are generated by jsdoc(jsdoc-to-markdown) along with gitbook(gitbook-cli) following this guide.

1. Initial build

npm run docs

2. Incremental build

npm run docs:build

3. Watching Mode

npm run docs:serve

4. Clean the generated docs

npm run docs:clean

Release

The module will be released automatically by semantic-release