Skip to content

Commit c84ac6c

Browse files
docs: updating readme and package.json to work with lerna (aws-powertools#11)
Co-authored-by: Alan Churley <[email protected]>
1 parent 8abcf3f commit c84ac6c

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33
## Testing
44
The repo uses JEST tests, these can be run using
55

6-
`npm run test`
6+
`npm run lerna-test`
77

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

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

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

1616
### Formating
1717

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

21-
`npm run format`
21+
`npm run lerna-format`
2222

2323
## Security
2424

npm-shrinkwrap.json

+13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
"lerna-ci": "lerna exec -- npm ci",
1010
"lerna-test": "lerna exec -- npm run test",
1111
"lerna-build": "lerna exec -- tsc",
12-
"lerna-lint": "lerna exec -- eslint \"./{src,tests}/**/*.ts\"",
13-
"lerna-format": "lerna exec -- eslint --fix \"./{src,tests}/**/*.ts\"",
12+
"lerna-lint": "lerna exec -- eslint \"./{src,tests}/**/*.ts ./src/*.ts\"",
13+
"lerna-format": "lerna exec -- eslint --fix \"./{src,tests}/**/*.ts ./src/*.ts\"",
1414
"lerna-prepare": "lerna exec -- npm run build",
1515
"lerna-prepublishOnly": "lerna exec -- npm test && lerna exec -- npm run lint",
1616
"lerna-preversion": "lerna exec -- npm run lint",
@@ -36,6 +36,7 @@
3636
"@commitlint/config-conventional": "^11.0.0",
3737
"@types/aws-lambda": "^8.10.72",
3838
"@types/jest": "^26.0.19",
39+
"@types/lodash": "^4.14.168",
3940
"@types/node": "^14.14.16",
4041
"@typescript-eslint/eslint-plugin": "^4.11.1",
4142
"@typescript-eslint/parser": "^4.11.1",

0 commit comments

Comments
 (0)