feat: add useEquipmentIdAsContingencyNameForPolygonCreation to Metadata

[flomillot]

Summary

• Add optional useEquipmentIdAsContingencyNameForPolygonCreation property to Metadata type to support using equipment IDs instead of names as contingency identifiers during polygon creation

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d314d2e5-e8ec-4d3e-9991-55e932e1d569

📥 Commits

Reviewing files that changed from the base of the PR and between d0bde9a and 2596451.

📒 Files selected for processing (1)

• src/utils/types/metadata.ts

✅ Files skipped from review due to trivial changes (1)

• src/utils/types/metadata.ts

---

📝 Walkthrough

Walkthrough

Added an optional boolean property useBusbarIdAsContingencyNameForPolygonCreation to the exported Metadata type, which now flows into StudyMetadata and ExploreMetadata via their intersection with Metadata.

Changes

Cohort / File(s)	Summary
Type Definition Update src/utils/types/metadata.ts	Added optional boolean useBusbarIdAsContingencyNameForPolygonCreation to the exported Metadata type, updating the effective shape of StudyMetadata and ExploreMetadata.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title mentions 'useEquipmentIdAsContingencyNameForPolygonCreation' but the actual change implements 'useBusbarIdAsContingencyNameForPolygonCreation', creating a mismatch between the described and actual property name.	Update the PR title to accurately reflect the implemented property name: 'feat: add useBusbarIdAsContingencyNameForPolygonCreation to Metadata'
Description check	⚠️ Warning	The description mentions 'useEquipmentIdAsContingencyNameForPolygonCreation' but the actual implementation uses 'useBusbarIdAsContingencyNameForPolygonCreation', which is inconsistent with the changeset.	Update the description to use the correct property name 'useBusbarIdAsContingencyNameForPolygonCreation' to match the actual implementation.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/utils/types/metadata.ts`:
- Line 20: The new public Metadata property
useEquipmentIdAsContingencyNameForPolygonCreation is missing JSDoc; add a
concise JSDoc comment immediately above the property explaining its purpose
(controls whether equipmentId is used as the contingency polygon name), when to
set it (for services that want polygon names derived from equipment IDs), and
how undefined is interpreted (default false), and mark the type as boolean |
undefined if applicable; optionally offer a shorter alias/name (e.g.,
useEquipmentIdForContingency or useIdForPolygonContingency) in the comment or
consider renaming the property in Metadata to improve readability.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2e734038-3f51-438b-81e2-ab9303d39e5d

📥 Commits

Reviewing files that changed from the base of the PR and between ac2c4a2 and d0bde9a.

📒 Files selected for processing (1)

• src/utils/types/metadata.ts

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud