1.1.0 • Published 1 year ago

@shopify/loom-cli v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@shopify/loom-cli

The CLI for working with loom.

These commands trigger the functionality imparted to your project by the plugins consumed in your loom.configs. The options will be passed to the plugins.

Installation

yarn add @shopify/loom-cli --dev

Usage

yarn loom <command> <options>

Inline help can be found with yarn loom <command> --help. For instance to see help for the build command you can run yarn loom build--help.

Commands

CommandFunction
buildBuilds the apps, services, and packages in your workspace
devStarts a hot-reloading development server
testRuns tests
lintLints your code
type-checkType-checks your code

Options

build

OptionDescriptionType and Default
--source-mapsGenerate sourcemaps for the buildboolean, defaults to false
--envWhether to build for production (or prod) or developmentstring, defaults to production
--cacheRuns a build with cacheboolean, defaults to true

dev

OptionDescriptionType and Default
--source-mapsGenerate sourcemaps for the buildboolean, defaults to false
--reloadUse fast reloading (fast)string, defaults to none

test

OptionDescriptionType and Default
--watchRuns tests in watch modeboolean, defaults to true
--ciRuns tests in CI mode (can also be enabled by setting the environment variable CI=1)boolean, defaults to false
--coverageGenerate coverage databoolean defaults to false
--debugRun tests in debug mode (for instance, with plugin-jest this enables the runInBand option)boolean, defaults to false
--update-snapshotsEnable snapshots for failed testsboolean, defaults to false
--test-name-patternMatching string or globbing pattern to run specific testsstring, defaults to running nothing

lint

OptionDescriptionType and Default
--fixFix lint errorsboolean, defaults to false
--cacheCache linting results for performanceboolean, defaults to true
--allow-emptyAllow matchless globsboolean, defaults to false

type-check

OptionDescriptionType and Default
--watchType-check in watch modeboolean, defaults to false
--cacheCache type-check resultsboolean, defaults to true