docs: update README with new CLI flag for package name aliases (#178)

* docs: update README with new CLI flag for package name aliases * chore: add changelog entry
lirantal · Aug 1, 2023 · acf87b8 · acf87b8
1 parent 47fc5aa
commit acf87b8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.changeset/selfish-moons-destroy.md b/.changeset/selfish-moons-destroy.md
@@ -0,0 +1,6 @@
+---
+'lockfile-lint': minor
+'lockfile-lint-api': minor
+---
+
+New CLI flag to add package name and aliases as trusted policy
diff --git a/packages/lockfile-lint/README.md b/packages/lockfile-lint/README.md
@@ -87,8 +87,8 @@ lockfile-lint --path yarn.lock --allowed-hosts yarn --allowed-urls https://githu
 | `--allowed-urls`, `-u`           | allowed URLs (e.g. `https://github.com/some-org/some-repo#some-hash`)                                                                                                                                                                                                                 | ✅             |
 | `--empty-hostname`, `-e`         | allow empty hostnames, or set to false if you wish for a stricter policy                                                                                                                                                                                                              | ✅             |
 | `--validate-package-names`, `-n` | validates that the resolved URL matches the package name                                                                                                                                                                                                                              | ✅             |
-| `--validate-checksum`, `-c`      | check that all resources include a checksum                                                                                                                                                                                                                                           | ❌ PRs welcome |
 | `--validate-integrity`, `-i`     | validates the integrity field is a sha512 hash                                                                                                                                                                                                                                        | ✅             |
+| `--allowed-package-name-aliases`, `-l`     | allow package name aliases to be used by specifying package name and their alias as pairs (e.g: `string-width-cjs:string-width`)                                                                                                                                                                                                                                        | ✅             |
 
 # File-Based Configuration