Skip to content

Package Script Targets

Carsten Klein edited this page Dec 8, 2022 · 19 revisions

Package Script Targets

Root Package

changelog

Runs lerna-changelog.

build

Recursively runs the build target in all packages using lerna.

🔔 You should first run clean to remove stale data in the packages' dist folders.

Use

npm run build -- --scope=<package>

to build specific package[s] only.

clean

Recursively runs the clean target in all packages using lerna.

🔔 This prepares [all] packages for a clean build.

Use

npm run clean -- --scope=<package>

to clean specific package[s] only.

clean-all

Recursively runs the clean-all target in all packages using lerna.

Important: Do not scope this.

🔔 This prepares the working directory for a clean npm install.

🔔 You have to use this whenever you switch between branches unless these branches have the same dependencies.

🔔 Use this to get rid of fringe errors.

postclean-all

Deletes node_modules from the root package.

⚠️ Called automatically. Do not use it directly.

postinstall

Bootstraps lerna and all packages after that npm install was run.

⚠️ Called automatically. Do not use it directly.

prelerna-publish

Runs clean-all, install, and build before lerna-publish.

⚠️ Called automatically. Do not use it directly.

lerna-publish

Runs lerna-publish.

lint

Recursively runs the lint target in all packages using lerna.

Use

npm run lint -- --scope=<package>

to lint specific package[s] only.

lint-fix

Recursively runs the lint-fix target in all packages using lerna.

Use

npm run lint-fix -- --scope=<package>

to fix linter issues for specific package[s] only.

test

Recursively runs the test target in all packages using lerna.

Use

npm run test -- --scope=<package>

to test specific package[s] only.

@testdeck/core (packages/core)

build

Runs tsc. This will create the dist folder which contains all transpiled sources including tests and also the generated type definitions.

clean

Deletes the .nyc_output, coverage, and dist folders from the package.

clean-all

Runs clean and also deletes node_modules from the package.

⚠️ You must not use this target on the package directly, use clean-all from the root package instead.

🔔 lerna established links to other testdeck packages and other, commonly shared packages that will be lost when running this target directly.

lint

Runs eslint.

lint-fix

Runs eslint --fix.

pretest

Runs clean, lint, and build before test.

test

@testdeck/di-typedi (packages/di-typedi)

build

Runs tsc. This will create the dist folder which contains all transpiled sources including tests and also the generated type definitions.

clean

Deletes the .nyc_output, coverage, and dist folders from the package.

clean-all

Runs clean and also deletes node_modules from the package.

⚠️ You must not use this target on the package directly, use clean-all from the root package instead.

🔔 lerna established links to other testdeck packages and other, commonly shared packages that will be lost when running this target directly.

lint

Runs eslint.

lint-fix

Runs eslint --fix.

pretest

Runs clean, lint, and build before test.

test

@testdeck/jasmine (packages/jasmine)

build

Runs tsc. This will create the dist folder which contains all transpiled sources including tests and also the generated type definitions.

clean

Deletes the .nyc_output, coverage, and dist folders from the package.

clean-all

Runs clean and also deletes node_modules from the package.

⚠️ You must not use this target on the package directly, use clean-all from the root package instead.

🔔 lerna established links to other testdeck packages and other, commonly shared packages that will be lost when running this target directly.

lint

Runs eslint.

lint-fix

Runs eslint --fix.

pretest

Runs clean, lint, and build before test.

test

test:standard

test:focus

test:coverage

@testdeck/jest (packages/jest)

build

Runs tsc. This will create the dist folder which contains all transpiled sources including tests and also the generated type definitions.

clean

Deletes the .nyc_output, coverage, and dist folders from the package.

clean-all

Runs clean and also deletes node_modules from the package.

⚠️ You must not use this target on the package directly, use clean-all from the root package instead.

🔔 lerna established links to other testdeck packages and other, commonly shared packages that will be lost when running this target directly.

lint

Runs eslint.

lint-fix

Runs eslint --fix.

pretest

Runs clean, lint, and build before test.

test

@testdeck/mocha (packages/mocha)

build

Runs tsc. This will create the dist folder which contains all transpiled sources including tests and also the generated type definitions.

clean

Deletes the .nyc_output, coverage, and dist folders from the package.

clean-all

Runs clean and also deletes node_modules from the package.

⚠️ You must not use this target on the package directly, use clean-all from the root package instead.

🔔 lerna established links to other testdeck packages and other, commonly shared packages that will be lost when running this target directly.

lint

Runs eslint.

lint-fix

Runs eslint --fix.

pretest

Runs clean, lint, and build before test.

test

Runs test:standard, test:focus, and test:coverage.

test:standard

Runs nyc mocha for all tests in test/.

test:focus

Runs nyc mocha for all tests in test/focus without cleaning the coverage data.

test:coverage

Runs a nyc report coverage check.

@testdeck/vitest (packages/vitest)

build

Runs tsc. This will create the dist folder which contains all transpiled sources including tests and also the generated type definitions.

clean

Deletes the .nyc_output, coverage, and dist folders from the package.

clean-all

Runs clean and also deletes node_modules from the package.

⚠️ You must not use this target on the package directly, use clean-all from the root package instead.

🔔 lerna established links to other testdeck packages and other, commonly shared packages that will be lost when running this target directly.

lint

Runs eslint.

lint-fix

Runs eslint --fix.

pretest

Runs clean, lint, and build before test.

test

Runs vitest with coverage check.