Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 2.03 KB

DEVELOPMENT.md

File metadata and controls

65 lines (47 loc) · 2.03 KB

Development

Building

Open the root directory of the repo and run:

# install dependencies
yarn install
# build
yarn build

Packages

Standard Commands

# build (run in root dir)
yarn build
# run tests (run in root dir)
yarn test
# format the code (download dprint from dprint.dev)
dprint fmt

Clean Rebuild

yarn clean && yarn build

Declaration File

Global Definitions

The global definitions are stored in lib/global.d.ts. To make changes:

  1. Add a failing test in lib/global.tests.ts (failing test means you get a compile error)
  2. Update lib/global.d.ts.
  3. Run yarn create-declaration-file in the root directory

ts-nameof - Updating API

  1. Update packages/ts-nameof/lib/declarationFileTests.ts with a failing test.
  2. Update the API in packages/ts-nameof/src/main.ts.
  3. Run yarn create-declaration-file in the root directory

After Development

Run the following command in the root directory, which will check that everything is good:

yarn verify