docs: Add example of validating CLI options

jestjs · SimenB · Sep 11, 2023 · Sep 7, 2023 · Sep 7, 2023 · Sep 10, 2023
commit 521931948fc759d02d84684bd8dfbb74891f0dfc
diff --git a/packages/jest-validate/README.md b/packages/jest-validate/README.md
@@ -194,3 +194,26 @@ Custom Deprecation:
 
   Documentation: http://custom-docs.com
 ```
+
+## Example validating CLI arguments
+
+```js
+import {validate} from 'jest-validate';
+
+validateCLIOptions(
+    argv,
+    { ...allowedOptions, deprecatedOptions },
+);
+```
+
+If `argv` contains a deprecated option that is not specifid in `allowedOptions`, `validateCLIOptions` will throw an error with the message specified in the `deprecatedOptions` config:
+
+```bash
+● collectCoverageOnlyFrom:
+
+  Option "collectCoverageOnlyFrom" was replaced by "collectCoverageFrom"
+
+  CLI Options Documentation: https://jestjs.io/docs/en/cli.html
+```
+
+If the deprecation option is still listed in the `allowedOptions` config, then `validateCLIOptions` will print the warning wihout throwing an error.