Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 2 additions & 13 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
/_old
.vscode
.idea
.DS_Store
node_modules
*.orig
dist
/sample
/coverage
.coveralls.yml
.nyc_output
secrets.zip
jest
junk
/a_reference
/sample2
README.md.sav
dist
3 changes: 2 additions & 1 deletion .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
tasks:
- init: npm install
- init: npm install && npm install lerna -g
command: lerna bootstrap && lerna run compile
11 changes: 6 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ before_install:
-in secrets.zip.enc -out secrets.zip -d; fi'
- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then unzip secrets.zip; fi'
install:
- npm install
- npm install lerna -g
- lerna bootstrap
script:
- npm run compile
- npm run test:coverage
- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run coveralls; fi'
- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run codacy; fi'
- lerna run compile
- lerna run test:coverage
- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then lerna run coveralls; fi'
- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then lerna run codacy; fi'
env:
global:
- secure: x+Nxbq8RrOVJyQ7JWNRpXdBmp61rXPKulYPxUwGeIe/ZJwX1QHsy2HAAB2m7aRvAMBAqr2urBaIKgPBmBklyY0elRTD/chUdT5cJiPhMIxBghqkQ1NYqx/WzcCBUrZbRzoQcpAES7sJnUs0PMujKv3wMsujoFJ9b9Z+trHMqD0IztBlg45azAh4A6ApVcDB8j4L+g42kps6d4r5jUt2d4uW537PKXpsnWJMaaj2Pw7pxU2H5kBaeNGnvlK+w9k3porToop7OUG+HBTN2BjofdF1PSHm8fizzFL6/h2x39cLYMxFvHb7oVUKBiWQe8PBXD5+k/X0RgPJMZO9AggMHln5MIihTowGvuSLK/3d95ta/qXTmzG0Csv4J8xWD+koCJm0xpSzsrBSUOPt5ZKN71o0VmLmc7U4Z0aEplZyVcMdTbwA1XeoeXD4UU1fD7BlzYl4oOTB8HlucJILwAZFg0upPB33lQchAUIgoUCDxze3OoG3V1Odcw4u64bXlPrdqgCg8AQZgnrYP+EzKczjGd7pBQZRVxKyq+44JV8JOUAXEka3qQRPvmw5wcAaXgsqU7uv1C6FcQb+j/ZKQ6GlWu8qDzouRR+OqbKeLk2lOvtU08Y32tn6u14+vVNbmsG3iXxGf2+esGcETFP/0EYluPGpo257h/9qC1yMN8ZExey0=
Expand Down
38 changes: 32 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Contributors are welcome!

See something that needs fixing? Got an idea for a new feature? Contribute a [Pull Request](#Create-a-Pull-Request)!

## Background

This project is set up as a mono-repo. We use `lerna` to manage dependencies. Thus, after the initial `npm install` (to get lerna), you will use `lerna bootstrap` in place of `npm install`. This will ensure all local package / dependies are compiled/transpiled.

## Easy path to contribution
Click the Gitpod badge to setup a ready to code dev env in the cloud.

Expand All @@ -23,19 +27,41 @@ Click the Gitpod badge to setup a ready to code dev env in the cloud.
2. Install the dependencies

```shell
# From the project directory, run
npm i
# install lerna and common deps
npm install

# run lerna bootstrap to install module dependencies
# note: use lerna bootstrap, rather than npm install
lerna bootstrap
```

3. Navigate to the package dir you'd like to modify

**Packages:**
- [framework](/packages/framework) - core schema load and preprocess logic
- [express-openapi-validator](/packages/express-openapi-validator) - the express middleware

```shell
# for example, navigate the express validator package
cd packages/express-openapi-validator
```

Be [Create a Pull Request](#create-a-pull-request) once you've written you code.
4. Be [Create a Pull Request](#create-a-pull-request) once you've written you code.

## Run the tests

3. Run the tests

```shell
npm test
```
Run tests for all packages
```shell
lerna run test
```

Run tests in the current package:
```shell
npm run test
```


## Develop

Expand Down
5 changes: 5 additions & 0 deletions lerna.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"packages": ["packages/*"],
"version": "4.10.8"
}

Loading