js-task-path

[![Recent Version][npm-badge]][npm-url]
[![Travis CI - Build Status][travis-badge]][travis-url]
[![Coveralls - Code Coverage Status][cov-badge]][cov-url]
[![David - Dependencies][dep-badge]][dep-url]
[![David - DevDependencies][dev-dep-badge]][dev-dep-url]
[![Doclets][doclets-badge]][doclets-url]
[![Gitter - Repository Chat][chat-badge]][chat-url]

Synopsis

A helper class to manage task-, build- and deployment-related paths more easily throughout
the whole project. It provides an intuitive method to handle path shortcuts for custom paths.

- Written in ES6
- Node-only.

Install

``
npm install js-task-path
`

Usage

For additional examples,
check the unit tests

`javascript
const path = require('js-task-path');

// after require, you can use path right away without instantiation, since it's a singleton

// set custom paths
// '' is present by default and its value is automatically determined and set to the package's root
path.set('dist', '/dist');
path.set('src', '/src');
path.set('doc', '/doc');

// or use chaining
path.set('lib', '/lib')
.set('scripts', '/scripts')
.set('examples', '/examples');

// or use the shorthand versions
path('tasks', '/tasks');
path({
tests : '/tests',
vars : '/vars'
});

// when setting paths, use previous paths with tokens
// also works with every form of path settings
path.set('test-cases', '/cases');

/*
default tokens (with 'root'):

''
'<>'
'@root@'
'{@root@}'
'{%root%}'
'{{root}}'
*/

// use paths
path.get('dist'); // will be '/dist', where will be auto-resolved to package root (e.g.: '/vagrant/dist')

// or the shorthand version
path('dist');

// if the path constructed via different layers (e.g.: '/cases', where too is '/tests'),
// the full path will be resolved.
path.get('test-cases'); // will be e.g.: '/vagrant/tests/cases'
``

Documentation

Check the source
here
since it's well structured and documented. Also you can find the rendered JSDoc documentation on
Doclets.io.

Also, check the unit tests
in order to grasp the full-fledged capabilities.

Have fun! ;)

Issues

If you find any bugs and other issues, check the
GSDC Guide - Issues
section on how to submit issues in a standardized way on
the project's issues page.

In case you have any suggestions regarding the project (features, additional capabilities, etc.), check the
GSDC Guide - Suggestions
section on how to submit suggestions in an easy, standardized way on
the project's issues page.

Contribution

In order to contribute to this project, check the
GSDC Guide
for an easy, standardized way on how to contribute to projects.

Support

If you by any means find this project useful,
consider supporting the organization.

There are multiple options to support the project and the developers.
Any means of support is beneficial and helpful.

License

MIT @ Richard King

[npm-badge]: https://img.shields.io/npm/v/js-task-path.svg
[npm-url]: https://www.npmjs.com/package/js-task-path

[travis-badge]: https://travis-ci.org/jsopenstd/js-task-path.svg?branch=master
[travis-url]: https://travis-ci.org/jsopenstd/js-task-path

[cov-badge]: https://coveralls.io/repos/github/jsopenstd/js-task-path/badge.svg?branch=master
[cov-url]: https://coveralls.io/github/jsopenstd/js-task-path

[dep-badge]: https://david-dm.org/jsopenstd/js-task-path.svg
[dep-url]: https://david-dm.org/jsopenstd/js-task-path

[dev-dep-badge]: https://david-dm.org/jsopenstd/js-task-path/dev-status.svg
[dev-dep-url]: https://david-dm.org/jsopenstd/js-task-path#info=devDependencies

[doclets-badge]: https://img.shields.io/badge/style-on_doclets-brightgreen.svg?style=flat-square&label=docs
[doclets-url]: https://doclets.io/jsopenstd/js-task-path/master

[chat-badge]: https://badges.gitter.im/jsopenstd/js-task-path.svg
[chat-url]: https://gitter.im/jsopenstd/js-task-path?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge