README.md
# trailpack-annotations
[](https://greenkeeper.io/)
[![Gitter][gitter-image]][gitter-url]
[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-download]][npm-url]
[![Build status][ci-image]][ci-url]
[![Test status][vigo-image]][vigo-url]
[![Dependency Status][daviddm-image]][daviddm-url]
[![Code Climate][codeclimate-image]][codeclimate-url]
[](https://beerpay.io/jaumard/trailpack-annotations)
[](https://beerpay.io/jaumard/trailpack-annotations)
:package: Add Route, Policy and custom annotations support for Tails.js applications
## Intallation
With yo :
```
npm install -g yo generator-trails
yo trails:trailpack trailpack-annotations
```
With npm (you will have to create config file manually) :
`npm install --save trailpack-annotations`
## Configuration
First you need to add this trailpack to your __main__ configuration :
```js
// config/main.js
module.exports = {
...
packs: [
...
require('trailpack-annotations'),
...
]
...
}
```
Then :
```js
// config/annotations.js
module.exports = {
policy: true,//enable policy annotations
route: true,//enable route annotations
pathToScan: './api/controllers',//or ./api for hmvc
customAnnotations: null, //Add your custom annotations here, require('./annotations') for example
}
```
## Usage
### Route
A route added with annotation will replace any previous route set under `config/routes.js` (for a same path).
```
module.exports = class DefaultController extends Controller {
/**
* Return some info about this application
* @Route("GET /default/info") or @Route({method: ["GET"], path: "/default/info"})
*/
info (request, reply) {
reply.json(this.app.services.DefaultService.getApplicationInfo())
}
}
```
You can also use @METHOD for defining new routes.
```
module.exports = class DefaultController extends Controller {
/**
* Return some info about this application
* @GET('/default/info')
* @HEAD('/default/info')
* @OPTIONS('/default/info')
* @POST('/default/info')
* @PUT('/default/info')
* @PATCH('/default/info')
* @DELETE('/default/info')
*/
info (request, reply) {
reply.json(this.app.services.DefaultService.getApplicationInfo())
}
}
```
A more complex sample with validation.
```
module.exports = class DefaultController extends Controller {
/**
* Return some info about this application
* @GET(path:{'/default/info'}, config: { validate: {
* query: { infos: Joi.sring().required() }
* }})
*/
info (request, reply) {
reply.json(this.app.services.DefaultService.getApplicationInfo())
}
}
```
See [hapijs tutorial on validation](http://hapijs.com/tutorials/validation) and [joi schema validation](https://github.com/hapijs/joi) for more complex with validate object.
### Policy
A policy added with annotation will be added to policies set under `config/policies.js`.
```
module.exports = class DefaultController extends Controller {
/**
* Return some info about this application
* @Policy("Default.auth") or @Policy(["Default.auth", "Default.acl"])
*/
info (request, reply) {
reply.json(this.app.services.Defaultervice.getApplicationInfo())
}
}
```
### Custom
Create your own annotation like this :
```
'use strict'
const Annotation = require('ecmas-annotations').Annotation
module.exports = class MyCustomAnnotation extends Annotation{
/**
* The possible targets
*
* (Annotation.CONSTRUCTOR, Annotation.PROPERTY, Annotation.METHOD)
*
* @type {Array}
*/
static get targets() {
return [Annotation.METHOD]
}
/**
* The function to call when annotations are find
*
* @type {Function}
*/
handler(app, annotation) {
//Do whatever you want when annotation is found
}
/**
* File path
*
* @type {String}
* @required
*/
static get path() {
return __filename
}
}
```
Now I can add `@MyCustomAnnotation("It's works")` on methods.
## License
[MIT](https://github.com/jaumard/trailpack-annotations/blob/master/LICENSE)
[vigo-image]:https://vigoreport.io/p/badge/mrC2MUz
[vigo-url]:https://vigoreport.io/p/mrC2MUz
[npm-image]: https://img.shields.io/npm/v/trailpack-annotations.svg?style=flat-square
[npm-url]: https://npmjs.org/package/trailpack-annotations
[npm-download]: https://img.shields.io/npm/dt/trailpack-annotations.svg
[ci-image]: https://travis-ci.org/jaumard/trailpack-annotations.svg?branch=master
[ci-url]: https://travis-ci.org/jaumard/trailpack-annotations
[daviddm-image]: http://img.shields.io/david/jaumard/trailpack-annotations.svg?style=flat-square
[daviddm-url]: https://david-dm.org/jaumard/trailpack-annotations
[codeclimate-image]: https://img.shields.io/codeclimate/github/jaumard/trailpack-annotations.svg?style=flat-square
[codeclimate-url]: https://codeclimate.com/github/jaumard/trailpack-annotations
[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square
[gitter-url]: https://gitter.im/trailsjs/trails
## Support on Beerpay
Hey dude! Help me out for a couple of :beers:!
[](https://beerpay.io/jaumard/trailpack-annotations) [](https://beerpay.io/jaumard/trailpack-annotations?focus=wish)