Skip to content

pinf-it/pinf-it-package-insight

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Status: DEV

Package Insight

Package standards are evolving but there are various differences across communities.

This library attempts to generate a normalized package descriptor and manifest for any package that adheres to any of the following conventions:

Install

npm install pinf-it-package-insight

Usage

const PACKAGE_INSIGHT = require("pinf-it-package-insight");

PACKAGE_INSIGHT.parseDescriptor("<path>" || <object>, {
	type: "<type>" || null
}, function(err, descriptor) {
	// `descriptor.raw`
	// `descriptor.notmalized`
	// `descriptor.combined`
	// `descriptor.warnings`
	// `descriptor.errors`
});

Development

npm test

License

UNLICENSE