Skip to content

refactor(build): drop $_ prefix from helper variable names#20

Merged
tablackburn merged 1 commit into
mainfrom
refactor/drop-underscore-prefix-on-helper-vars
May 4, 2026
Merged

refactor(build): drop $_ prefix from helper variable names#20
tablackburn merged 1 commit into
mainfrom
refactor/drop-underscore-prefix-on-helper-vars

Conversation

@tablackburn
Copy link
Copy Markdown
Owner

@tablackburn tablackburn commented May 4, 2026

Summary

Rename $_moduleVersion$moduleVersion and $_stagedOutput$stagedOutput in build.psake.ps1's properties block. Pure rename, no behavior change.

Why

The $_ prefix was meant to signal "internal helper, not $PSBPreference configuration" — a convention I introduced in PR #19. Copilot flagged it on a downstream convergence PR as easy to misread as the $_ automatic pipeline variable. Fair point: PowerShell parses $_<word> as a single identifier, so it's syntactically unambiguous, but the visual collision is real for anyone scanning the file.

The shorter names are clearer in context (assignment targets in a properties{} block, not script-block parameters where $_ would actually mean something).

Cross-repo sync

Same rename applied across the user's downstream PowerShell modules so the template and all initialized modules stay in sync:

Test plan

  • CI green (un-initialized template skips Build/Test, so this just exercises lint and pre-commit checks)
  • Downstream CI on the three sister PRs/branches green (the rename is exercised there against real test suites)

🤖 Generated with Claude Code

Rename $_moduleVersion → $moduleVersion and $_stagedOutput → $stagedOutput
in build.psake.ps1's properties block. Pure rename, no behavior change.

The $_ prefix was meant to signal "internal helper, not configuration"
but is easy to misread as the $_ automatic pipeline variable. The
shorter names are clearer in context (assignment targets in a
properties{} block, not script-block parameters).

Same rename applied across the user's downstream modules
(JsmOperations, PlexAutomationToolkit, ReScenePS) so the template and
all initialized modules stay in sync.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 4, 2026 03:18
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

Warning

Rate limit exceeded

@tablackburn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 29 minutes and 31 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 35a29886-f3dd-4913-be8d-bc3eaad5b5d6

📥 Commits

Reviewing files that changed from the base of the PR and between 03b9864 and b88763c.

📒 Files selected for processing (1)
  • build.psake.ps1
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refactor/drop-underscore-prefix-on-helper-vars

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
Review rate limit: 0/1 reviews remaining, refill in 29 minutes and 31 seconds.

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

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes a small readability refactor in the build script by renaming two local helper variables in the properties {} block of build.psake.ps1. It fits into the build/test configuration added in PR #19 and keeps the staged-output coverage logic intact while removing names that can be visually confused with PowerShell’s $_ automatic variable.

Changes:

  • Renames $_moduleVersion to $moduleVersion in the coverage-path setup.
  • Renames $_stagedOutput to $stagedOutput and updates the two coverage glob references.
  • Leaves the staged output/coverage behavior unchanged.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tablackburn
Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 4, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@tablackburn tablackburn merged commit 8d0059c into main May 4, 2026
15 checks passed
@tablackburn tablackburn deleted the refactor/drop-underscore-prefix-on-helper-vars branch May 4, 2026 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants