Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
ano-json
Advanced tools
Readme
Read ano.json
files with semantics, normalisation, defaults and validation.
Install via npm: npm install --save ano-json
Reads file
and applies normalisation, defaults and validation according to the ano.json
spec.
If the passed file
does not exist, the callback is called with error.code
equal to ENOENT
.
If the passed file
contents are not valid JSON, the callback is called with error.code
equal to EMALFORMED
.
If the json
does not comply with the ano.json
spec, the callback is called with error.code
equal to EINVALID
.
If file
is a directory, find()
will be used to search for the json file.
The options
argument is optional and can be omitted. These options will be passed to parse
method.
var bowerJson = require('ano-json');
// Can also be used by simply calling bowerJson()
bowerJson.read('/path/to/ano.json', function (err, json) {
if (err) {
console.error('There was an error reading the file');
console.error(err.message);
return;
}
console.log('JSON: ', json);
});
Parses an object. Useful when you want to apply normalisation and validation directly to an object.
If the json
does not comply with the ano.json
spec, an error is thrown with error.code
equal to EINVALID
.
The options
arguments is optional and can be omitted. Available options:
true
false
json
object instead of using it directly, defaults to false
var bowerJson = require('ano-json');
var json = {
name: 'my-package',
version: '0.0.1'
};
try {
bowerJson.parse(json);
} catch (err) {
console.error('There was an error parsing the object');
console.error(err.message);
}
Validates the passed json
object.
Returns an object with errors and warnings of this ano.json contents.
var bowerJson = require('ano-json');
var json = {
name: 'myPackage',
version: '0.0.1',
main: {}
};
var issues = bowerJson.getIssues(json);
expect(issues).toEqual({
errors: ['The "main" field has to be either an Array or a String'],
warnings: ['The "name" must be lowercase']
});
#### .validate(json)
Validates the passed `json` object.
Throws an error with `error.code` equal to `EINVALID` if it does not comply with the spec.
```js
var bowerJson = require('ano-json');
var json = {
name: 'myPackage',
version: '0.0.1'
};
try {
bowerJson.validate(json);
} catch (err) {
console.error('There was an error validating the object');
console.error(err.message);
}
var bowerJson = require('ano-json');
var json = {
name: 'my-package',
version: '0.0.1',
main: 'foo.js,bar.js'
};
bowerJson.normalize(json);
json.main // ['foo.js', 'bar.js']
Finds the json
filename inside a folder.
Checks if a ano.json
exists, falling back to library.json
(deprecated) and .ano.json
.
If no file was found, the callback is called with a error.code
of ENOENT
.
var bowerJson = require('ano-json');
bowerJson.find('/path/to/folder', function (err, filename) {
if (err) {
console.error('There is no json file in the folder');
return;
}
console.log('Filename: ', filename);
// Now that we got the filename, we can read its contents
bowerJson.read(filename, function (err, json) {
if (err) {
console.error('There was an error reading the file');
console.error(err.message);
return;
}
console.log('JSON: ', json);
});
});
Released under the MIT License.
FAQs
Read ano.json files with semantics, normalisation, defaults and validation
The npm package ano-json receives a total of 6 weekly downloads. As such, ano-json popularity was classified as not popular.
We found that ano-json 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.