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

@wixc3/codux-librarian

v0.5.0

Published

`codux-librarian` is a CLI tool for packaging libraries of third-party boards into a format that can be consumed by the Add Panel in Codux.

Downloads

2,402

Readme

Codux Librarian

codux-librarian is a CLI tool for packaging libraries of third-party boards into a format that can be consumed by the Add Panel in Codux.

This tool generates an NPM package containing the library's boards. This package then can be added as a dependency to the user's project. Once the user's project is opened in Codux, the packaged boards will be visible in the "libraries" section of the Add Panel.

Usage

  1. Add codux-librarian as a dev dependency to the project from which you want to provide boards to other projects.

    $ npm install --save-dev @wixc3/codux-librarian
  2. Create codux-librarian.config.json in the root directory of that project, and fill it in according to the format described in the LibrarianConfig interface.

  3. Run npx codux-librarian build.

  4. A new directory with the resulting package will be created. Publish this package to NPM.

  5. Add it as a dev dependency to the project that will be consuming the boards.

  6. Add the following setting to codux.config.json of the project consuming the boards:

    {
      "addPanel": {
        "assets": ["name-of-the-resulting-package"]
      }
    }

Limitations

  1. Boards that import components using a relative path are not currently supported. Components have to be imported from external package.
  2. Boards containing multiple return statements are not currently supported.
  3. Board cover images have to be imported using a relative path to the image file, extension included.