gai and sc docus #738

pelikhan · 2024-09-30T16:15:03Z

This pull request fixes an artificial error that was introduced in the code.

…ecker script

github-actions · 2024-09-30T16:27:14Z

packages/core/src/glob.ts

+export function isGlobMatch(
+    filename: string,
+    patterns: ElementOrArray<string>
+) {


Missing type annotation for function parameters. It's a good practice to always specify types for function parameters for better readability and maintainability. 📚

generated by pr-review-commit missing_type_annotation

github-actions · 2024-09-30T16:27:15Z

packages/core/src/runpromptcontext.ts

+                    endsWith.length &&
+                    !endsWith.some((ext) => filename.endsWith(ext))
+                )
+                    return undefined


The condition in the if statement is complex and hard to understand. Consider simplifying it or breaking it down into smaller, more understandable conditions. This will improve code readability and maintainability. 🧐

generated by pr-review-commit complex_condition

github-actions · 2024-09-30T16:27:16Z

packages/core/src/types/prompt_template.d.ts


    /**
     * Filename filter using glob syntax.
     */
-    glob?: string
+    glob?: ElementOrArray<string>


The type of 'endsWith' and 'glob' has been changed from 'string' to 'ElementOrArray'. Make sure that this change is reflected everywhere these properties are used to avoid runtime errors. Also, ensure that the consuming code is updated to handle the new type. 🔄

generated by pr-review-commit type_change

…nstructions

github-actions · 2024-09-30T16:30:03Z

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

@@ -9,10 +9,10 @@ import { Code } from "@astrojs/starlight/components"
 import source from "../../../../../packages/vscode/genaisrc/cmt.genai.mts?raw"

 This sample automates adding comments to source code using an LLM
-and validate the changes haven't introduce any code modifications.
+and validates the changes haven't introduced any code modifications.


Incorrect verb form used; should be "validates" instead of "validate".

generated by pr-docs-review-commit grammar

github-actions · 2024-09-30T16:30:04Z

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


 To do so, we could use a combination of tools to validate the transformer: source formatters,
-compilers, linters or LLM-as-judge.
+compilers, linters, or LLM-as-judge.


Missing comma before "or" in a list of items.

generated by pr-docs-review-commit grammar

github-actions · 2024-09-30T16:30:05Z

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

@@ -45,8 +45,7 @@ if (files.length === 0)

 ### Processing Each File

-We process each file separately, to avoid exploding the token context and keep the AI focused.
-We can use [inline prompts](/genaiscript/reference/scripts/inline-prompts) to make inner queries.
+We process each file separately to avoid exploding the token context and keep the AI focused. We can use [inline prompts](/genaiscript/reference/scripts/inline-prompts) to make inner queries.


The content has been merged into a single paragraph; consider if this changes the intended emphasis or readability.

generated by pr-docs-review-commit content_structure

github-actions · 2024-09-30T16:30:06Z

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

