rvanasa / sorcerer Goto Github PK

// all files in the provided directory use this general format
module.exports = function(Config)
{
	var app = {};
	console.log('Initialize some sort of app here');
	return app;
}

module.exports = {
	whateverYouWantHere: 'yeah'
}

module.exports = function(App)
{
	// this will evaluate since it is referencing an active resource
	App.name = 'Decorated App';
}

module.exports = {
	basePath: __dirname, // default: execution directory
	verbose: true, // default: false (you can use strings/arrays to allow verbosity in specific environments)
	packages: [{
		env: 'production', // use specified env (process.env.NODE_ENV by default)
		path: '/src', // you can also just pass the path string instead of a config object
	}, {
		name: 'globals', // optional
		include: { // note that you can use both `path` and `include` in the same package
			Config: () => 'Some example resource',
		},
	}],
};

// simple example (no config object)
require('sorc')(__dirname + '/src', 'App');


// using externalized config
var config = require('./sorcerer.config');

// configure a directory
require('sorc')(config, (App) =>
{
	// You can use any file as an entry point
	console.log(App);
});

// or, configure a directory with a specified environment
require('sorc')(config, 'test', (App, Config) =>
{
	console.log(App, Config);
});

// or, configure a directory with error handling
require('sorc')(config, (err, App) =>
{
	if(err) return console.error(err);
	
	console.log(App);
});