<commit_before># 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.

- Written in **ES6**
- **Node-only compatible**.

## Install

```
npm install js-task-path
```

## Usage

For additional examples,
check the **[test folder](https://github.com/jsstd/js-task-path/tree/master/test)**

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

// add general paths
paths.addPath("dist",  "<root>/dist");
paths.addPath("src",   "<root>/src");
paths.addPath("doc",   "<root>/doc");
paths.addPath("tasks", "<root>/tasks");
paths.addPath("tests", "<root>/tests");

// use previously given, custom paths via token
paths.addPath("build-tasks", "<tasks>/build/*.js");

// add individual files
paths.addPath("source-file", "<src>/src.js");
paths.addPath("dist-file",   "<dist>/dist.js");

// get paths by name
paths.getPath("source-file");
paths.getPath("dist-file");

// example, when using gulp
gulp.task("build::copy-source", function() {
    return gulp
        .src(paths.getPath("source-file"))
        .pipe(
            gulp.dest(paths.getPath("dist")
        ));
});

// example, when using gulp, using shorter paths aliases
// for shorter paths aliases, check the documentation
gulp.task("build::copy-source", function() {
    return gulp
        .src(paths.get("source-file"))
        .pipe(
            gulp.dest(paths.get("dist")
        ));
});
```

## Documentation

Check the source 
[here](https://github.com/jsopenstd/js-task-path/blob/master/src/js-task-path.js)
since it's well structured and documented. Also you can find the rendered jsDoc documentation on 
[Doclets.io](https://doclets.io/jsopenstd/js-task-path/master). 

Also, check the [unit tests](https://github.com/jsopenstd/js-task-path/blob/master/tests/tests.js) 
in order to grasp the full-fledged capabilities.

Have fun! ;)

## Issues

If you find any bugs and other issues, check the
[GSDC Guide - Issues](https://github.com/openstd/general-software-development-contribution-guide#issues)
section on how to submit issues in a standardized way on
[the project's issues page](https://github.com/jsopenstd/js-task-path/issues).

In case you have any suggestions regarding the project (features, additional capabilities, etc.), check the
[GSDC Guide - Suggestions](https://github.com/openstd/general-software-development-contribution-guide#suggestions)
section on how to submit suggestions in an easy, standardized way on
[the project's issues page](https://github.com/jsopenstd/js-task-path/issues).

## Contribution

In order to contribute to this project, check the
[GSDC Guide](https://github.com/openstd/general-software-development-contribution-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](https://github.com/jsopenstd/jsopenstd/blob/master/support.md).

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

## License

[MIT](license.md) @ <NAME>

[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

[partial-link]:  https://github.com/jsopenstd/jsopenstd/blob/master/readme.md#partial 
[umd-link]:      https://github.com/jsopenstd/jsopenstd/blob/master/readme.md#umd
<commit_msg>Minor semantic fix in readme<commit_after># 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.

- Written in **ES6**
- **Node-only compatible**.

## Install

```
npm install js-task-path
```

## Usage

For additional examples,
check the **[test folder](https://github.com/jsstd/js-task-path/tree/master/test)**

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

// add general paths
paths.addPath("dist",  "<root>/dist");
paths.addPath("src",   "<root>/src");
paths.addPath("doc",   "<root>/doc");
paths.addPath("tasks", "<root>/tasks");
paths.addPath("tests", "<root>/tests");

// use previously given, custom paths via token
paths.addPath("build-tasks", "<tasks>/build/*.js");

// add individual files
paths.addPath("source-file", "<src>/src.js");
paths.addPath("dist-file",   "<dist>/dist.js");

// get paths by name
paths.getPath("source-file");
paths.getPath("dist-file");

// example, when using gulp
gulp.task("build::copy-source", function() {
    return gulp
        .src(paths.getPath("source-file"))
        .pipe(
            gulp.dest(paths.getPath("dist")
        ));
});

// example, when using gulp, using shorter paths aliases
// for shorter paths aliases, check the documentation
gulp.task("build::copy-source", function() {
    return gulp
        .src(paths.get("source-file"))
        .pipe(
            gulp.dest(paths.get("dist")
        ));
});
```

## Documentation

Check the source 
[here](https://github.com/jsopenstd/js-task-path/blob/master/src/js-task-path.js)
since it's well structured and documented. Also you can find the rendered jsDoc documentation on 
[Doclets.io](https://doclets.io/jsopenstd/js-task-path/master). 

Also, check the [unit tests](https://github.com/jsopenstd/js-task-path/blob/master/tests/tests.js) 
in order to grasp the full-fledged capabilities.

Have fun! ;)

## Issues

If you find any bugs and other issues, check the
[GSDC Guide - Issues](https://github.com/openstd/general-software-development-contribution-guide#issues)
section on how to submit issues in a standardized way on
[the project's issues page](https://github.com/jsopenstd/js-task-path/issues).

In case you have any suggestions regarding the project (features, additional capabilities, etc.), check the
[GSDC Guide - Suggestions](https://github.com/openstd/general-software-development-contribution-guide#suggestions)
section on how to submit suggestions in an easy, standardized way on
[the project's issues page](https://github.com/jsopenstd/js-task-path/issues).

## Contribution

In order to contribute to this project, check the
[GSDC Guide](https://github.com/openstd/general-software-development-contribution-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](https://github.com/jsopenstd/jsopenstd/blob/master/support.md).

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

## License

[MIT](license.md) @ <NAME>

[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

[partial-link]:  https://github.com/jsopenstd/jsopenstd/blob/master/readme.md#partial 
[umd-link]:      https://github.com/jsopenstd/jsopenstd/blob/master/readme.md#umd

{'fraction_non_alphanumeric': 0.16935909618836448, 'fraction_numerical': 0.00021117094287825995, 'mean_word_length': 4.259300388672959, 'pattern_counts': {'":': 0, '<': 21, '<?xml version=': 0, '>': 21, 'https://': 52, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6732900', 'n_tokens_mistral': 3268, 'n_tokens_neox': 3186, 'n_words': 634}