Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
optometrist
Advanced tools
Option setting via flags, environment variables, and defaults (in that order).
Most of the others out there have way too much configuration to cut through, and for whatever reason environment varibles never got that popular among Nodeists.
npm install optometrist
Given a schema object, returns an object containing settings. They're retrieved in the following order of prioirty:
The schema object follows this structure:
{
'key': {
'description': 'It\'s a key.',
'required': true
},
'otherKey': {
'description': 'Please spell "key."',
'default': 'something'
}
}
If you include a 'required' key and it can't be found in any of the three locations,
Optometrist will throw. This is convenient for use with optometrist.usage()
, as below.
JSON.parse is used to coerce flags and environment variables back into Javascript objects.
Environment variable and flag names are converted to camel case for your convenience.
So if you define a setting in your schema with a name like 'howManyRomans', it'lll be
looked up in the environment as HOW_MANY_ROMANS
and in the flags as --how-many-romans
.
Flags should use the syntax --flag=value
.
Returns a string containing usage information for the schema. Useful for writing a command-line application.
Actually, all you have to do is:
var schema = {
foo: {
required: true
}
};
var settings;
try {
settings = optometrist.get(schema);
console.log('You provided', foo, 'for foo.');
} catch(e) {
console.log(optometrist.usage('myapp', 'Does cool stuff!', schema);
process.exit(1);
}
If the user fails to supply a value for foo
, they'll get the following:
Does cool stuff!
Usage: myapp options
Options:
--foo
Any of the parameters can also be set by environment variables:
FOO
Error: Missing required option foo
Nonrecursively merge keys from src1, src2, etc., into dst. Provided as a convenience.
git clone https://github.com/casetext/optometrist
cd optometrist
npm install
npm test
© 2014, J2H2, Inc. Licensed under ISC.
FAQs
Simple argument parsing via process.argv and process.env.
The npm package optometrist receives a total of 3 weekly downloads. As such, optometrist popularity was classified as not popular.
We found that optometrist demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.