tjwebb/marlinspike

Superpowers for your Sails.js Hooks.

marlinspike

Superpowers for your Sails.js Hooks.

Features

• Makes it easy to build and maintain Sails Hooks as separate projects
• Magically extend Sails apps with additional Model, Controllers, Services.

Compatibility

• Sails.js 0.12 and newer
• node.js 0.12 and newer

Install

$ npm install marlinspike --save

Usage

// config/customhook.js
export const customhook = {
  /**
   * Load hook into sails.hooks.custom
   */
  name: 'custom',

  /**
   * Load hook config into sails.hook.customHook
   */
  configKey: 'customHook',

  marlinspike: {
    /**
     * Load controllers from ../api/controllers into the parent app
     */
    controllers: true,

    /**
     * Load models from ../api/models into the parent app
     */
    models: true,

    /**
     * Load services from ../api/services into the parent app
     */
    services: true,

    /**
     * Load config from ../config/customhook.js into the parent app
     */
    config: true
  }
}

// api/hooks/customhook.js
import Marlinspike from 'marlinspike'

class CustomHook extends Marlinspike {
  defaults (overrides) {
    // http://sailsjs.org/documentation/concepts/extending-sails/hooks/hook-specification/defaults#?using-defaults-as-a-function
  },

  configure () {
    // this.sails = sails
    // http://sailsjs.org/documentation/concepts/extending-sails/hooks/hook-specification/configure
  },

  initialize (next) {
    // http://sailsjs.org/documentation/concepts/extending-sails/hooks/hook-specification/initialize
  },

  routes () {
    return {
      // http://sailsjs.org/documentation/concepts/extending-sails/hooks/hook-specification/routes
    }
  }
}

export default Marlinspike.createSailsHook(CustomHook)

License

MIT

marlinspike's Issues

Ending Sails.js support

In February of 2016, support for marlinspike will end. As many of you know, this project has been hamstrung by the Sails.js team's inability to release any of the 0.12.x series versions in a timely manner.

We are transitioning all of our efforts to developing and supporting Trails.js, the successor to Sails.js, There is a long history behind this decision, some of which is documented in this thread in the Sails project: balderdashy/sails#3429 (comment).

Here is the ROADMAP for trails.js: https://github.com/trailsjs/trails/blob/master/ROADMAP.md

Load responses and blueprints

I think it makes sense to add responses and blueprints :)

loading model with other ORM

When loading models it does not work with sother ORM such as sails-hooks-sequelize
I will see if we can load models using something like:
sails-inject-models

Model instance methods broken with sails 0.12.3

I have payment system marlinspike hook. In this hook i have model User.js.

module.exports={
    attributes:{
        balance     : {
            type:'integer',
            defaultsTo:0
        },
        getBalance:function(){
            return this.balance/sails.config['paymentsystem'].currency_factor||0;
        },
        getFormatedBalance:function () {
            return String(this.getBalance()).replace(/(\d)(?=(\d\d\d)+([^\d]|$))/g, '$1 ');
        }
    }
}

Since sails 0.12.3 i can not call getBalance or getFormatedBalance or any other model method from my parent app.