ethanlook / viam-js-config

Common configuration for JS/TS tooling

Viam Shared JS/TS Config

Shared configuration for JavaScript and TypeScript tools:

Tool	NPM Module	Version
ESLint	@viamrobotics/eslint-config
Prettier	@viamrobotics/prettier-config
TypeScript	@viamrobotics/typescript-config

Contributing

Node.js v18 or higher is required to develop on this repository. To get started, clone the repository and install the project's development dependencies. .

git clone https://github.com/viamrobotics/js-config.git
cd js-config
corepack enable
pnpm install

Once your development dependencies are installed, you can verify that all checks and tests are passing:

# run all checks and builds
pnpm all

# check lints
pnpm check-lint

# check types
pnpm check-types

# check formatting
pnpm check-format

# build all packages
pnpm build

# auto-format (modifies files)
pnpm format

Releasing

Modules in this repository are continuously deployed to npm from the main branch. To trigger a release, create a commit that bumps version in one or more package.json files and create a pull request to merge that commit into main.