@basketry/typescript-docs v0.1.1

Sorbet Docs

Basketry generator for documenting services that have a Typescript language target. This parser can be coupled with any Basketry parser. It is recommended to use this generator alongside the @basketry/typescript generator.

Quick Start

The following example converts a "Swagger" doc into Typescript types:

1. Save https://petstore.swagger.io/v2/swagger.json as petstore.json in the root of your project.
2. Install packages: npm install -g basketry @basketry/swagger-2 @basketry/typescript @basketry/typescript-docs
3. Generate code: basketry --source petstore.json --parser @basketry/swagger-2 --generators @basketry/typescript @basketry/typescript-docs --output src

When the last step is run, basketry will parse the source file (petstore.json) using the specified parser (@basketry/swagger-2) and then run each specified generator writing the output folder (src).

Folder Structure

TODO!!!!!!!!!!!!

Options

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. Create new version
   1. Navigate to the version workflow from the Actions tab.
   2. Manually dispatch the action with the appropriate inputs
   3. This will create a PR with the new version
2. Publish to NPM
   1. Review and merge the PR
   2. The publish workflow will create a git tag and publish the package on NPM

Generated with generator-ts-console