Weekly GitHub Report for CopilotKit - 2024-07-22 21:41:50
Weekly GitHub Report for CopilotKit
Thank you for subscribing to our weekly newsletter! Each week, we deliver a comprehensive summary of your GitHub project's latest activity right to your inbox, including an overview of your project's issues, pull requests, contributors, and commit activity.
I. Issues
1.1 Open Issues
Open Issues This Week: 2
Summarized Issues:
- Popup Positioning in
<CopilotTextarea>
: The action popup triggered byCMD + K
on Mac orCTRL + K
on Windows within the<CopilotTextarea>
component leaves the screen boundaries if it is too close to the edge of the window. This issue causes the popup to be partially or completely invisible to the user. It is expected that the popup should auto-adjust to remain fully visible within the screen boundaries with some padding for aesthetics.
- Message History Overwrite in
useCopilotChat
: TheappendMessage
function of theuseCopilotChat
hook overwrites the entire message history with a single new message instead of appending it. This bug also causes a loss of certain capabilities when switching routes. Users expect the function to properly append new messages to the existing history without any data loss.
1.2 Top 5 Active Issues:
We consider active issues to be issues that have generated much discussion in the issue's comments.
-
ESM Compatibility Issue with nanoid in Internal Dependency: This issue describes an ESM compatibility problem when integrating CopilotKit into a Next.js project, caused by the use of
require('nanoid')
within CopilotKit's internal dependencies, which conflicts with the ESM import system used in modern Next.js setups. The proposed solution is to update the internal dependency to use ESM-style imports instead, aligning CopilotKit with modern JavaScript/TypeScript practices.- The initial report details the issue and suggests a solution, followed by a request for more information about the user's setup. The user provides details about their environment, and another user mentions a similar issue in a different setup. A workaround involving dynamic imports is suggested, and a potential fix is released in a new version of CopilotKit. The original reporter plans to test the new version and the suggested workaround.
- Number of comments: 9
-
Packaging issue? import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose": This issue describes a bug where the user cannot install a package into a Remix.run project with Node.js 21 due to a syntax error related to the MUI library. The error occurs because the import statement is used outside of a module, causing a SyntaxError during the build process.
- The comments include acknowledgments of the bug, multiple users confirming the same issue, and a developer stating they are working on it. A pre-release package is provided as a fix, and users confirm that the pre-release resolves the issue.
- Number of comments: 8
-
Support bold and italicized text in CopilotTextarea: This issue proposes adding support for bold and italicized text in the CopilotTextarea component, which utilizes slate-js. The initial implementation will focus on programmatic support, with UI support to be addressed in a separate issue.
- Multiple users expressed interest in working on the feature, with one user receiving encouragement and support from a maintainer to submit a pull request early to ensure alignment. Another user also volunteered to take on the task if it was not already being handled, and the maintainer welcomed their participation and offered support.
- Number of comments: 5
-
How to use with node-llama-cpp for backend: This issue is about adding documentation to demonstrate how to use the
node-llama-cpp
library with theCopilotKit
backend, including installation steps and relevant code examples. The issue also discusses where this documentation would fit within the existing documentation structure.- The comments discuss the initial appreciation for the provided solution, followed by concerns about the functionality of the
LlamaCpp
model with tools. Suggestions are made to empirically test the code and to consider creating ready-made adapter factories. There is also an offer to collaborate on the implementation, and a final comment suggests adding the code to the langchain documentation. - Number of comments: 5
- The comments discuss the initial appreciation for the provided solution, followed by concerns about the functionality of the
-
Styles from Copilotkit Overriding MUI and Shadcn Styles: This issue involves styles from Copilotkit overriding the styles of MUI and Shadcn components due to the base classes exported in Copilotkit's
styles.css
file. The problem is demonstrated in a CodeSandbox link, where the styles of a Shadcn Alert Dialog component's confirm button are being overridden by Copilotkit's styles.- The comments discuss the issue, with one user suggesting prefixing Copilotkit's Tailwind classnames to avoid conflicts. Another user thanks them for the suggestion, and a final comment confirms that the issue should be fixed in the latest release by implementing the prefixing solution, asking for confirmation if the issue is resolved.
- Number of comments: 5
1.3 Top 5 Quiet Issues:
We consider quiet issues to be issues that have been opened in this project for the longest time. The team should work together to get these issues resolved and closed as soon as possible.
-
Support bold and italicized text in CopilotTextarea: This issue is about adding support for bold and italicized text in the CopilotTextarea component, which utilizes the slate-js library. The implementation will involve modifications to several files, including
render-element.tsx
,base-copilot-textarea.tsx
, and potentiallycustom-editor.tsx
.- Open for 263 days, 05 hours, 25 minutes
-
Add headless UI entrypoints for marking text as bold/italicized: This issue involves creating headless UI entry points for marking text as bold or italicized in the
CopilotTextarea
component, which will be supported once issue #62 is implemented. The implementation should follow common patterns from the slate-js library.- Open for 263 days, 05 hours, 21 minutes
-
Pre-populate CopilotTextarea contents: This issue involves a proposal to enable the pre-population of the CopilotTextarea with a specified prompt. The goal is to allow users to define initial content for the textarea, enhancing the user experience by providing a starting point for interaction.
- Open for 263 days, 04 hours, 57 minutes
-
CopilotTextarea Documentation: This issue is about creating documentation for the CopilotTextarea feature, specifically detailing how to use it effectively. It includes instructions for integrating with
useMakeCopilotReadable
,useMakeCopilotDocumentReadable
, and custom system prompts.- Open for 259 days, 00 hours, 58 minutes
-
CopilotTextarea: auto-populate button: This issue is a feature request for adding a button that auto-populates the textarea in the CopilotTextarea component, similar to the functionality seen in LinkedIn messages. The proposed solution includes a simple button to pre-fill the textarea contents, with future iterations potentially featuring an editable prompt bar for content generation.
- Open for 259 days, 00 hours, 46 minutes
1.4 Closed Issues
Closed Issues This Week: 2
Average Issue Close Time (This Week): 1.83 days
Summarized Issues:
- Functionality Issues in CopilotKit Library: The
appendMessage
function in theuseCopilotChat
hook throws an "Unknown Message type" error, which prevents it from working as intended. This issue arises despite following the documentation, indicating a potential bug in the implementation. Additionally, there is a request to allow the use ofawait
on theonSubmitMessage
function to enable context manipulation before invoking the Copilot, suggesting changes to method signatures.
1.5 Issue Discussion Insights
This section will analyze the tone and sentiment of discussions within this project's open issues within the past week to identify potentially heated exchanges and to maintain a constructive project environment.
Based on our analysis, there are no instances of toxic discussions in the project's open issues from the past week.
II. Pull Requests
2.1 Open Pull Requests
Open Pull Requests This Week: 4
Pull Requests:
- New Features in Runtime: This topic covers the introduction of new features to the runtime, specifically enabling remote actions. The pull request titled "feat(runtime): remote actions" details the implementation of this feature. It aims to enhance the functionality of the runtime by allowing actions to be performed remotely.
- Documentation Corrections: This topic addresses the correction of errors in the documentation of the CopilotKit project. The pull request focuses on improving the accuracy and clarity of the documentation. It ensures that users have access to correct and up-to-date information.
- New Hook in React-UI: This topic introduces a new hook named
useHighlightToAsk
in thereact-ui
package. The pull request enables users to highlight text and ask questions to the CopilotKit chatbot. This feature aims to improve user interaction and accessibility within the application.
- Security Enhancements: This topic focuses on enhancing the security of the CopilotKit project by adding credentials to all requests. The pull request ensures that all requests are authenticated, thereby increasing the overall security of the application. This measure is crucial for protecting sensitive data and maintaining user trust.
2.2 Closed Pull Requests
Closed Pull Requests This Week: 17
Summarized Pull Requests:
- Async
onSubmitMessage
Function: Multiple pull requests focused on making theonSubmitMessage
function asynchronous. This involved updating its prop type to handle both synchronous and asynchronous callbacks. Additionally, the function's signature was modified to return a promise, and its invocation was updated to useawait
.
- Console Log Removal: Several pull requests aimed at removing redundant console logs from the CopilotKit project. This included a specific fix in the shared component and a broader cleanup in a new release version.
- Documentation Updates: Multiple pull requests were dedicated to updating and correcting the documentation for the CopilotKit project. This included refreshing several pages, adding new ones, and correcting errors.
- Version Releases: Several pull requests were related to the release of new versions of the CopilotKit project. These releases included various fixes and improvements, such as removing redundant console logs and other enhancements.
- Monorepo Enhancements: A couple of pull requests focused on improving the monorepo structure and utilities. This included splitting utilities from published packages and introducing new commands for global linking and unlinking of packages.
- Console Improvements: Multiple pull requests aimed at enhancing the development console for the CopilotKit project. This included improving the console's CSS and overall functionality.
- Bug Fixes: Several pull requests addressed various bugs in the CopilotKit project. These included fixes for the textarea component and updates to the TypeScript configuration for example applications.
- Hardcoding Initial Image: One pull request involved hardcoding the initial image in the CopilotKit project.
- Pre-release Section Update: One pull request addressed the issue of not displaying expired versions in the pre-release section of the CopilotKit project.
2.3 Pull Request Discussion Insights
This section will analyze the tone and sentiment of discussions within this project's open pull requests within the past week to identify potentially heated exchanges and to maintain a constructive project environment.
Based on our analysis, there are no instances of toxic discussions in the project's open pull requests from the past week.
III. Commits
3.1 Commits
Commits This Week: 46
Summarized Commits:
- TypeScript Configuration Fixes: The project addressed and fixed issues related to TypeScript configuration extensions in example applications, ensuring proper setup and functionality across the monorepo.
- Documentation Updates: The documentation was refreshed, including updates to the contribution guide and README.md file, to provide clearer instructions and guidelines for contributors.
- Utility Functions Separation: A new feature was introduced by separating utility functions from the published packages, enhancing modularity and maintainability of the codebase.
- Global Turbo Commands: The repository added global link and unlink turbo commands, streamlining the process of managing dependencies and improving developer workflow.
- Console CSS Improvements: The console's CSS styling was enhanced to improve the visual appearance and user experience, including specific changes to ensure the popup remains visible when interacting with the dev menu.
- Version Releases: The project marked the release of versions 1.0.8 and 1.0.9, indicating significant updates and improvements to the software.
- Issue and Bug Report Templates: The repository saw multiple updates to its issue and bug report templates, standardizing the format for reporting issues and improving the process of tracking and managing bugs.
- Feature Request Form: A new feature request form was introduced, enhancing the project's ability to gather and manage user suggestions systematically.
- Quick Bug Fixes: Several commits addressed minor issues by implementing quick fixes, such as ensuring the
onSubmitMessage
function properly awaits and fixing bugs related to the textarea component.
- Hardcoded Presentation Image: An initial image was hardcoded into the project to ensure a default visual element is present, likely for presentation purposes.
- Console Log Removal: A console log was removed from the shared component, addressing a specific issue to clean up the codebase.
- Langchain Documentation Update: The documentation for Langchain was specifically updated, ensuring that the information is current and accurate.
- Development Console Enhancements: The development console was updated to ensure that expired versions are not displayed in the pre-release section, improving the accuracy of version information.
- Configuration File Updates: The
config.yml
file within the ISSUE_TEMPLATE directory was updated to improve issue tracking and management, reflecting ongoing maintenance and housekeeping tasks.
- Await Function Fix: The
onSubmitMessage
function was ensured to properly await, allowing for necessary context manipulation before making a call to Copilot, enhancing the functionality and reliability of the feature.
IV. Contributors
4.1 Contributors
Active Contributors:
We consider an active contributor in this project to be any contributor who has made at least 1 commit, opened at least 1 issue, or created at least 1 pull request in the past month.
Contributor | Commits | Pull Requests | Issues |
---|---|---|---|
GitHub | 102 | 0 | 0 |
arielweinberger | 0 | 40 | 3 |
mme | 0 | 35 | 1 |
Ariel Weinberger | 32 | 0 | 0 |
Markus Ecker | 25 | 0 | 0 |
Atai Barkai | 3 | 0 | 0 |
Steve-04 | 1 | 1 | 0 |
ataibarkai | 0 | 2 | 0 |
aldrinjenson | 0 | 0 | 2 |
Nitingirlsavenue1 | 0 | 0 | 2 |
alsong | 0 | 1 | 0 |
vedpatwardhan | 0 | 1 | 0 |
eltociear | 0 | 1 | 0 |
Princeyadav05 | 0 | 1 | 0 |
codingfarhan | 0 | 1 | 0 |
Myahr208 | 0 | 0 | 1 |
zanderlewis | 0 | 0 | 1 |
balloondogcaps | 0 | 0 | 1 |
ramonmalcolm10 | 0 | 0 | 1 |