@microsoft/sarif-multitool-linux 5.0.3 → 5.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Binary file
package/Sarif.Driver.pdb CHANGED
Binary file
package/Sarif.Multitool CHANGED
Binary file
Binary file
@@ -54,7 +54,7 @@
54
54
  <remarks>
55
55
  The result's <c>ruleId</c> is validated at receipt against the AI ruleId convention
56
56
  (taxonomy sub-id form or NOVEL- escape hatch). On rejection the verb writes the
57
- AI-consumable error envelope (error code AI-RULEID-001) to stderr and returns
57
+ AI-consumable error envelope (error code AI1012) to stderr and returns
58
58
  <see cref="F:Microsoft.CodeAnalysis.Sarif.Driver.CommandBase.FAILURE"/> WITHOUT appending — an AI orchestrator can retry the
59
59
  individual result without first having to remove garbage from the event log.
60
60
  </remarks>
@@ -251,6 +251,23 @@
251
251
  SARIF file.
252
252
  </summary>
253
253
  </member>
254
+ <member name="M:Microsoft.CodeAnalysis.Sarif.Multitool.EmitFinalizeCommand.ApplyRankDerivedSecuritySeverity(Microsoft.CodeAnalysis.Sarif.Run)">
255
+ <summary>
256
+ Derives a GitHub Advanced Security <c>security-severity</c> for each rule descriptor
257
+ from the highest <see cref="P:Microsoft.CodeAnalysis.Sarif.Result.Rank"/> observed across the results that reference
258
+ it, mapping the SARIF rank scale (0–100) onto the security-severity scale (0.0–10.0)
259
+ by dividing by ten.
260
+ </summary>
261
+ <remarks>
262
+ GHAS reads <c>security-severity</c> off the rule a result references, never off a
263
+ taxon, so the value is stamped on <c>tool.driver.rules[]</c>. Results carry an
264
+ authoritative <c>ruleIndex</c> by the time the log is replayed, so association is by
265
+ index rather than by id. The rank sentinel <c>-1.0</c> ("unset") is excluded: a rule
266
+ whose results carry no rank receives nothing, and a producer-authored
267
+ <c>security-severity</c> is left untouched.
268
+ </remarks>
269
+ <returns>The number of rule descriptors stamped.</returns>
270
+ </member>
254
271
  <member name="M:Microsoft.CodeAnalysis.Sarif.Multitool.EmitFinalizeCommand.RunValidatorAndReport(System.String)">
255
272
  <summary>
256
273
  Runs the multitool validator (--rule-kind Sarif;AI) against the finalized SARIF.
@@ -274,7 +291,10 @@
274
291
  at a portable root — a GitHub-compatible blob permalink (commit-pinned in the URL) or an Azure
275
292
  DevOps repository root (commit pinning carried by <c>versionControlProvenance.revisionId</c>),
276
293
  derived from the repositoryUri by <see cref="T:Microsoft.CodeAnalysis.Sarif.Multitool.VcpPortableRoot"/> — so the finalized SARIF
277
- carries no machine-specific path.
294
+ carries no machine-specific path. Each minted base also carries a <c>description</c> whose
295
+ <c>text</c> is a SARIF embedded link (§3.11.6) whose anchor names the repository and
296
+ abbreviated commit (<c>&lt;repo&gt;@&lt;short-sha&gt;</c>) and whose destination is a
297
+ browsable root-at-revision URL, unless the input base already supplied a description.
278
298
  </summary>
279
299
  <remarks>
280
300
  One repository collapses to the bare <c>SRCROOT</c> base. Multiple repositories each receive
@@ -527,7 +547,7 @@
527
547
  coordinates are URL-path escaped, ready to compose into a REST endpoint path.
528
548
  </summary>
529
549
  </member>
530
- <member name="M:Microsoft.CodeAnalysis.Sarif.Multitool.VcpPortableRoot.TryDerivePortableRoot(System.Uri,System.String,System.Uri@,System.Uri@,System.String@,System.String@)">
550
+ <member name="M:Microsoft.CodeAnalysis.Sarif.Multitool.VcpPortableRoot.TryDerivePortableRoot(System.Uri,System.String,System.Uri@,System.Uri@,System.String@,System.Uri@,System.String@)">
531
551
  <summary>
532
552
  Mints the portable root for <paramref name="rawRepositoryUri"/>. Used at emit-finalize.
