@namics/nitro-component-resolver

Nitro Component Resolver

A helper to resolve and parse the nitro pattern structure and meta files.

Installation

npm i --save-dev @namics/nitro-component-resolver

Usage

const ComponentResolver = require('@namics/nitro-component-resolver');
const resolver = new ComponentResolver({
    rootDirectory: rootDirectories.valid,
    // Readme lookup
    readme: true,
    // Example lookup
    examples: true,
    // File watch mode
    watch: true
});
resolver.getComponents()
    .then(function(components) {
        console.log(components);
    });
// Optional
resolver.getComponentExamples('a/path/to/atoms/button')
    .then(function(examples) {
        console.log(examples);
    });
// Optional
resolver.getComponentReadme('a/path/to/atoms/button')
    .then(function(readme) {
        console.log(readme);
    });