0.1.12 • Published 3 years ago
grams-common v0.1.12
Grams Common
A collection of common features used across grams applications.
Installation
npm install grams-commonUsage
import { someFunction } from 'grams-common';
// use someFunctionDocumentation
Refer to github pages for more details
Development
Building
To build the package, run:
npm run buildThis will compile the TypeScript source code to JavaScript and place it in the dist directory.
Testing
To run the tests, run:
npm testRelease
The below commands will:
- build
- test
- lint
- format
- push a new commit and tag for the version.
- publish to NPM
To release a major version to NPM run:
npm run release:majorTo release a minor version to NPM run:
npm run release:minorTo release a patch version to NPM run:
npm run release:patchFormatting
To format the code, run:
npm run formatThis will use Prettier to format all TypeScript files in the src directory.
Linting
To lint the code, run:
npm run lintThis will use TSLint to check the code for any style or syntax errors.
License
This project is licensed under the Apache-2.0 License. See the LICENSE file for details.