npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@namics/nitro-component-resolver

v0.0.8

Published

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

Downloads

21

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