-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Remove trailing periods from @name metadata in query files #20923
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
Conversation
Fixed 73 .ql query files where the @name metadata contained an ending period. This ensures consistency with the CodeQL query metadata style guidelines.
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.
Pull request overview
This PR standardizes CodeQL query metadata by removing trailing periods from @name fields across 73 query files. The changes align these files with CodeQL query metadata style guidelines, ensuring consistency across the codebase and reducing the likelihood of style-related errors when queries are integrated into documentation.
Key Changes
- Removed trailing periods from
@namemetadata in query files - Applied changes consistently across multiple languages (Rust, Ruby, QL, Python, Java, C#, C++, and Actions)
- Updated utility queries, security queries, and test queries
Reviewed changes
Copilot reviewed 73 out of 73 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| rust/ql/src/utils/modelgenerator/*.ql | Updated model generator utility queries to remove trailing periods |
| ruby/ql/src/utils/modeleditor/FrameworkModeAccessPaths.ql | Fixed metadata in framework mode access paths query |
| ruby/ql/src/queries/variables/UnusedParameter.ql | Updated unused parameter query metadata |
| ql/ql/src/queries/style/**/*.ql | Standardized style-related query metadata |
| ql/ql/src/queries/performance/*.ql | Fixed performance query metadata |
| python/ql/src/experimental/cryptography/**/*.ql | Updated cryptography-related query names |
| python/ql/src/experimental/Security/**/*.ql | Standardized security query metadata |
| python/ql/src/analysis/*.ql | Fixed analysis query metadata |
| python/ql/src/Variables/Global.ql | Updated global variable query name |
| python/ql/src/Security/**/*.ql | Standardized security query metadata |
| python/ql/src/Classes/MutatingDescriptor.ql | Fixed descriptor mutation query name |
| java/ql/src/utils/**/*.ql | Updated Java utility query metadata |
| java/ql/src/experimental/Security/**/*.ql | Standardized Java security query names |
| csharp/ql/test/library-tests/**/*.ql | Fixed C# test query metadata |
| csharp/ql/src/utils/**/*.ql | Updated C# utility query metadata |
| csharp/ql/src/experimental/**/*.ql | Standardized experimental C# query names |
| csharp/ql/src/Security Features/**/*.ql | Fixed C# security feature query metadata |
| csharp/ql/src/Likely Bugs/**/*.ql | Updated likely bugs query metadata |
| cpp/ql/src/utils/**/*.ql | Standardized C++ utility query names |
| cpp/ql/src/experimental/Security/**/*.ql | Fixed experimental C++ security query metadata |
| actions/ql/src/experimental/Security/**/*.ql | Updated GitHub Actions security query names |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jketema
left a comment
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.
LGTM
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.
Java 👍🏻 (I checked all languages). I noticed while reviewing that java/ql/src/experimental/Security/CWE/CWE-327/Azure/UnsafeUsageOfClientSideEncryptionVersion.ql has a @description metadata which is missing a trailing period. Worth fixing that in the same PR? Or a follow-up?
Side note: I'm very proud that Go, which is what I mainly work on, didn't have any 😆 .
geoffw0
left a comment
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.
CPP, Rust 👍
Not sure how important it is to get approval for all languages on this one.
@geoffw0 - I was wondering the same, but would prefer an engineer to merge the PR if we skip some of the reviews. |
|
@owen-mc - that's a good point. I imagine that there are other descriptions with that problem, so it's probably worth asking Copilot to do a check for that too. Happy to add another commit to this PR, but then everyone will be re-requested to review. Not sure which is more annoying, another ping on this PR or a second PR 🤔 |
Copilot fixed 73 .ql query files where the @name metadata contained an ending period. This ensures consistency with the CodeQL query metadata style guidelines.
This PR will also increase the chances of future queries being created with names that match the style guide and don't raise errors in the
docsrepository.