0.3.4 • Published 4 months ago
@qodly/ds v0.3.4
Qodly Datasources
Getting started
git clone git@git-ps.wakanda.io:4d/web-studio/qodly-ds.git
on GitHub!cd qodly-ds
npm install
Features
Node.js, npm version
This project relies on volta to ensure node version to be consistent across developers. It's also used in the GitHub/Gitlab workflow file.
Typescript
Leverages swc for blazing fast builds, but keeps tsc
to generate .d.ts
files.
Commands:
build
: runs typechecking then generates CJS, ESM andd.ts
files in thebuild/
directoryclean
: removes thebuild/
directorytype:dts
: only generatesd.ts
type:check
: only run typechecking
Tests
The project uses vitest. The coverage is done through vitest, using c8.
Commands:
test
: runs vitest test runnertest:watch
: runs vitest test runner in watch modetest:coverage
: runs vitest test runner and generates coverage reports
Format & lint
This project relies on the combination of eslint — through typescript-eslint for linting and prettier for formatting.
Commands:
format
: runs prettier with automatic fixingformat:check
: runs prettier without automatic fixing (used in CI)lint
: runs eslint with automatic fixinglint:check
: runs eslint without automatic fixing (used in CI)