Full reference

build

• Project: kitten-scientists

• Source:

  yarn run build:all
  

• Description:

  documentation pending

build:all

• Project: kitten-scientists

• Source:

  tsc --build
  

• Description:

  Builds all TypeScript workspaces.

clean

• Project: kitten-scientists

• Source:

  yarn run clean:all
  

• Description:

  documentation pending

clean:all

• Project: kitten-scientists

• Source:

  rm -rf packages/*/build packages/*/tsconfig.tsbuildinfo
  

• Description:

  Cleans all TypeScript build output from all workspaces.

devcontainer:build

• Project: @kitten-science/kittensgame

• Source:

  bash ./scripts/build-development-container.sh
  

• Description:

  Builds the Development Container.

devcontainer:rebuild

• Project: @kitten-science/kittensgame

• Source:

  bash ./scripts/rebuild-development-container.sh
  

• Description:

  Rebuilds the Development Container.

  You're going to want to rebuild your development container every once in a while to ensure you're using the latest version of Kittens Game in your container.

devcontainer:run

• Project: @kitten-science/kittensgame

• Source:

  bash ./scripts/run-development-container.sh
  

• Description:

  Builds the Development Container and starts it.

docs:build

• Project: @kitten-science/documentation

• Source:

  .scripts/build.sh
  

• Description:

  Build the documentation.

docs:nsd

• Project: @kitten-science/documentation

• Source:

  nsd --cwd=$INIT_CWD --docs-location="packages/documentation/docs/reference/Repository Scripts/"
  

• Description:

  Update the scripts reference that you are looking at right now.

docs:serve

• Project: @kitten-science/documentation

• Source:

  .scripts/serve.sh
  

• Description:

  Start the mkdocs-material development server to work on the documentation.

kitten-scientists:build

• Project: @kitten-science/kitten-scientists

• Source:

  vite --config vite.config.inject.js build
  

• Description:

  Build the Kitten Scientists userscript.

  This builds the version of the script that is also used in the development container.

kitten-scientists:preview

• Project: @kitten-science/kitten-scientists

• Source:

  DEV_BUILD=true vite --config vite.config.userscript.js build
  

• Description:

  Build a development release version of the userscript.

kitten-scientists:release

• Project: @kitten-science/kitten-scientists

• Source:

  MINIFY=true vite --config vite.config.userscript.js build
  vite --config vite.config.userscript.js build
  

• Description:

  Build a release version of the Kitten Scientists userscript.

  This is usually only used from CI to build both the regular version of the script, as well as a minified build. When you use this locally, it still builds both files, but clears the output directory between builds. So you end up with only the regular version.

kitten-scientists:version

• Project: @kitten-science/kitten-scientists

• Source:

  node version.cjs
  

• Description:

  Returns the version for the Kitten Scientists userscript.

kitten-scientists:watch

• Project: @kitten-science/kitten-scientists

• Source:

  vite --config vite.config.inject.js build --watch
  

• Description:

  Builds the Kitten Scientists userscript and watches all files for changes. If changes are detected, the script is rebuilt.

  Warning

  This watcher has caused problems in the past, generating broken output. Use at your own risk.

lint

• Project: kitten-scientists

• Source:

  yarn run lint:all
  

• Description:

  documentation pending

lint:all

• Project: kitten-scientists

• Source:

  yarn run lint:eslint && yarn run lint:prettier
  

• Description:

  Check source code for style issues.

lint:eslint

• Project: kitten-scientists

• Source:

  eslint . --ext .ts
  

• Description:

  documentation pending

lint:prettier

• Project: kitten-scientists

• Source:

  prettier --check packages
  

• Description:

  documentation pending

snapshot-analyzer:build

• Project: @kitten-science/snapshot-analyzer

• Source:

  vite build
  

• Description:

  documentation pending

snapshot-analyzer:serve

• Project: @kitten-science/snapshot-analyzer

• Source:

  vite serve
  

• Description:

  documentation pending

test

• Project: kitten-scientists

• Source:

  yarn run test:all
  

• Description:

  documentation pending

test:all

• Project: kitten-scientists

• Source:

  yarn workspaces foreach --all --exclude kitten-scientists --parallel --verbose run test
  

• Description:

  Runs unit tests in all workspaces.

test:coverage

• Project: @kitten-science/action-release-info

• Source:

  c8 --reporter html-spa --reporter text node --enable-source-maps $(yarn bin mocha) ./build/*.test.js
  

• Description:

  Runs unit tests in all workspaces and collects code coverage information.

test:coverage:all

• Project: kitten-scientists

• Source:

  yarn workspaces foreach --all --exclude kitten-scientists --parallel --verbose run test:coverage
  

• Description:

  Runs the test:coverage script in all workspaces.

test:inspect

• Project: @kitten-science/action-release-info

• Source:

  node $(yarn bin mocha) --inspect ./build/*.test.js
  

• Description:

  Runs unit tests and lets you attach a debugger.

typecheck:all

• Project: kitten-scientists

• Source:

  tsc --noEmit --incremental false
  

• Description:

  Run the TypeScript compiler to find problems with the code.