Skip to content

docs: updating readme and package.json to work with lerna #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 24, 2021
Merged

docs: updating readme and package.json to work with lerna #11

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7b3bf9
docs: updating readme and package.json to work with lerna
churleya Mar 16, 2021
ea6e593
Merge branch 'main' into docs/readmeupdates
churleya Mar 24, 2021
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
## Testing
The repo uses JEST tests, these can be run using

`npm run test`
`npm run lerna-test`

Which will also generate coverage reports, and fail if the coverage is below the threshold.

## Code Styling and Linting
### Linting
Linting standards adhear to [tslint:recommended](https://github.com/palantir/tslint/blob/master/src/configs/recommended.ts).

Please ensure you run `npm run lint` before comiting to check for styling errors
Please ensure you run `npm run lerna-lint` before comiting to check for styling errors

### Formating

The repo is setup using [Prettier](https://prettier.io/). This will automatically make syntactic changes to files to
align them with the style guides. Please run this before creating a PR, and commit the changes.

`npm run format`
`npm run lerna-format`

## Security

Expand Down
59 changes: 14 additions & 45 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
"lerna-ci": "lerna exec -- npm ci",
"lerna-test": "lerna exec -- jest --coverage --detectOpenHandles",
"lerna-build": "lerna exec -- tsc",
"lerna-lint": "lerna exec -- eslint \"./{src,tests}/**/*.ts\"",
"lerna-format": "lerna exec -- eslint --fix \"./{src,tests}/**/*.ts\"",
"lerna-lint": "lerna exec -- eslint \"./{src,tests}/**/*.ts ./src/*.ts\"",
"lerna-format": "lerna exec -- eslint --fix \"./{src,tests}/**/*.ts ./src/*.ts\"",
"lerna-prepare": "lerna exec -- npm run build",
"lerna-prepublishOnly": "lerna exec -- npm test && lerna exec -- npm run lint",
"lerna-preversion": "lerna exec -- npm run lint",
Expand All @@ -36,6 +36,7 @@
"@commitlint/config-conventional": "^11.0.0",
"@types/aws-lambda": "^8.10.72",
"@types/jest": "^26.0.19",
"@types/lodash": "^4.14.168",
"@types/node": "^14.14.16",
"@typescript-eslint/eslint-plugin": "^4.11.1",
"@typescript-eslint/parser": "^4.11.1",
Expand Down