Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 970 Bytes

CONTRIBUTING.mdx

File metadata and controls

47 lines (32 loc) · 970 Bytes
Raw

Local Development

This project builds with node version:

{/* CODEBLOCK_START {"value": ".nvmrc", "hideValue": true} /} {/ prettier-ignore */}

v20.10.0

{/* CODEBLOCK_END */}

After cloning the repository, install dependencies and build the project:

npm ci

Build the library and watch for changes:

npm start

Link your local copy:

npm link

markdown-inject commands in any terminal will now run using your local copy.

Validation

This app ships with a local suite of jest tests, eslint + prettier configurations for code consistency and formatting, and TypeScript type validation. Each of these features can be validated using...

npm test
npm run lint
npm run build

A validate utility script chains these calls together, and is called on every commit.

npm run validate