@@ -29,7 +29,7 @@ npx cspell-lockfile-dicts
2929
3030This will:
3131
32- 1 . Scan your project for lockfiles (package-lock.json, yarn.lock, etc.)
32+ 1 . Scan your project for lockfiles (` package-lock.json ` , ` yarn.lock ` , ` Gemfile.lock ` , ` composer.lock ` , ` Cargo.lock ` , etc.)
33332 . Extract package names from those lockfiles
34343 . Generate a ` .cspell/lockfile-words.txt ` file in your project root
3535
@@ -60,11 +60,11 @@ The tool supports the following command-line options:
6060
6161```
6262Options:
63- -d, --debug Enable debug logging
6463 -p, --path <path> Path to save the dictionary file (default: ".cspell/lockfile-words.txt")
6564 -l, --lockfiles <files...> Specific lockfiles to process (comma-separated)
6665 --no-auto-detect Disable auto-detection of lockfiles in the project
6766 -a, --auto-detect-patterns <patterns...> Glob patterns for auto-detecting lockfiles (comma-separated)
67+ -d, --debug Enable debug logging
6868 -h, --help Display help for command
6969```
7070
@@ -90,11 +90,26 @@ npx cspell-lockfile-dicts --lockfiles package-lock.json yarn.lock
9090
9191## Supported Lockfiles
9292
93- - ` package-lock.json ` (npm)
94- - ` yarn.lock ` (Yarn)
95- - ` Gemfile.lock ` (Ruby/Bundler)
96- - ` composer.lock ` (PHP/Composer)
97- - ` Cargo.lock ` (Rust/Cargo)
93+ | Lockfile | Language/Package Manager | Status |
94+ | -------------------- | --------------------------- | ------------ |
95+ | ` package-lock.json ` | JavaScript/npm | ✅ Supported |
96+ | ` yarn.lock ` | JavaScript/Yarn | ✅ Supported |
97+ | ` Gemfile.lock ` | Ruby/Bundler | ✅ Supported |
98+ | ` composer.lock ` | PHP/Composer | ✅ Supported |
99+ | ` Cargo.lock ` | Rust/Cargo | ✅ Supported |
100+ | ` poetry.lock ` | Python/Poetry | ✅ Supported |
101+ | ` Pipfile.lock ` | Python/Pipenv | ✅ Supported |
102+ | ` go.sum ` | Go | ✅ Supported |
103+ | ` go.mod ` | Go | ✅ Supported |
104+ | ` *.gradle.lockfile ` | Java/Gradle | 🔄 Pending |
105+ | ` build.sbt.lock ` | Scala/SBT | 🔄 Pending |
106+ | ` pom.xml.lock ` | Java/Maven | 🔄 Pending |
107+ | ` packages.lock.json ` | .NET/NuGet | 🔄 Pending |
108+ | ` Podfile.lock ` | Swift/CocoaPods | 🔄 Pending |
109+ | ` cocoapods.lock ` | Swift/CocoaPods | 🔄 Pending |
110+ | ` mix.lock ` | Elixir | 🔄 Pending |
111+ | ` Cartfile.resolved ` | Swift/Carthage | 🔄 Pending |
112+ | ` Package.resolved ` | Swift/Swift Package Manager | 🔄 Pending |
98113
99114## Adding to CI/CD
100115
0 commit comments