drafts

OLD Home page

The Icestudio collections manager is a cli tool that helps to create and update an Icestudio collection with the following commands.

Installation

pip install icm

Commands

icm create

$ icm create
Create a collection structure
 - `blocks` directory created
 - `examples` directory created
 - `locale` directory created
 - `LICENSE` file created
 - `package.json` file created
 - `README.md` file created

It creates this collection structure:

├── blocks/
├── examples/
├── locale/
├── LICENSE
├── package.json
└── README.md

If any directory or file exists, it will NOT be overwritten.

icm update

$ icm update
Update the collection
The `README.md` file has changes.
Do you want to replace it? [y/N]: y
`README.md` updated
`locale/translation.js` created

It updates the README.md file based on the collection: all the collection labels (blocks, examples, languages) and the package information (name, version, description, authors, contributors, license) will be updated in the README.md file.

It also updates the locale/translation.js file, extracting the texts from the collection (directory names, file names, block descriptions and block info data). This file can be used to generate or update the PO files using Poedit.

If any file exists, the user will be ASKED to replace it.

icm validate

$ icm validate
Validate the collection

The collection is valid :)

It validates the collection:

• blocks or examples required
• package.json required
  • name required
  • semantic version required (semver)
  • description required

If the collection is not valid, the errors will be shown.