Rails-like console with express.js, bookshelf.js and node-repl-promised

README.md

Install node-repl-promised: npm install -g repl-promised

Use the repl to list all users

$ node-promised
> var app = require('./app');
undefined
> var Bookshelf = app.get('bookshelf');
undefined
> Bookshelf.models.User.query()
[ { id: 5,
    email: 'chuck@norris.com',
    name: 'Chuck Norris',
    password_hash: '$2a$10$MuSVvgsOYGBMK12p4boSh.eX/FmmDXvbhrGfJcHPJQr0BLVEOrTcy',
    created_at: 1411628445371,
    updated_at: 1411628445371 } ]
>

If you want to have something pre-defined in your global context, you need to create your own repl initialization script:

var repl = require("repl").start({}),
    promisify = require("repl-promised").promisify,
    app = require('./app');
repl.context.models = app.get('bookshelf').models;
promisify(repl);

after that you can use models-variable directly:

$ node repl.js 
> models.User.query()
[ { id: 5,
    email: 'chuck@norris.com',
    name: 'Chuck Norris',
    password_hash: '$2a$10$MuSVvgsOYGBMK12p4boSh.eX/FmmDXvbhrGfJcHPJQr0BLVEOrTcy',
    created_at: 1411628445371,
    updated_at: 1411628445371 } ]
>

app.js

var express = require('express'),
    app = express(),
    Bookshelf = require('./bookshelf');
    
app.set('bookshelf', Bookshelf);

module.exports = app;

bookshelf.js

var knex = require('knex')({
  client: 'sqlite',
  connection: {
    filename: './development.sqlite'
  }
});
var Bookshelf = module.exports = require('bookshelf')(knex);

Bookshelf.models = {
  User: Bookshelf.Model.extend({
    tableName: 'users'
  })
};

looks great, will try it and report back

this is awesome do u know how can I use this with babel ? to support es6 and es7?

this work with koajs as well?

Thanks for the idea, I didn't use Bookshelf, but something like this:

var repl = require('repl').start({})
var promisify = require('repl-promised').promisify

repl.context.Team = require('pubsweet-core/api/models/Team')
repl.context.Collection = require('pubsweet-core/api/models/Collection')
repl.context.User = require('pubsweet-core/api/models/User')
repl.context.Fragment = require('pubsweet-core/api/models/Fragment')

promisify(repl)

Resulted in a very useful REPL - rails console like. So thank you very much!

Just what I was looking for. Thank you so much!

Is there a way to do this with Objection.js? I cant find a way to get a list of all the subclasses of Model because Objection uses es6 extends to create subclasses instead of Bookshelfs internally defined extend. I think each model would need to be added to repl.context explicitly.