JS: Add migration guide and change note#18427
Merged
Merged
Conversation
asgerf
force-pushed
the
jss/change-note
branch
3 times, most recently
from
df0cccb to
439ed22
Compare
asgerf
force-pushed
the
jss/change-note
branch
from
439ed22 to
0623913
Compare
Contributor
There was a problem hiding this comment.
Copilot reviewed 2 out of 6 changed files in this pull request and generated no comments.
Files not reviewed (4)
- docs/codeql/codeql-language-guides/codeql-for-javascript.rst: Language not supported
- docs/codeql/codeql-language-guides/migrating-javascript-dataflow-queries.rst: Language not supported
- javascript/ql/lib/semmle/javascript/dataflow/Configuration.qll: Language not supported
- javascript/ql/lib/semmle/javascript/dataflow/TaintTracking.qll: Language not supported
Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more
erik-krogh
reviewed
Jan 8, 2025
erik-krogh
left a comment
erik-krogh
left a comment
Contributor
There was a problem hiding this comment.
I used various LLMs to find typos and other grammar mistakes, they found a lot (that I would also have missed).
- o1 from OpenAI was great, and always gave me great feedback.
- Claude 3.5 gave me a few suggestions that all turned out to be incorrect, but I only started using it after o1 was done.
- Gemeni 2.0 Flash was shit. It produced a massive list of sentences that should be corrected, but the "correction" was most of the time just a copy of the original.
I'll read the text myself now, and see whether I have comments on the substance.
Co-authored-by: Erik Krogh Kristensen <erik-krogh@github.com>
…ow-queries.rst Co-authored-by: Erik Krogh Kristensen <erik-krogh@github.com>
erik-krogh
approved these changes
Jan 8, 2025
erik-krogh
left a comment
erik-krogh
left a comment
Contributor
There was a problem hiding this comment.
👍
Two optional comments.
Comment on lines
+100
to
+101
| - The ``isSanitizer`` predicate should be renamed to ``isBarrier``. | ||
| - The ``isAdditionalTaintStep`` predicate should be renamed to ``isAdditionalFlowStep``. |
Contributor
There was a problem hiding this comment.
maybe specify that it's the predicates from the old class-style configuration that's being referred to.
Contributor
Author
There was a problem hiding this comment.
Clarified a bit, PTAL
Comment on lines
+109
to
+110
| class MyConfig extends TaintTracking::Configuration { | ||
| predicate isSanitizer(DataFlow::Node node) { ... } |
Contributor
There was a problem hiding this comment.
maybe insert a charpred here, just to make it more realistic?
erik-krogh
approved these changes
Jan 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a migration guide, change notes linking to the guide, and qldoc to the
Configurationclasses also linking to the guide.The sphinx CI job is broken, but the docs can be generated locally by the
sphinxbuild target. Alternatively, they can be seen by downloading and opening this HTML file locally.