Skip to content

Commit 6db1c44

Browse files
committed
docs: remove title cases for sections
1 parent cbbf7ac commit 6db1c44

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@
1313

1414
NodeJS module mocking for CJS (CommonJS) modules for unit testing purposes. Similar to [proxyquire](https://www.npmjs.com/package/proxyquire), but simpler and safer. Sponsored by [Aeroview](https://aeroview.io).
1515

16-
**😃 Easy to Use**
16+
**😃 Easy to use**
1717
- Super simple & straightforward documentation
1818
- Powerful debugging utility
1919
- Built in Typescript support
2020

21-
**🛡 Defensive & Immutable Mocking**
21+
**🛡 Defensive & immutable mocking**
2222
- Throws an error if any mocks are unused by module we are mocking
2323
- Module Cache for mocked modules are always deleted before and after, to minimize side effects and make behavior more predictable and approximate immutability
2424

25-
**💪 Robust & Reliable**
25+
**💪 Robust & reliable**
2626
- Tiny codebase written in Typescript with only 1 tiny dependency
2727

2828
## Example
@@ -94,7 +94,7 @@ However, this can also be a source of confusion.
9494

9595
To aid in debugging, you can set the environment variable `CJS_MOCK_DEBUG=1` to see the order of module resolution and mocking.
9696

97-
## Partial Mocking
97+
## Partial mocking
9898

9999
You can nest `mock()` for partial mocking of nested dependencies:
100100

@@ -106,7 +106,7 @@ const m = mock('./foo', {
106106
});
107107
```
108108

109-
## Do Not Use in Production Environment
109+
## DO NOT USE IN PRODUCTION
110110

111111
Just like for `proxyquire` and other mocking utilities, use of this utility is not recommended in production environments, for the following reasons:
112112

@@ -130,12 +130,12 @@ This can be useful for debugging, to see if a mock is being used or not, and to
130130

131131
Be warned, this may produce a *metric ton* of output. It's sometimes shocking just how many modules are required in a node project, including built-in modules. You may want to limit the output to just the relevant test by only running that test.
132132

133-
# Support, Feedback, and Contributions
133+
# Support, feedback, and contributions
134134

135135
- Star this repo if you like it!
136136
- Submit an [issue](https://github.com/mhweiner/autorel/issues) with your problem, feature request or bug report
137137
- Issue a PR against `main` and request review. Make sure all tests pass and coverage is good.
138-
- Write about `autorel` in your blog, tweet about it, or share it with your friends!
138+
- Write about this project in your blog, tweet about it, or share it with your friends!
139139

140140
# Sponsorship
141141

@@ -150,6 +150,13 @@ Want to sponsor this project? [Reach out to me via email](mailto:mhweiner234@gma
150150

151151
Aeroview is a lightning-fast, developer-friendly, and AI-powered logging IDE. Get started for free at [https://aeroview.io](https://aeroview.io).
152152

153+
# Other useful libraries
154+
155+
- [autorel](https://github.com/mhweiner/autorel): Automatic versioning, deployment, and release notes generation
156+
- [hoare](https://github.com/mhweiner/hoare): A simple, powerful, and flexible testing library for Typescript
157+
- [jsout](https://github.com/mhweiner/jsout): A simple, powerful, and flexible logging library for Javascript
158+
- [lambdaconf](https://github.com/mhweiner/lambdaconf): A simple, powerful, and flexible configuration library for Typescript that supports AWS Secrets Manager and dynamic configuration loading
159+
153160
# License
154161

155162
[MIT](LICENSE)

0 commit comments

Comments
 (0)