Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement note rule CPMR0069 - Package Id is too long, and doesn't contain dashes #38

Closed
2 tasks done
Tracked by #30
AdmiringWorm opened this issue Jan 28, 2024 · 1 comment · Fixed by #53
Closed
2 tasks done
Tracked by #30
Assignees
Labels
5 - Released The issue has been resolved, and released to the public for consumption Improvement Issues that enhances existing functionality, or adds new features
Milestone

Comments

@AdmiringWorm
Copy link
Member

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

No response

Describe The Solution. Why is it needed?

We should implement the note rule available in Package Validator that verifies the length of the package identifier.
A package identifier should never be equal or exceed the length of 20 characters, unless it also has dashes (-) in its name as well.

The suffixes .install, .template, .install, .portable and .powershell should not be included when determining the length.

We will make this rule stricter than the rule implemented by Package Validator, and ensure the length does not exceed or is equal to 20 characters between dashes as well.

Additional Context

Rule Documentation: https://ch0.co/rules/cpmr0069

Related Issues

No response

@AdmiringWorm AdmiringWorm added Improvement Issues that enhances existing functionality, or adds new features 0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint labels Jan 28, 2024
@AdmiringWorm AdmiringWorm added this to the 0.2.0 milestone Jan 28, 2024
@AdmiringWorm AdmiringWorm added 1 - Ready Issue is accepted, milestone added and are ready to be worked on and removed 0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint labels Apr 25, 2024
@AdmiringWorm AdmiringWorm self-assigned this Jul 9, 2024
@AdmiringWorm AdmiringWorm added 2 - Working A user or team member has started working on the issue and removed 1 - Ready Issue is accepted, milestone added and are ready to be worked on labels Jul 9, 2024
AdmiringWorm added a commit to AdmiringWorm/chocolatey-community-validation that referenced this issue Jul 26, 2024
This implements the note rule CPMR0069, that verifies that the length of
the package identifier is not longer than 20 characters without a dash
between the words.

This implementation is more restrict than what is currently implemented
on Package Validator as it will also consider packages that have certain
extension, just by removing this extension first and it will also verify
that any section between dashes is not longer than 20 characters.
@AdmiringWorm AdmiringWorm added 3 - Review Code has been added, and is available for review as a pull request and removed 2 - Working A user or team member has started working on the issue labels Jul 26, 2024
gep13 added a commit that referenced this issue Jul 29, 2024
(#38) Add rule for validating ID length
@gep13 gep13 closed this as completed in #53 Jul 29, 2024
@AdmiringWorm AdmiringWorm added 4 - Done Code has been added to the repository, and has been reviewed by a team member and removed 3 - Review Code has been added, and is available for review as a pull request labels Aug 5, 2024
AdmiringWorm added a commit to AdmiringWorm/chocolatey-community-validation that referenced this issue Dec 11, 2024
* release/0.2.0: (21 commits)
  (maint) Fix incorrect label used in config
  (chocolatey-community#58) Implement requirement rule CPMR0074
  (chocolatey-community#28) Add rule to disallow icon URL using GitHub links
  (chocolatey-community#37) Implement note rule CPMR0068
  (chocolatey-community#36) Implement note rule CPMR0067
  (maint) Set explicit PlatformTarget for console
  (maint) synced local '.github/ISSUE_TEMPLATE/' with remote '.github/ISSUE_TEMPLATE/'
  (chocolatey-community#38) Add rule for validating ID length
  (chocolatey-community#39) Add rule for validating underscore in ID
  (chocolatey-community#34) Implement note rule CPMR0061 - Id Contains "."
  (maint) synced local '.github/PULL_REQUEST_TEMPLATE.md' with remote '.github/PULL_REQUEST_TEMPLATE.md'
  (build) Update Chocolatey.Cake.Recipe to latest
  (chocolatey-community#35) Implement note rule CPMR0062
  (build) Update to latest Recipe package
  (maint) synced local '.github/ISSUE_TEMPLATE/' with remote '.github/ISSUE_TEMPLATE/'
  (chocolatey-community#32) Update Help URLs to short link
  (chocolatey-community#29) Add missing release notes to generated packages
  (maint) Update extension name in Readme
  (maint) synced local '.templates/' with remote '.github/GitReleaseManager/.templates/'
  (chocolatey-community#26) Use milestone for license URL replacement
  ...
@AdmiringWorm AdmiringWorm added 5 - Released The issue has been resolved, and released to the public for consumption and removed 4 - Done Code has been added to the repository, and has been reviewed by a team member labels Dec 11, 2024
@AdmiringWorm
Copy link
Member Author

🎉 This issue has been resolved in version 0.2.0 🎉

The release is available on:

Your GitReleaseManager bot 📦 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Released The issue has been resolved, and released to the public for consumption Improvement Issues that enhances existing functionality, or adds new features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant