@continuous-excellence/digger
Advanced tools
@continuous-excellence/digger - npm Package Compare versions
@@ -75,3 +75,3 @@ (function (_, kotlin_kotlin, kotlin_com_zegreatrob_tools_digger_core, kotlin_com_zegreatrob_tools_git_adapter, kotlin_clikt_clikt_mordant, kotlin_clikt_clikt, kotlin_com_zegreatrob_tools_cli_tools, kotlin_com_zegreatrob_tools_digger_json, kotlin_org_jetbrains_kotlinx_kotlinx_serialization_json, kotlin_clikt_clikt_mordant_markdown, kotlin_com_zegreatrob_tools_digger_guide, kotlin_org_jetbrains_kotlinx_kotlinx_serialization_core) { | ||
| function Versions() { | ||
| this.k39_1 = '3.1.3'; | ||
| this.k39_1 = '3.1.4'; | ||
| } | ||
@@ -78,0 +78,0 @@ var Versions_instance; |
| Digger Fit Assessment and Workflow Guide | ||
| Use Digger when: | ||
| - You need contribution metadata generated directly from Git history. | ||
@@ -10,2 +11,3 @@ - You want build scripts to consume consistent semver and story-id signals. | ||
| Do not use Digger when: | ||
| - Your repository does not use Git tags to mark version boundaries. | ||
@@ -16,2 +18,3 @@ - You have no downstream plan for consuming the extracted contribution data. | ||
| Prerequisites: | ||
| - Git tags must mark version boundaries consistently. | ||
@@ -22,5 +25,7 @@ - Full git history required for all-contribution-data; at least back to last tag for current-contribution-data. | ||
| Optional (for metadata extraction): | ||
| - Commit message conventions enable extraction of story ID, semver, and ease metadata. | ||
| First-run workflow: | ||
| 1. Ensure your repository uses tags to mark releases. | ||
@@ -33,2 +38,3 @@ 2. Run `digger current-contribution-data <repo-path>` to extract data for the current contribution window. | ||
| Best practices: | ||
| - Keep commit metadata consistent so output stays reliable. | ||
@@ -40,7 +46,9 @@ - Use --format=json for automation, and text mode when writing artifact files. | ||
| When customizing extraction patterns, regex overrides MUST include required named groups: | ||
| - storyIdRegex must contain (?<storyId>...) named capture group | ||
| - easeRegex must contain (?<ease>...) named capture group | ||
| Failure to include these groups will cause runtime errors. | ||
| Failure to include these groups will cause runtime errors. | ||
| Workflow philosophy: | ||
| - Git history is the source of truth for extracted contribution signals. | ||
@@ -47,0 +55,0 @@ - Commit content provides semver, story, and ease classification. |
+1
-1
| { | ||
| "name": "@continuous-excellence/digger", | ||
| "version": "3.1.3", | ||
| "version": "3.1.4", | ||
| "main": "kotlin/command-line-tools-digger-cli.js", | ||
@@ -5,0 +5,0 @@ "devDependencies": { |
+7
-5
@@ -58,2 +58,3 @@ # Digger CLI | ||
| **Distribution contents:** | ||
| - `bin/digger` - Unix/Linux/macOS executable script | ||
@@ -113,3 +114,3 @@ - `bin/digger.bat` - Windows executable script | ||
| It will include all fields | ||
| listed [here](../digger-json/src/commonMain/kotlin/com/zegreatrob/tools/digger/json/ContributionDataJson.kt). | ||
| listed [here](../../tools/digger-json/src/commonMain/kotlin/com/zegreatrob/tools/digger/json/ContributionDataJson.kt). | ||
@@ -129,3 +130,3 @@ Any "Instant" in the specification is an ISO 8601 date-time. Any Duration is an ISO 8601 duration. | ||
| It will include all fields | ||
| listed [here](../digger-json/src/commonMain/kotlin/com/zegreatrob/tools/digger/json/ContributionDataJson.kt). | ||
| listed [here](../../tools/digger-json/src/commonMain/kotlin/com/zegreatrob/tools/digger/json/ContributionDataJson.kt). | ||
@@ -136,3 +137,4 @@ Any "Instant" in the specification is an ISO 8601 date-time. Any Duration is an ISO 8601 duration. | ||
| Both commands support structured output via the `--format` flag. Use `--format=json` for advanced build automation that needs explicit status envelopes and error handling. | ||
| Both commands support structured output via the `--format` flag. Use `--format=json` for advanced build automation that | ||
| needs explicit status envelopes and error handling. | ||
@@ -198,3 +200,3 @@ ### Format Options | ||
| The `data` field contains the contribution data object. | ||
| See [ContributionDataJson.kt](../digger-json/src/commonMain/kotlin/com/zegreatrob/tools/digger/json/ContributionDataJson.kt) | ||
| See [ContributionDataJson.kt](../../tools/digger-json/src/commonMain/kotlin/com/zegreatrob/tools/digger/json/ContributionDataJson.kt) | ||
| for the complete schema, or use `current-contribution-data --help` for field descriptions. | ||
@@ -309,3 +311,3 @@ | ||
| - [Digger Guide](src/commonMain/resources/help/digger-guide.md) - Fit assessment, philosophy, and workflow guidance | ||
| - [Digger Guide](../../tools/digger-guide/src/commonMain/resources/help/digger-guide.md) - Fit assessment, philosophy, and workflow guidance | ||
| - [Digger Help](src/commonMain/resources/help/digger.md) - Main command overview and options | ||
@@ -312,0 +314,0 @@ - [Current Contribution Data Help](src/commonMain/resources/help/current-contribution-data.md) - Command details and |
New alerts
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Fixed alerts
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Improved metrics
- Total package byte prevSize
3595743
0- Number of lines in readme file
312
0.65%