@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,561
Maintainers
Keywords
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
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
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.Run
npx codux-librarian build
.A new directory with the resulting package will be created. Publish this package to NPM.
Add it as a dev dependency to the project that will be consuming the boards.
Add the following setting to
codux.config.json
of the project consuming the boards:{ "addPanel": { "assets": ["name-of-the-resulting-package"] } }
Limitations
- Boards that import components using a relative path are not currently supported. Components have to be imported from external package.
- Boards containing multiple return statements are not currently supported.
- Board cover images have to be imported using a relative path to the image file, extension included.