@namics/nitro-component-resolver

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

Stats

StarsIssuesVersionUpdatedCreatedSize
@namics/nitro-component-resolver
000.0.85 years ago5 years agoMinified + gzip package size for @namics/nitro-component-resolver in KB

Readme

Nitro Component Resolver

npm version Build Status Coverage Status Codestyle

The nitro component resolver looks up all pattern.json (can be changed) files in the given nitro components directory and provides fast and easy access to the files and their content during development and production.

Installation

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

Usage

const ComponentResolver = require('@namics/nitro-component-resolver');
const resolver = new ComponentResolver({
    rootDirectory: '/example/path/components',
    // Invalidate cache on file changes (can be set to false for production mode)
    // Default: true
    watch: true,
    // Main template (please adjust if you use another template language)
    // Default: '*/*/*.hbs'
    mainTemplate: '*/*/*.hbs',
    // Meta json which contains the component details
    // used by getComponents()
    // Default: '*/*/pattern.json'
    patternExpression: '*/*/pattern.json',
    // Wether to cache the examples
    // Default and recommend value: true
    cacheExamples: true,
});

resolver.getComponentTypes()
    .then(function(componentTypes) {
        // Returns all existing nitro component types e.g. 'atoms', 'molecules'
        console.log(componentTypes);
    });

resolver.getComponents()
    .then(function(components) {
        // Returns all nitro components and their package.json content
        console.log(components);
    });

resolver.getComponents('atoms')
    .then(function(components) {
        // Returns the nitro components of type 'atoms' and their package.json content
        console.log(components);
    });

resolver.getComponentExamples('a/path/to/atoms/button')
    .then(function(examples) {
        console.log(examples);
    });

resolver.getComponentReadme('a/path/to/atoms/button')
    .then(function(readme) {
        console.log(readme);
    });

Performance

The component resolver relies on chokidar.

Chokidar shares its internal file watcher so that only one io-watcher per file/folder is used even if multiple chokidar instances exist.

Caching

All resolved and parsed components are cached using the hot-file-cache module:

Concept flow uml

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.