Skip to content

Need tooling to enforce style guide #4708

Description

Everyone agrees that from a style perspective, the intent is to have consistency in the code to make it more readable and maintainable. Update https://github.com/PowerShell/PowerShell/blob/master/docs/dev-process/coding-guidelines.md as needed, but should be enforced by tooling and not by PR comments.

  • enforcement on the CI side
  • enforcement on the developer side (part of Start-PSPester?)

Activity

  1. added this to the milestone on Aug 30, 2017
  2. iSazonov commented on Aug 31, 2017

    @iSazonov
    Collaborator

    We already have PR #3504 for CI side and request from Jason Shirk (@lzybkr) for developer side (git commit hooks) in the PR.

  3. changed the title [-]Need published style guide and tooling to enforce[/-] [+]Need tooling to enforce style guide[/+] on Aug 31, 2017
  4. SteveL-MSFT commented on Aug 31, 2017

    @SteveL-MSFT
    MemberAuthor

    Ilya (@iSazonov) you can close this once that PR is merged. Thanks!

  5. iSazonov commented on Aug 31, 2017

    @iSazonov
    Collaborator

    The PR s problematic - we can't merge it until we fix all files in the repo.
    Also I believe we should address git commit hooks in another PR - I never write such hooks.

    /cc Jason Shirk (@lzybkr)

  6. daxian-dbw commented on Sep 1, 2017

    @daxian-dbw
    Member

    Travis Plunk (@TravisEz13) Could you please comment? I think you have more experience on this and have some ideas about how we can gradually roll out the files that are covered by the formatting checks.

  7. iSazonov commented on May 9, 2018

    @iSazonov
    Collaborator

    I see GitHub introduce Checks. Can we use this?

  8. TravisEz13 commented on May 9, 2018

    @TravisEz13
    Member

    I've seen other teams using https://www.codefactor.io/

  9. iSazonov commented on May 10, 2018

    @iSazonov
    Collaborator

    Screenshots look ver interesting. Can we try this in the repo?

  10. TravisEz13 commented on May 10, 2018

    @TravisEz13
    Member
  11. SteveL-MSFT commented on May 10, 2018

    @SteveL-MSFT
    MemberAuthor

    Travis Plunk (@TravisEz13) I'm open to trying it out. I'll set it up.

  12. adityapatwardhan commented on May 10, 2018

    @adityapatwardhan
    Member

    I am open to trying it as long as it does not block PRs from being merged, at least to begin with.

  13. 21 remaining items

  14. joeyaiello commented on May 30, 2019

    @joeyaiello
    Contributor

    Steve Lee (@SteveL-MSFT) is this okay to close now?

  15. vexx32 commented on May 30, 2019

    @vexx32
    Collaborator

    Do we have an omnisharp.json in the repo with the mentioned style rules set for VS Code users? Might be a good idea to do so if we haven't.

    Also, I opened another issue already, but codefactor should definitely come back for those edge cases and misc recommendations.

  16. SteveL-MSFT commented on Jun 6, 2019

    @SteveL-MSFT
    MemberAuthor

    Joey Aiello (@joeyaiello) no, we need to integrate with CI

  17. iSazonov commented on Jun 6, 2019

    @iSazonov
    Collaborator

    Rain Sallow (/u/ta11ow) (@vexx32) We have .editorconfig as unified config for all editors.

  18. microsoft-github-policy-service commented on Nov 16, 2023

    @microsoft-github-policy-service
    Contributor

    This issue has not had any activity in 6 months, if this is a bug please try to reproduce on the latest version of PowerShell and reopen a new issue and reference this issue if this is still a blocker for you.

  19. microsoft-github-policy-service commented on Nov 16, 2023

    @microsoft-github-policy-service
    Contributor

    This issue has not had any activity in 6 months, if this is a bug please try to reproduce on the latest version of PowerShell and reopen a new issue and reference this issue if this is still a blocker for you.

  20. microsoft-github-policy-service commented on Nov 16, 2023

    @microsoft-github-policy-service
    Contributor

    This issue has not had any activity in 6 months, if this is a bug please try to reproduce on the latest version of PowerShell and reopen a new issue and reference this issue if this is still a blocker for you.

  21. microsoft-github-policy-service commented on Nov 23, 2023

    @microsoft-github-policy-service
    Contributor

    This issue has been marked as "No Activity" as there has been no activity for 6 months. It has been closed for housekeeping purposes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions