Commentor #723

pelikhan · 2024-09-24T13:25:15Z

The JSONLineCache class in cache.ts was expanded with additional comments for better code understanding. 📝
Additions in cancellation.ts include remarks for constructors and methods to enhance clarity and maintainability of the code. ✅
More in-depth commenting was also appended to classes and methods in chatcache.ts, making it simpler for other engineers to grasp the code's purpose and functionality. 👥
Amendments in changelog.test.ts and diff.test.ts suggest an improvement in test coverage. 🧪
The 'changelog-genai.js` script is slightly adjusted to correctly detect and handle Changelog blocks. 🔄
In glob.ts, the function isGlobMatch now accepts an array of patterns for greater flexibility. ➕
runpromptcontext.ts was improved to accept an array of patterns for fileOutput. 🎛
In systems.ts, tools resolution was improved to return system IDs linked to specific tools. 🔧
TOMLTryParse function in toml.ts now has better error handling to prevent crashes on parsing errors. 💪
For prompt type definition files prompt_template.d.ts and prompt_type.d.ts, the defFileOutput function has been modified to accept either a string or an array of strings for pattern specification. 👌
A new file cmt.genai.mts has been added, this is a script using generative AI to add comments to other source code files. 🤖

generated by pr-describe

…pport multiple glob patterns

…che and documentor files

… and formatting

github-actions · 2024-09-24T13:26:16Z

docs/src/content/docs/reference/scripts/system.mdx

@@ -160,7 +160,7 @@ index N in the above snippets, and then be prefixed with exactly the same whites
 the original snippets above. See also the following examples of the expected response format.

 CHANGELOG:
-\`\`\`
+\`\`\`changelog


Incorrect code fence; 'changelog' language specifier should be removed.

generated by pr-docs-review-commit incorrect_code_fence

github-actions · 2024-09-24T13:26:26Z

packages/core/src/diff.ts

@@ -217,9 +217,12 @@ export function applyLLMPatch(source: string, chunks: Chunk[]): string {
                const line =
                    chunk.state === "deleted" ? undefined : chunk.lines[li]
                const linei = chunk.lineNumbers[li] - 1
-                if (isNaN(linei)) throw new DiffError("missing line number")
+                if (isNaN(linei))


The error message thrown when the line number is NaN is not descriptive enough. Consider providing more context in the error message.

generated by pr-review-commit missing_error_message

github-actions · 2024-09-24T13:26:27Z

packages/core/src/diff.ts

@@ -217,9 +217,12 @@ export function applyLLMPatch(source: string, chunks: Chunk[]): string {
                const line =
                    chunk.state === "deleted" ? undefined : chunk.lines[li]
                const linei = chunk.lineNumbers[li] - 1
-                if (isNaN(linei)) throw new DiffError("missing line number")
+                if (isNaN(linei))
+                    throw new DiffError(`diff: missing or nan line number`)
                if (linei < 0 || linei >= lines.length)


The error message thrown when the line number is invalid is not descriptive enough. Consider providing more context in the error message.

generated by pr-review-commit missing_error_message

github-actions · 2024-09-24T13:26:29Z

packages/core/src/systems.ts

    return unique(systems.filter((s) => !!s))
 }

+// Helper function to resolve tools in the project and return their system IDs
+// Finds systems in the project associated with a specific tool
 function resolveTools(prj: Project, tool: string): string[] {


There is no error handling for the case where the tool is not found in the project. Consider adding error handling to provide a more robust solution.

generated by pr-review-commit missing_error_handling

github-actions · 2024-09-24T13:26:55Z

The changes in the pull request primarily involve commenting the code for better understanding. It also includes minor code improvements such as:

The isGlobMatch function in glob.ts has been updated to accept an array of patterns. This change makes the function more flexible and reduces the need for multiple function calls when there are multiple patterns.
A check has been added in promptrunner.ts to ensure that 'changelog' systems are triggered based on both the fenced name and language. This is likely to improve the accuracy of system selection.
The resolveSystems function in systems.ts has been updated to handle edge cases more effectively.
Parsing improvements in toml.ts to improve error handling.
Adjustments in prompt_type.d.ts and prompt_template.d.ts to accept an array for file patterns, which adds flexibility to the input types for the defFileOutput function.

All these changes seem to improve the flexibility, readability and reliability of the code without introducing any apparent functional issues.

So, my response is: LGTM 🚀

generated by pr-review

…e files

github-actions · 2024-09-24T13:42:28Z

packages/core/src/chatrender.ts

@@ -28,20 +46,33 @@ export function renderMessageContent(
        | ChatCompletionToolMessageParam
 ): string {
    const content = msg.content


Missing semicolon

generated by pr-review-commit missing_semi

github-actions · 2024-09-24T13:42:29Z

packages/core/src/diff.ts

-                    throw new DiffError("invalid line number")
+                    throw new DiffError(
+                        `diff: invalid line number ${linei} in ${lines.length}`
+                    )
                lines[linei] = line
            }
        })


Missing semicolon

generated by pr-review-commit missing_semi

github-actions · 2024-09-24T13:42:30Z

packages/core/src/glob.ts

    })
-    return match
 }


Missing semicolon

generated by pr-review-commit missing_semi

… from git configuration

github-actions · 2024-09-24T13:51:00Z

packages/core/src/diff.ts

@@ -217,9 +217,12 @@ export function applyLLMPatch(source: string, chunks: Chunk[]): string {
                const line =
                    chunk.state === "deleted" ? undefined : chunk.lines[li]
                const linei = chunk.lineNumbers[li] - 1
-                if (isNaN(linei)) throw new DiffError("missing line number")
+                if (isNaN(linei))
+                    throw new DiffError(`diff: missing or nan line number`)
                if (linei < 0 || linei >= lines.length)


Missing error handling for potential failure of the minimatch function.

generated by pr-review-commit missing_error_handling

github-actions · 2024-09-24T13:51:01Z

packages/core/src/glob.ts

+export function isGlobMatch(filename: string, patterns: string | string[]) {
+    return arrayify(patterns).some((pattern) => {
+        const match = minimatch(filename, pattern, {
+            windowsPathsNoEscape: true,


Missing error handling for potential failure of the minimatch function.

generated by pr-review-commit missing_error_handling

github-actions · 2024-09-24T13:51:01Z

packages/core/src/runpromptcontext.ts

@@ -301,7 +300,11 @@ export function createChatGenerationContext(
        if (pattern)
            appendChild(


Missing error handling for potential failure of the arrayify function.

generated by pr-review-commit missing_error_handling

…e counting.py comments

…igurations

github-actions · 2024-09-24T14:19:26Z

docs/src/content/docs/reference/scripts/system.mdx

@@ -160,7 +160,7 @@ index N in the above snippets, and then be prefixed with exactly the same whites
 the original snippets above. See also the following examples of the expected response format.

 CHANGELOG:
-\`\`\`
+\`\`\`changelog


The changelog format has been changed from a generic code block to a specific 'changelog' code block, which may not be recognized by the rendering engine or may alter the intended presentation.

generated by pr-docs-review-commit invalid_changelog_format

github-actions · 2024-09-24T14:19:27Z

docs/src/content/docs/reference/vscode/samples/cmt.mdx

+
+## Full source ([GitHub](https://github.com/microsoft/genaiscript/blob/main/packages/vscode/genaisrc/cmt.genai.mts))
+
+<Code code={source} wrap={true} lang="ts" title="cmt.genai.mts" />


A new file 'cmt.mdx' has been added. Ensure that all new content is accurate, all links are working, and it is correctly integrated into the documentation structure.

generated by pr-docs-review-commit new_file

github-actions · 2024-09-24T14:20:16Z

docs/src/content/docs/reference/cli/run.mdx

@@ -34,7 +34,7 @@ See [configuration](/genaiscript/getting-started/configuration).

 ## Files

-`run` takes one or more [glob](https://en.wikipedia.org/wiki/Glob_(programming)) patterns to match files in the workspace.
+`run` takes one or more [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) patterns to match files in the workspace.


Incorrect link format, angle brackets should not be used in markdown links.

generated by pr-docs-review-commit link_format

github-actions · 2024-09-24T14:20:16Z

docs/src/content/docs/reference/cli/run.mdx

@@ -150,7 +150,7 @@ permissions:
    pull-requests: write
 ```