@@ -73,12 +72,11 @@ const res = await runPrompt(
 )
 ```

-We provide a detailed set of instructions to the AI for how to analyze and comment on the code.
+We provide a detailed set of instructions to the AI on how to analyze and comment on the code.


Incorrect preposition used; should be "on how to analyze" instead of "for how to analyze".

generated by pr-docs-review-commit grammar

github-actions · 2024-09-30T16:30:07Z

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


 ### Format, build, lint

-At this point, we have a modified source code by an LLM. We should try to use all the available tools to validate the changes.
-It is best to start with like formatters and compilers as they are deterministic and typically fast.
+At this point, we have a modified source code by an LLM. We should try to use all the available tools to validate the changes. It is best to start with formatters and compilers as they are deterministic and typically fast.


The content has been merged into a single paragraph; consider if this changes the intended emphasis or readability.

generated by pr-docs-review-commit content_structure

github-actions · 2024-09-30T16:30:07Z

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

@@ -115,7 +113,7 @@ genaiscript run cmt

 ## Format and build

-One important aspect is to normalize and valid the AI generated code. The user can provide a `format` command to run a formatter
+One important aspect is to normalize and validate the AI-generated code. The user can provide a `format` command to run a formatter


Incorrect verb form used; should be "validate" instead of "valid". Also, "AI-generated" should be hyphenated.

generated by pr-docs-review-commit grammar

…and update dependencies

docs/src/content/docs/reference/cli/commands.md

github-actions · 2024-09-30T16:45:37Z

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

@@ -45,8 +45,7 @@ if (files.length === 0)

 ### Processing Each File

-We process each file separately, to avoid exploding the token context and keep the AI focused.
-We can use [inline prompts](/genaiscript/reference/scripts/inline-prompts) to make inner queries.
+We process each file separately to avoid exploding the token context and keep the AI focused. We can use [inline prompts](/genaiscript/reference/scripts/inline-prompts) to make inner queries.


The content in lines 47-48 is redundant and can be combined into a single sentence.

generated by pr-docs-review-commit content_redundancy

github-actions · 2024-09-30T16:45:38Z

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


 ### Format, build, lint

-At this point, we have a modified source code by an LLM. We should try to use all the available tools to validate the changes.
-It is best to start with like formatters and compilers as they are deterministic and typically fast.
+At this point, we have a modified source code by an LLM. We should try to use all the available tools to validate the changes. It is best to start with formatters and compilers as they are deterministic and typically fast.


The content in lines 78-79 is redundant and can be combined into a single sentence.

generated by pr-docs-review-commit content_redundancy

github-actions · 2024-09-30T16:45:51Z

packages/cli/src/run.ts

+
+    const res = Array.from(resolvedFiles)
+    return res
+}


The function resolveFiles does not handle errors that may occur during the execution of asynchronous operations. This could lead to unhandled promise rejections.

generated by pr-review-commit missing_error_handling

packages/cli/src/run.ts

github-actions · 2024-09-30T16:45:52Z

packages/core/src/runpromptcontext.ts

+                    endsWith.length &&
+                    !endsWith.some((ext) => filename.endsWith(ext))
+                )
+                    return undefined


The logic for checking if a filename ends with any of the provided extensions could lead to incorrect results. The endsWith array is checked for length, but not if it actually contains any valid extensions.

generated by pr-review-commit logic_error

github-actions · 2024-09-30T18:23:48Z

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

@@ -45,8 +45,7 @@ if (files.length === 0)

 ### Processing Each File

-We process each file separately, to avoid exploding the token context and keep the AI focused.
-We can use [inline prompts](/genaiscript/reference/scripts/inline-prompts) to make inner queries.
+We process each file separately to avoid exploding the token context and keep the AI focused. We can use [inline prompts](/genaiscript/reference/scripts/inline-prompts) to make inner queries.


Merged sentences should be separated for clarity.

generated by pr-docs-review-commit style

github-actions · 2024-09-30T18:23:49Z

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


 ### Format, build, lint

-At this point, we have a modified source code by an LLM. We should try to use all the available tools to validate the changes.
-It is best to start with like formatters and compilers as they are deterministic and typically fast.
+At this point, we have a modified source code by an LLM. We should try to use all the available tools to validate the changes. It is best to start with formatters and compilers as they are deterministic and typically fast.


Merged sentences should be separated for clarity.

generated by pr-docs-review-commit style

github-actions · 2024-09-30T18:25:08Z

packages/cli/src/nodehost.ts

@@ -39,7 +39,7 @@ import {
    ResponseStatus,
 } from "../../core/src/host"
 import { AbortSignalOptions, TraceOptions } from "../../core/src/trace"
-import { logVerbose, unique } from "../../core/src/util"
+import { logVerbose } from "../../core/src/util"


The import of 'unique' from "../../core/src/util" has been removed, but it's replaced with 'uniq' from "es-toolkit". Make sure that 'uniq' function from "es-toolkit" behaves exactly the same as 'unique' function from "../../core/src/util". 🧐

generated by pr-review-commit import_change

github-actions · 2024-09-30T18:25:09Z

packages/core/src/runpromptcontext.ts

+                    endsWith.length &&
+                    !endsWith.some((ext) => filename.endsWith(ext))
+                )
+                    return undefined


The logic for handling 'endsWith' in 'defOptions' has been changed from a string to an array. This could potentially break existing code if it's expecting a string instead of an array. Please ensure that all usages of 'endsWith' are updated to handle an array. 😊

generated by pr-review-commit logic_change

github-actions · 2024-09-30T18:25:09Z

packages/core/src/types/prompt_template.d.ts

@@ -737,12 +737,12 @@ interface DefOptions extends FenceOptions, ContextExpansionOptions, DataFilter {
    /**
     * Filename filter based on file suffix. Case insensitive.
     */
-    endsWith?: string
+    endsWith?: ElementOrArray<string>


The type of 'endsWith' in 'DefOptions' interface has been changed from 'string' to 'ElementOrArray'. This could potentially break existing code if it's expecting a string instead of an array. Please ensure that all usages of 'endsWith' are updated to handle an array. 😊

generated by pr-review-commit type_change

github-actions · 2024-09-30T18:31:54Z

Investigator report

run failure

, bd4ac32

It appears there was an issue with the TypeScript compilation process.

Root Cause Analysis

The failure is due to a TypeScript error in the file genaisrc/poem.genai.mts, specifically an "Unterminated template literal" error at line 2, column 1.

Error Message

##[error]genaisrc/poem.genai.mts(2,1): error TS1160: Unterminated template literal.

Suggested Fix

You will need to check genaisrc/poem.genai.mts to ensure all template literals (i.e., strings wrapped with backticks) are properly terminated.

Diff Suggestion

Ensure the template literals in your TypeScript file are properly closed. Here's a hypothetical fix:

- const poem = `This is a poem
- that needs closing
+ const poem = `This is a poem
+ that needs closing`

Review and update genaisrc/poem.genai.mts accordingly.

generated by gai

…tions

github-actions · 2024-09-30T18:53:36Z

packages/core/src/runpromptcontext.ts

@@ -313,15 +318,17 @@ export function createChatGenerationContext(
    }

    const defFileOutput = (
-        pattern: string,
+        pattern: ElementOrArray<string | WorkspaceFile>,
        description: string,
        options?: FileOutputOptions
    ): void => {
        if (pattern)
            appendChild(


The 'pattern' parameter type has been changed from 'string' to 'ElementOrArray<string | WorkspaceFile>'. Ensure that all calls to 'defFileOutput' function are updated to pass the correct type.

generated by pr-review-commit pattern_change

…og integration

github-actions · 2024-09-30T19:14:02Z

packages/core/src/runpromptcontext.ts

@@ -313,15 +318,17 @@ export function createChatGenerationContext(
    }

    const defFileOutput = (
-        pattern: string,
+        pattern: ElementOrArray<string | WorkspaceFile>,
        description: string,
        options?: FileOutputOptions
    ): void => {
        if (pattern)
            appendChild(


The type of 'pattern' in 'defFileOutput' function has been changed from 'string' to 'ElementOrArray<string | WorkspaceFile>'. Ensure that all usages of this function have been updated to reflect this change.

generated by pr-review-commit pattern_type_change

github-actions · 2024-09-30T19:14:25Z

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

@@ -45,8 +45,7 @@ if (files.length === 0)

 ### Processing Each File



The phrase "We process each file separately, to avoid exploding the token context and keep the AI focused." should be "We process each file separately to avoid exploding the token context and keep the AI focused."

generated by pr-docs-review-commit grammar

…efine documentation

github-actions · 2024-09-30T19:19:25Z

docs/src/content/docs/samples/gai.mdx

+import source from "../../../../../packages/sample/genaisrc/gai.genai.mts?raw"
+import gasource from "../../../../../.github/workflows/genai-investigator.yml?raw"
+
+This is an in-depth guide to build a script that interactively investigates GitHub Actions failures.


New file created: docs/src/content/docs/samples/gai.mdx.

generated by pr-docs-review-commit new_file

github-actions · 2024-09-30T19:19:26Z

docs/src/content/docs/samples/sc.mdx

+import { Code } from "@astrojs/starlight/components"
+import source from "../../../../../packages/sample/genaisrc/sc.genai.mts?raw"
+
+Automating and improving the efficiency of proofreading documents is a common need among developers and writers. This script addresses this need by checking and correcting spelling and grammar in Markdown files.


New file created: docs/src/content/docs/samples/sc.mdx.

generated by pr-docs-review-commit new_file

pelikhan added 2 commits September 30, 2024 16:14

artificial error

2470723

Add GitHub Action guide, enhance filename filtering, and add spell ch…

8c690fb

…ecker script

github-actions bot reviewed Sep 30, 2024

View reviewed changes

Fix grammar and punctuation in documentation and refine AI analysis i…

fb0b0a0

…nstructions

github-actions bot reviewed Sep 30, 2024

View reviewed changes

Add file chunk size option, replace unique with uniq from es-toolkit …

c3cf3d1

…and update dependencies

github-actions bot reviewed Sep 30, 2024

View reviewed changes

docs/src/content/docs/reference/cli/commands.md Outdated Show resolved Hide resolved

github-actions bot reviewed Sep 30, 2024

View reviewed changes

packages/cli/src/run.ts Outdated Show resolved Hide resolved

github-actions bot reviewed Sep 30, 2024

View reviewed changes

revert file chunks

5c2a2dd

github-actions bot reviewed Sep 30, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into gai-docs

bd4ac32

pelikhan added 2 commits September 30, 2024 18:36

Merge remote-tracking branch 'origin/main' into gai-docs

6ee9e18

Update CLI docs, improve spell checker script, and modify type defini…

b08274e

…tions

github-actions bot reviewed Sep 30, 2024

View reviewed changes

Update spell checker script and documentation for clarity and changel…

aa367e9

…og integration

github-actions bot reviewed Sep 30, 2024

View reviewed changes

pelikhan added 2 commits September 30, 2024 19:18

Update script to fetch staged Markdown files for spell-checking and r…

08d672e

…efine documentation

Fix syntax error by adding closing backtick in poem.genai.mts

4951614

pelikhan merged commit 306a5a6 into main Sep 30, 2024
6 of 8 checks passed

pelikhan deleted the gai-docs branch September 30, 2024 19:19

github-actions bot reviewed Sep 30, 2024

View reviewed changes

pelikhan changed the title ~~Fix artificial error~~ gai and sc docus Sep 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gai and sc docus #738

gai and sc docus #738

pelikhan commented Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot commented Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

github-actions bot Sep 30, 2024

		@@ -45,8 +45,7 @@ if (files.length === 0)

		### Processing Each File

gai and sc docus #738

gai and sc docus #738

Conversation

pelikhan commented Sep 30, 2024

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 30, 2024

Investigator report

Root Cause Analysis

Error Message

Suggested Fix

Diff Suggestion

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment

github-actions bot Sep 30, 2024

Choose a reason for hiding this comment