533
553
  <paramref name="canonicalRepositoryUri"/> is the clean https identity (userinfo stripped,
@@ -547,6 +567,29 @@
547
567
  SarifWorkItemFiler in order to complete the work.
548
568
  </summary>
549
569
  </member>
570
+ <member name="T:Microsoft.CodeAnalysis.Sarif.Multitool.GetCweCommand">
571
+ <summary>
572
+ Implements <c>get-cwe</c>: serves canonical MITRE CWE data from the SDK's embedded taxonomy.
573
+ </summary>
574
+ <remarks>
575
+ Each record's <c>ruleIdFallback</c> (<c>CWE-&lt;n&gt;/&lt;slug&gt;</c>) is the kebab-cased
576
+ CWE name produced by the same helper AI1012 uses, so the two always agree.
577
+ </remarks>
578
+ </member>
579
+ <member name="T:Microsoft.CodeAnalysis.Sarif.Multitool.CweOutputFormat">
580
+ <summary>
581
+ Output format for <c>get-cwe</c>.
582
+ </summary>
583
+ </member>
584
+ <member name="T:Microsoft.CodeAnalysis.Sarif.Multitool.GetCweOptions">
585
+ <summary>
586
+ Options for <c>get-cwe</c>, which serves canonical MITRE CWE data from the SDK's embedded
587
+ taxonomy. Each record carries a <c>ruleIdFallback</c> — the kebab-cased
588
+ <c>CWE-&lt;n&gt;/&lt;slug&gt;</c> a producer can drop into <c>result.ruleId</c> when it will
589
+ not author a sharper sub-id. The fallback is computed the same way AI1012 derives its
590
+ suggestion, so the two always agree.
591
+ </summary>
592
+ </member>
550
593
  <member name="T:Microsoft.CodeAnalysis.Sarif.Multitool.GetSchemaCommand">
551
594
  <summary>
552
595
  Implements <c>get-schema</c>: emits the embedded JSON Schema that validates the
@@ -620,6 +663,20 @@
620
663
  path, collapsing <c>.</c> and <c>..</c> segments.
621
664
  </summary>
622
665
  </member>
666
+ <member name="M:Microsoft.CodeAnalysis.Sarif.Multitool.GetSkillCommand.TryGetSkillDescription(System.String)">
667
+ <summary>
668
+ Returns the skill's frontmatter <c>description</c>, or <c>null</c> when the embedded resource
669
+ is missing or declares none. This is the single source of truth for the skill's one-line
670
+ summary — the same scalar a consumer reads from the emitted document's frontmatter.
671
+ </summary>
672
+ </member>
673
+ <member name="M:Microsoft.CodeAnalysis.Sarif.Multitool.GetSkillCommand.ExtractFrontmatterDescription(System.String)">
674
+ <summary>
675
+ Extracts the <c>description</c> scalar from a skill document's leading YAML frontmatter block.
676
+ Returns <c>null</c> when the document opens no frontmatter, declares no description, or uses a
677
+ multi-line block scalar (which the terse catalog does not render).
678
+ </summary>
679
+ </member>
623
680
  <member name="T:Microsoft.CodeAnalysis.Sarif.Multitool.GetSkillOptions">
624
681
  <summary>
625
682
  Options for <c>get-skill</c>, which emits an agent skill that drives the multitool emit and
Binary file
Binary file
package/Sarif.pdb CHANGED
Binary file
package/Sarif.xml CHANGED
@@ -6920,7 +6920,8 @@
6920
6920
  <member name="F:Microsoft.CodeAnalysis.Sarif.Emit.AIRuleIdConventionException.ErrorCode">
6921
6921
  <summary>
6922
6922
  Stable error code so downstream tooling can pattern-match without parsing the
6923
- human-readable message body.
6923
+ human-readable message body. This is the canonical AI1012 (ProvideRuleSubId)
6924
+ rule id, so the emit-time rejection and the post-hoc validator report one id.
6924
6925
  </summary>
6925
6926
  </member>
6926
6927
  <member name="P:Microsoft.CodeAnalysis.Sarif.Emit.AIRuleIdConventionException.OffendingRuleIds">
@@ -7188,6 +7189,13 @@
7188
7189
  Clear current cache.
7189
7190
  </summary>
7190
7191
  </member>
7192
+ <member name="M:Microsoft.CodeAnalysis.Sarif.FileRegionsCache.GetText(System.Uri,System.String)">
7193
+ <summary>
7194
+ Returns the full text of the artifact at <paramref name="uri"/>, reading it from the
7195
+ file system on first access and caching the result. Returns <c>null</c> when the file
7196
+ cannot be read (missing, I/O error, or access denied).
7197
+ </summary>
7198
+ </member>
7191
7199
  <member name="M:Microsoft.CodeAnalysis.Sarif.FileRegionsCache.ReconcileRegionCoordinate(System.Boolean,System.String,System.Int32,System.Int32)">
7192
7200
  <summary>
7193
7201
  Reconciles an authored region coordinate against the value computed from the source
package/WorkItems.pdb CHANGED
Binary file
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@microsoft/sarif-multitool-linux",
3
3
  "description": "SARIF Multitool for Linux",
4
- "version": "5.0.3",
4
+ "version": "5.0.4",
5
5
  "scripts": {
6
6
  "postinstall": "chmod u+x Sarif.Multitool"
7
7
  },