npm package: @pigalle/entities.plugin
Description: A class base for plugins usable by the Pigalle framework.
Author: SAS 9 Février
Latest version: 0.2.5

[npm-badge]: https://img.shields.io/npm/v/@pigalle/entities.plugin.svg
[npm-badge-url]: https://www.npmjs.com/package/@pigalle/entities.plugin
[npm-downloads-badge]: https://img.shields.io/npm/dt/@pigalle/entities.plugin.svg
[npm-downloads-url]: https://npmjs.org/package/@pigalle/entities.plugin
[travis-badge]: https://img.shields.io/travis/pigalle-io/pigalle.core.plugins.base.class/master.svg?label=TravisCI
[travis-badge-url]: https://travis-ci.org/pigalle-io/pigalle.core.plugins.base.class
[circle-badge]: https://circleci.com/gh/pigalle-io/pigalle.core.plugins.base.class/tree/master.svg?style=svg&circle-token=
[circle-badge-url]: https://circleci.com/gh/pigalle-io/pigalle.core.plugins.base.class/tree/master
[coveralls-badge]: https://coveralls.io/repos/github/pigalle-io/pigalle.core.plugins.base.class/badge.svg?branch=master
[coveralls-badge-url]: https://coveralls.io/github/pigalle-io/pigalle.core.plugins.base.class?branch=master
[codeclimate-badge]: https://img.shields.io/codeclimate/github/pigalle-io/pigalle.core.plugins.base.class.svg
[codeclimate-badge-url]: https://codeclimate.com/github/pigalle-io/pigalle.core.plugins.base.class
[ember-observer-badge]: http://emberobserver.com/badges/pigalle.core.plugins.base.class.svg
[ember-observer-badge-url]: http://emberobserver.com/addons/pigalle.core.plugins.base.class
[license-badge]: https://img.shields.io/npm/l/@pigalle/entities.plugin.svg
[license-badge-url]: LICENSE.md
[dependencies-badge]: https://img.shields.io/david/pigalle-io/pigalle.core.plugins.base.class.svg
[dependencies-badge-url]: https://david-dm.org/pigalle-io/pigalle.core.plugins.base.class
[devDependencies-badge]: https://img.shields.io/david/dev/pigalle-io/pigalle.core.plugins.base.class.svg
[devDependencies-badge-url]: https://david-dm.org/pigalle-io/pigalle.core.plugins.base.class#info=devDependencies
[greenkeeper-badge]: https://badges.greenkeeper.io/pigalle-io/pigalle.core.plugins.base.class.svg
[greenkeeper-badge-url]: https://greenkeeper.io/
[standardjs-badge]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standardjs-badge-url]: https://standardjs.com


# pigalle.core.plugins.base.class

A class base for plugins usable by the Pigalle framework.


---
&#x1F34E; <span style="color:red">**__Warning !__ Work in progress...**</span>
---


[![JavaScript Style Guide][standardjs-badge]][standardjs-badge-url]
[![Latest NPM release][npm-badge]][npm-badge-url]
[![NPM Downloads][npm-downloads-badge]][npm-downloads-url]
[![TravisCI Build Status][travis-badge]][travis-badge-url]
[![Test Coverage][coveralls-badge]][coveralls-badge-url]
[![Code Climate][codeclimate-badge]][codeclimate-badge-url]
[![License][license-badge]][license-badge-url]
[![Dependencies][dependencies-badge]][dependencies-badge-url] 
[![Dev Dependencies][devDependencies-badge]][devDependencies-badge-url]
[![Greenkeeper badge][greenkeeper-badge]][greenkeeper-badge-url]

## Table of Contents

* [Synopsis](#synopsis)
* [Usage](#usage)
* [Installation](#installation)
* [API Reference](#api-reference)
* [Tests](#tests)
  * [Run unit tests](#tests_run-unit-tests)
* [Build](#build)
  * [Documentation](#build-documentation)
* [Compatibility](#compatibility)
  * [Node](#compatibility_node)
  * [Browser](#compatibility_browser)
* [Issues](#issues)
* [Contributing](#contributing)
* [Credits](#credits)
* [History](#history)
* [License](#license)

## <a name="synopsis"> Synopsis

A class base for plugins usable by the Pigalle framework.

**All plugins developed for the Pigalle framework must derived this base class.**

## <a name="usage"> Usage

```javascript

const {PluginEntity} = require('@pigalle/entities.plugins')

class CustomPlugin extends PluginEntity {

  constructor (...args) {
    super(...args)
  }

  run() {
    return Promise.revolve(true)
  }

}

```

## <a name="installation"> Installation

    npm install @pigalle/entities.plugin

## <a name="api-reference"> API Reference

Please refer to [API documentation](docs/API.md).

## <a name="test"> Tests

### <a name="tests_run-unit-tests"> Run unit tests

    npm test
    
## <a name="build"> Build

### <a name="build-documentation"> Build documentation

**Be careful!** Documentation ([README](README.md) and [API](docs/API.md)) is generated using templates. Please **only** modify documentation from related [templates](./.templates).

Then you can build documentation using the following command:

   npm run docs
   
or:

   gulp docs


## <a name="compatibility"> Compatibility

### <a name="compatibility_node"> Node

Tested using [Node 9.5.0](https://nodejs.org/dist/v9.5.0/docs/api/).

### <a name="compatibility_browser"> Browser

Untested at this time.

## <a name="issues"> Issues

Feel free to [submit issues](https://github.com/pigalle-io/pigalle.core.plugins.base.class/issues) and enhancement requests.

## <a name="contributing"> Contributing

Please refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

 1. **Fork** the repo on GitHub
 2. **Clone** the project to your own machine
 3. **Commit** changes to your own branch
 4. **Push** your work back up to your fork
 5. Submit a **Pull request** so that we can review your changes

**NOTE**: Be sure to merge the latest from "upstream" before making a pull request!

## <a name="credits"> Credits

### Thanks to the developers of the very useful dependencies...

* [@pigalle/entities.base](https://github.com/pigalle-io/pigalle.entities.base) by [pigalle.io](https://github.com/pigalle-io/)
* [@9fv.io/notimplemented-error](https://github.com/9fv/node-notimplemented-error) by [9fv.io](https://github.com/9fv)

## <a name="history"> History

Please refer to [the changelog file](docs/CHANGELOG.md).

## <a name="license"> License

>
> [The MIT License](https://opensource.org/licenses/MIT)
>
> Copyright (c) 2018 [SAS 9 Février](https://9fevrier.com/)
>
> Permission is hereby granted, free of charge, to any person obtaining a copy
> of this software and associated documentation files (the "Software"), to deal
> in the Software without restriction, including without limitation the rights
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> copies of the Software, and to permit persons to whom the Software is
> furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all
> copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> SOFTWARE.
>