Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

meta-modules in node #203

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ var Spinner = require('ora')

var program = require('commander');
var readlineSync = require('readline-sync');
var metaModules = require('./src/config/MetaModules')

function exit(message) {
console.error(message);
Expand Down Expand Up @@ -33,10 +34,15 @@ require('fs').access(program.image, function(err){
if(err) exit("Can't read file.")
});

//Expand the metamodules in steps
program.step = expandMetaModules(program.step);

// User must input a step. If steps exist, check that every step is a valid step.
if(!program.step || !validateSteps(program.step))
exit("Please ensure all steps are valid.");



// If there's no user defined output directory, select a default directory.
program.output = program.output || "./output/";

Expand Down Expand Up @@ -162,4 +168,17 @@ function validateConfig(config_,options_){
return false;
else
return true;
}
function expandMetaModules(steps){
let result = steps.slice(0);
for(let step in steps){
for(module in metaModules){
if(metaModules[module].name == steps[step]){
let temp = result.splice(0,step);
temp.push(...metaModules[module].steps,...result.slice(step+1));
result = temp;
}
}
}
return result;
}
10 changes: 10 additions & 0 deletions src/config/MetaModules.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[
{
"name": "example",
"description": "An example meta module",
"steps":[
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So while this is cool, I wonder if we can specify meta modules in a serialized string that is readable as part of a url request. Maybe we need both options so like this OR ?steps=invert[settings...],green-channel, threshold [50] just for example.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jywarren you are talking about the browser, right? Actually we have a separate issue to do this for the browser and it's a part of summer proposal as well, if you say i can start working on this right now?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jywarren this also looks doable, as part of summer project we will be having support for saving a sequence with settings in the url itself and as far as connecting it with this we can have a method that outputs the readable part of the url from the meta-module

function genarateURL(module){
/* generate a string based on default values and sequence of steps8?
return the string
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the ability to record both steps and settings in a string could be useful for browser work, for saving sequences in localStorage, in a key/value database on server or client side, and for REST based processing, so I think it's worth considering for all those reasons.

Great, though -- so for this PR, so as not to create an incompatibility, we should either think about a subset of the full syntax that will remain compatible after the settings-in-a-string feature, so while here we might just enable settings steps in JSON, we should expect to be able to detect a string submission and switch into a different parsing mode which can read in the settings. I think that means we are OK here - but maybe we should leave an inline comment saying we'll soon accept compact string format like ?steps=invert(settings...),green-channel,threshold(50)

Perhaps using parentheses will make it more like a function call... but we don't have to make a final decision just yet.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #127 for current planning on compact settings options in URLs

"green-channel",
"invert"
]
}
]