0.3.0 • Published 3 years ago
@neoncitylights/ts-standard v0.3.0
@neoncitylights/ts-standard
An experimental library for introducing useful, high-level APIs for TypeScript. It has a focus on functional programming, but also uses object-oriented programming throughout. It currently provides a focus on useful utility methods, as well as covering various areas of mathematics.
Install
Note: This library is currently very experimental and susceptible to change. The API should not be considered stable at this point.
npm i @neoncitylights/ts-standardFor developers
Setup
git clone https://github.com/neoncitylights/ts-standard.git
cd ts-standard
npm run install
npm run buildScripts
| Action | CLI |
|---|---|
| Compile TypeScript files | npm run build:ts |
| Generate TypeDoc documentation | npm run build:typedoc |
| Build everything | npm run build:all |
| Clean out build directories | npm run clean |
| Run unit tests | npm run test |
| Run ESLint | npm run lint |
| Run ESLint fixer | npm run lint:fix |
| Run tests and linter (without fixing) | npm run test:all |
Tooling
- ESLint (website, npm): Used for linting TS code and ensuring code style stays consistent throughout the project
- Jest (website, npm): Used for running unit tests and integration tests
- TypeDoc (website, npm): Used for generating code documentation based on the TSDoc standard proposal
- Codecov: Used to upload Jest's code coverage reports to a transparent, publicly viewable website