a-minimal-ts
v1.3.5
Published
A test Typescript libary that has minimal functionality
Downloads
31
Maintainers
Readme
a-minimal-ts
A demo package with minimal Typescript functionality. This package can be used as a skeleton or template for quickly building new TypeScript packages, without wasting time on setup of boilerplate configurations and supporting tools.
Provides the following functionality:
- Module style (import/export)
- API
multiply
- multiplies two numberswrapInArray
- generic function
- Typescript
- Code Quality
- Check code formatting with
prettier
eslint
coding style validationjsdoc
andtsdoc
rules enforcement
- Check code formatting with
jest
unit testshusky
git hooks - ensure that git commits are of high qualitycommitlint
- ensure that commit subjects comply with conventional commits specificationspnpm
package manager- NodeJS Continuos Integration Github workflows
- Prettier and lint
- Unit Tests
- Auto Version bump
Prerequisites
NodeJS
Install NodeJS 16 or above, either directly or with nvm
Getting started
Usage
npm
npm i a-minimal-ts
yarn
yarn add a-minimal-ts
pnpm
pnpm add a-minimal-ts
Local development
PNPM installation
Install the pnpm
NodeJS package manager
npm install pnpm -g
Install
Run the command:
pnpm install
Tests
Running jest
unit tests
Run the command:
pnpm test
Versioning and Release
Done by github workflow actions