Skip to content

Latest commit

 

History

History
116 lines (82 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

116 lines (82 loc) · 4 KB
Raw

Contributing to spec2ts

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

First, ensure you have the latest npm.

To get started with the repo:

$ git clone [email protected]:touchifyapp/spec2ts.git && cd spec2ts 
$ npm ci

Code Structure

Currently, the source is a lerna monorepo containing the following components, located in the packages directory:

  • core: Helpers methods to generate TypeScript code.
  • jsonschema: Utility to generate types from JSON schemas. More details.
  • openapi: Utility to generate types from Open API v3 specifications. More details.
  • openapi-client: Utility to generate HTTP Client from Open API v3 specifications. More details.
  • cli: CLI wrapper to generate types from Open API v3 specifications and JSON schemas. More details.

Commands

Commands are handled by npm scripts, and can be executed:

  • from a package directory using npm run <cmd> (acts on one package)
  • from the root directory using npm run <cmd> (acts on all packages)
  • from the root directory using lerna run <cmd> (acts on each packages containing this cmd)

Build

$ npm run build 
# or using lerna, prefix with `npx` or install globally
$ lerna run build

Unit Tests

# Run all test suites 
$ npm run test 
# or using lerna, prefix with `npx` or install globally
$ lerna run test 

# Run a specific suite from a file (e.g. packages/openapi/tests/openapi-parser.spec.ts from root directory) 
$ npm run test packages/openapi/tests/openapi-parser.spec.ts 

# Use pattern matching 
$ npm run test openapi-parser 

# Skip cleanup and linting 
$ npm run test:jest 
# etc

Coverage

If you would like to check test coverage, run the coverage command then open coverage/lcov-report/index.html in your favorite browser.

# Generate coverage reports 
$ npm test:coverage 

# Open reports with OS X 
$ open coverage/lcov-report/index.html 

# Open reports with Linux 
$ xdg-open coverage/lcov-report/index.html

Lint

$ npm run lint

It's also a good idea to hook up your editor to an eslint plugin.

To fix lint errors from the command line:

$ npm run lint:fix

Local CLI Testing

Lerna handles dependencies between packages through symlinks so local packages are kept up to date regarding one another. To test out a development build of spec2ts or any other subcommand, simply execute the spec2ts cli using node.

Exemple for @spec2ts/openapi specifying output location with -o <output> option:

$ lerna run build
$ cd packages/cli
$ node ./bin/spec2ts.js openapi ../openapi/tests/assets/petstore.yml -o .

# without build using ts-node, prefix with npx or install globally
$ ts-node ./bin/spec2ts.ts openapi ../openapi/tests/assets/petstore.yml -o .

Issue

We use (GitHub Issues)[https://github.com/touchifyapp/spec2ts/issues] for bug reports and feature requests. Before filling a new issue, try to make sure your problem doesn't already exist. If not, use the provided templates to provide a clear description.

Pull Request

This project follows GitHub's standard forking model. Please fork the project to submit pull requests. Any new feature must be accompanied by:

  • a description expliciting the idea behing the feature
  • a documentation of the usage
  • valid tests covering the feature

License

By contributing to spec2ts, you agree that your contributions will be licensed under its MIT license.