-  set the `GITHUB_TOKEN` secret in the `env` when running the cli
+-   set the `GITHUB_TOKEN` secret in the `env` when running the cli


Incorrect indentation, there should be no leading spaces before the bullet point.

generated by pr-docs-review-commit indentation

github-actions · 2024-09-24T14:20:17Z

docs/src/content/docs/reference/scripts/system.mdx

@@ -160,7 +160,7 @@ index N in the above snippets, and then be prefixed with exactly the same whites
 the original snippets above. See also the following examples of the expected response format.

 CHANGELOG:
-\`\`\`
+\`\`\`changelog


Missing language specifier for the code fence, it should specify the language for syntax highlighting.

generated by pr-docs-review-commit code_fence_lang

github-actions · 2024-09-24T14:20:18Z

docs/src/content/docs/reference/vscode/samples/cmt.mdx

+import { Code } from "@astrojs/starlight/components"
+import source from "../../../../../../../packages/vscode/genaisrc/cmt.genai.mts?raw"
+
+As developers, we understand the importance of well-commented code.


Missing URL for the hyperlink in the text "Inspired by [a tweet]".

generated by pr-docs-review-commit missing_link

pelikhan added 5 commits September 24, 2024 12:20

Add comments and logging improvements, enhance cache handling, and su…

0386d1e

…pport multiple glob patterns

Add comments for code clarity and update script configurations

d72a2b3

Improve comments and add validation for non-comment changes in chatca…

735d2f0

…che and documentor files

Enhance TOML parsing and refactor code with improved comment handling…

a8d5a4f

… and formatting

Refactor systems resolution and enhance comment generator script logic

6bdd6c9

github-actions bot reviewed Sep 24, 2024

View reviewed changes

Add comments, docstrings, and enhance code readability across multipl…

d54bdc9

…e files

github-actions bot reviewed Sep 24, 2024

View reviewed changes

packages/core/src/glob.ts

})

return match

}

Copy link

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

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

Missing semicolon

generated by pr-review-commit missing_semi

pelikhan added 2 commits September 24, 2024 13:47

Remove defaultBranch parameter and dynamically resolve default branch…

5791433

… from git configuration

Add header comment to cmt.genai.mts file

621c5a8

github-actions bot reviewed Sep 24, 2024

View reviewed changes

pelikhan added 2 commits September 24, 2024 14:18

Remove CLI run documentation, add VSCode commenter sample, and improv…

253d297

…e counting.py comments

Add documentation for running genai scripts with CLI options and conf…

06362e6

…igurations

github-actions bot reviewed Sep 24, 2024

View reviewed changes

Add Samples section and adjust paths in docs for better organization

8f0ee3d

pelikhan merged commit 938abb7 into main Sep 24, 2024
8 of 10 checks passed

pelikhan deleted the documentor branch September 24, 2024 14:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Commentor #723

Commentor #723

pelikhan commented Sep 24, 2024 •

edited by github-actions bot

Loading

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot commented Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

github-actions bot Sep 24, 2024

		@@ -301,7 +300,11 @@ export function createChatGenerationContext(
		if (pattern)
		appendChild(


		## Full source ([GitHub](https://github.com/microsoft/genaiscript/blob/main/packages/vscode/genaisrc/cmt.genai.mts))

		<Code code={source} wrap={true} lang="ts" title="cmt.genai.mts" />

Commentor #723

Commentor #723

Conversation

pelikhan commented Sep 24, 2024 • edited by github-actions bot Loading

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 24, 2024

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

github-actions bot Sep 24, 2024

Choose a reason for hiding this comment

pelikhan commented Sep 24, 2024 •

edited by github-actions bot

Loading