@qodly/ds

Qodly Datasources

Getting started

1. git clone [e-mail]:4d/web-studio/qodly-ds.giton GitHub!
2. cd qodly-ds
3. 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 and d.ts files in the build/ directory
• clean: removes the build/ directory
• type:dts: only generates d.ts
• type:check: only run typechecking

Tests

The project uses vitest. The coverage is done through vitest, using c8.

Commands:

• test: runs vitest test runner
• test:watch: runs vitest test runner in watch mode
• test: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 fixing
• format:check: runs prettier without automatic fixing (used in CI)
• lint: runs eslint with automatic fixing
• lint:check: runs eslint without automatic fixing (used in CI)