Skip to content

Instantly share code, notes, and snippets.

@datapimp
Last active September 16, 2015 08:39
Show Gist options
  • Save datapimp/f57294ba59dc06a7048d to your computer and use it in GitHub Desktop.
Save datapimp/f57294ba59dc06a7048d to your computer and use it in GitHub Desktop.

In this project: https://github.com/architects/brief-node

There is a concept called a Briefcase.

A Briefcase is an object which represents a folder.

Here is an example:

https://github.com/architects/brief-node/tree/master/test/example

In this folder you'll see:

docs/epics/model-definition-dsl.md models/epic.js

The first is a markdown document, an instance of the epic document type, or model.

https://github.com/architects/brief-node/blob/master/test/example/docs/epics/model-definition-dsl.md https://github.com/architects/brief-node/blob/master/test/example/models/epic.js

A Plugin Approach

I would like to develop a way of bundling up models into plugins, and letting authors mix and match the plugins to use for an individual briefcase.

I'd like to have the following syntax:

var blueprint = require('brief-blueprint-plugin');
var brief = require('brief-node');
var briefcase = brief.use(blueprint).load("/path/to/blueprint")

This would allow me to define the models once, but have a dozen projects use them without needing to define them on their own.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment