Skip to content

Commit

Permalink
doc: local development and tests info
Browse files Browse the repository at this point in the history
  • Loading branch information
iwong-isp committed Jun 26, 2023
1 parent e7c129d commit 1bb8b86
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,24 @@ It's also possible to set it to `warn` or `info`.

The `extends` field is automatically added (or appended to) by the linter script to inject the iSP ruleset into your config.

### Local Development

1. Install `node 13.14.0` locally.
2. Run `npm run build` to compile the `isp-functions`.
3. Run `node ./entrypoint.js <PATH_TO_OPENAPI_SPEC>` to run the linter.

The `build` command may need to be re-run to pick up changes made to some of the `isp-functions`.

#### Tests

```sh
# Compile the isp-functions
npm run build
# Run test
npm run test
```

## License

Copyright © 2020 iStreamPlanet Co., LLC
Expand Down

0 comments on commit 1bb8b86

Please sign in to comment.