Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 1.56 KB

README.md

File metadata and controls

44 lines (26 loc) · 1.56 KB

main master

Typescript HTTP Client

Basketry generator for generating HTTP API clients. This parser can be coupled with any Basketry parser.

Quick Start

TODO

For contributors:

Run this project

  1. Install packages: npm ci
  2. Build the code: npm run build
  3. Run it! npm start

Note that the lint script is run prior to build. Auto-fixable linting or formatting errors may be fixed by running npm run fix.

Create and run tests

  1. Add tests by creating files with the .test.ts suffix
  2. Run the tests: npm t
  3. Test coverage can be viewed at /coverage/lcov-report/index.html

Publish a new package version

  1. Ensure latest code is published on the main branch.
  2. Create the new version number with npm version {major|minor|patch}
  3. Push the branch and the version tag: git push origin main --follow-tags

The publish workflow will build and pack the new version then push the package to NPM. Note that publishing requires write access to the main branch.

Generated with generator-ts-console