Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 3.52 KB

README.md

File metadata and controls

29 lines (19 loc) · 3.52 KB
Raw

Actions Status GitHub Maintainability Test Coverage

@shootismoke/common

Useful packages for manipulating air quality data. Shared between Sh**t! I Smoke projects.

Packages

Packages NPM Description
@shootismoke/convert npm (scoped) Easily convert between AQIs (US, CN...) and raw concentration values (ug/m3, ppm)
@shootismoke/dataproviders npm (scoped) A library to fetch air quality data from various providers (AqiCN, OpenAQ...) and normalizing data into one common format: the openaq-data-format.

The below packages are used internally in Sh**t! I Smoke projects, but if you're interested, feel free to use them.

Packages NPM Description
@shootismoke/ui npm (scoped) (Internal) UI components shared across Web & React Native projects.

FAQ

Why is there a tsconfig.json and a tsconfig.settings.json?

Inside each package in the packages/ folder, there is a tsconfig.settings.json. This is the canonical config file for each package, used by tsc, because we use -p tsconfig.settings.json. If you inspect it, it extends <rootDir>/tsconfig.settings.json. So <rootDir>/tsconfig.settings.json serves as a base template.

The various tsconfig.json are not used while building packages, they are only there for VSCode, so that jumping between packages is done smoothly, because we defined TypeScript paths.