@talloinc/celula v0.8.6

permalink: /index.html

Celula

Scripts

To aid in the development, deployment, and maintenance of Celula, there are several tasks/scripts available to you via the command line; yarn run [task]

build

The build task produces a build that is the same as what is deployed to npm. Ultimately this task runs the prettier, and eslint fixes, then builds the component library. It runs the clean, prebuild, and build:components tasks, in that order.

build:components

The build:components task builds the component library.

build:icons

The build:icons task uses svg-sprite-generate to build the icon sprite used by the various icon components.

build:styleguide

The build:styleguide task builds the styleguide documentation site (Storybook).

check

The check task runs the eslint and prettier checks. It does not fix any of the errors/warnings.

clean

The clean task uses rimraf to delete the docs and the dist directories.

coverage

The coverage taske runs the test suite and generates a coverage report.

generate

The generate task uses plop to generate the boilerplate for a new React component.

lint:check

The lint:check task runs the eslint checks. It does not fix any of the errors/warnings.

lint:fix

The lint:fix task fixes any eslint errors/warnings possible.

optimize:icons

The optimize:icons task runs the svgOptimize script. That script optimizes and normalizes all the icons, using svgo. This task should always be run before the build:icons task.

prebuild

The prebuild task runs the prettier and eslint fix tasks.

pretty:check

The pretty:check task runs the prettier checks. It does not fix any of the errors/warnings.

pretty:fix

The pretty:fix task fixes any prettier erros/warnings possible.

start

The start task runs the documentation site (Storybook) for devlopment.

test

The test task runs the jest tests.

test:debug

The test:debug task runs the jest tests in debug mode. This is helpful if you need to see into other libs your tests might be 'using', such as a component from Semantic UI your component composes.

Once the test is complete, you will need to vist chrome://inspect in Google Chrome. You should see something that looks like this:

TODO: Add screenshot

Under 'Remote Target' click the inspect link to be taken to the debugger.

test:watch

The test:watch task runs the jest tests, in watch mode.

Once running, you have several options:

• Press a to run all tests.
• Press f to run only failed tests.
• Press p to filter by a filename regex pattern.
• Press t to filter by a test name regex pattern.
• Press q to quit watch mode.
• Press Enter to trigger a test run.

And if the snapshots are out of date:

• Press u to update the snapshots.