GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Convert UseSingularNouns to configurable rule and add Windows to allowlist by MJVL · Pull Request #1858 · PowerShell/PSScriptAnalyzer

Conversation

@MJVL

@MJVL Michael Van Leeuwen (MJVL) commented Nov 6, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

PR Summary

This PR:

  • Converts PSUseSingularNouns to a configurable rule
  • Adds Windows to the PSUseSingularNouns allowlist, closing issue Windows should not be a plural noun #1736

Relevant test has also been added.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
  • Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Michael Van Leeuwen (MJVL) added 2 commits November 6, 2022 12:36
@MJVL
Add Windows to the UseSingularNouns allow list
936f37a
@MJVL
Add test case for Windows verb
5489f4c
bergmeister
Christoph Bergmeister (bergmeister) reviewed Nov 7, 2022
View reviewed changes

@bergmeister Christoph Bergmeister (bergmeister) left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

I'd be happy to accept it as-is but I am thinking it might be better to expose this allowList as a configurable setting so it can be overridden similar to how we decided to do for this rule when allow-listing az:
https://github.com/PowerShell/PSScriptAnalyzer/pull/1846/files#diff-0c1b69454498d51fc5f5ba732f2589578f37357dd80b111e8330fff529036908

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
MJVL reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@MJVL

Michael Van Leeuwen (MJVL) commented Nov 7, 2022

Copy link
Copy Markdown
Contributor Author

I'd be happy to accept it as-is but I am thinking it might be better to expose this allowList as a configurable setting so it can be overridden similar to how we decided to do for this rule when allow-listing az: https://github.com/PowerShell/PSScriptAnalyzer/pull/1846/files#diff-0c1b69454498d51fc5f5ba732f2589578f37357dd80b111e8330fff529036908

I agree, as this could cut down on any future issues asking for additional allowList nouns. I can look into refactoring this as a configurable rule.

For the default value, do you think it would still be proper to include {"Data", "Windows"}, or would it be better practice to leave this blank entirely?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bergmeister

Christoph Bergmeister (bergmeister) commented Nov 7, 2022

Copy link
Copy Markdown
Collaborator

Yes, in that case also happy to add Windows to default.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Michael Van Leeuwen (MJVL) added 2 commits November 7, 2022 19:44
@MJVL
Refactor UseSingularNouns to configurable rule and add tests
ae9f6f9
@MJVL
Update UseSingularNouns docs with configuration information
3866245
@MJVL Michael Van Leeuwen (MJVL) changed the title Add Windows to noun allowlist Convert UseSingularNouns to configurable rule and add Windows to allowlist Nov 8, 2022
MJVL
Michael Van Leeuwen (MJVL) commented Nov 8, 2022
View reviewed changes
Comment thread docs/Rules/UseSingularNouns.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
@MJVL
Remove extra test code
474e130
bergmeister
Christoph Bergmeister (bergmeister) approved these changes Nov 8, 2022
View reviewed changes

@bergmeister Christoph Bergmeister (bergmeister) left a comment

Copy link
Copy Markdown
Collaborator

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks for the additional effort. Looks good to me 👍🏻

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bergmeister

Christoph Bergmeister (bergmeister) commented Jan 2, 2024

Copy link
Copy Markdown
Collaborator

Closing and re-opening to re-trigger CI
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bergmeister Christoph Bergmeister (bergmeister) closed this Jan 2, 2024
@bergmeister Christoph Bergmeister (bergmeister) reopened this Jan 2, 2024
JamesWTruher
James Truher (JamesWTruher) approved these changes Jan 16, 2024
View reviewed changes
@bergmeister
Merge branch 'master' into nounFix
e54153c
@bergmeister
Christoph Bergmeister (bergmeister) merged commit da64672 into PowerShell:master Jan 18, 2024
This was referenced Mar 16, 2024
Update PSScriptAnalyzer to v1.22.0 ForNeVeR/intellij-powershell-fork#1
Closed
Update PSScriptAnalyzer to v1.22.0 intellij-powershell/intellij-powershell#244
Merged
Update PowerShellEditorServices to v3.18.1 and PSScriptAnalyzer to v1.22.0 ForNeVeR/intellij-powershell-fork#2
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bergmeister Christoph Bergmeister (bergmeister) bergmeister approved these changes
+1 more reviewer
@JamesWTruher James Truher (JamesWTruher) JamesWTruher approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@MJVL @bergmeister @JamesWTruher
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.