Skip to content
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

feat: add read only marker and read only mode #1899

Merged
merged 1 commit into from
Feb 4, 2025

Conversation

oneirocosm
Copy link
Member

No description provided.

Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Walkthrough

The changes add a new fileinfo property of type FileInfo to the CodeEditorProps interface and update the CodeEditor component to utilize this property. Within the component’s memoized options, the editor now sets its read-only mode based on the value of fileinfo.readonly. In addition, the CodeEditPreview function in the preview module has been modified to derive a fileInfo variable (sourced from the statFile atom) which is then passed to the CodeEditor as the fileinfo prop. The preview logic now includes conditional rendering: it displays a "Loading ..." button when file data isn’t fully loaded, a "Read Only" button when the file is flagged as read-only, and a "Save" button only when the file is editable.

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
frontend/app/view/preview/preview.tsx (1)

262-290: LGTM! Consider extracting button styles to a shared constant.

The conditional rendering for buttons is well-implemented, providing clear visual feedback for different file states. However, the button styles are duplicated across conditions.

Consider extracting the common button styles to a shared constant:

+const BUTTON_BASE_STYLES = "warning border-radius-4 vertical-padding-2 horizontal-padding-10 font-size-11 font-weight-500";
+
 if (fileInfo.state != "hasData") {
     viewTextChildren.push({
         elemtype: "textbutton",
         text: "Loading ...",
-        className: clsx(
-            `grey warning border-radius-4 vertical-padding-2 horizontal-padding-10 font-size-11 font-weight-500`
-        ),
+        className: clsx(`grey ${BUTTON_BASE_STYLES}`),
         onClick: () => {},
     });
 } else if (fileInfo.data.readonly) {
     viewTextChildren.push({
         elemtype: "textbutton",
         text: "Read Only",
-        className: clsx(
-            `yellow warning border-radius-4 vertical-padding-2 horizontal-padding-10 font-size-11 font-weight-500`
-        ),
+        className: clsx(`yellow ${BUTTON_BASE_STYLES}`),
         onClick: () => {},
     });
 } else {
     viewTextChildren.push({
         elemtype: "textbutton",
         text: "Save",
-        className: clsx(
-            `${saveClassName} warning border-radius-4 vertical-padding-2 horizontal-padding-10 font-size-11 font-weight-500`
-        ),
+        className: clsx(`${saveClassName} ${BUTTON_BASE_STYLES}`),
         onClick: () => fireAndForget(this.handleFileSave.bind(this)),
     });
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d7a9006 and fda6cbb.

📒 Files selected for processing (2)
  • frontend/app/view/codeeditor/codeeditor.tsx (2 hunks)
  • frontend/app/view/preview/preview.tsx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (go)
  • GitHub Check: Build for TestDriver.ai
🔇 Additional comments (5)
frontend/app/view/codeeditor/codeeditor.tsx (3)

122-122: LGTM!

The function signature is correctly updated to include the fileinfo parameter, maintaining consistency with the interface.


179-179: LGTM!

The dependency array is correctly updated to include fileinfo.readonly, ensuring that the editor options are recalculated when the read-only status changes.


115-115: Verify the missing import for FileInfo type.

The FileInfo type is used but not imported. Please ensure that the type is properly imported from its source module.

Run the following script to locate the FileInfo type definition:

frontend/app/view/preview/preview.tsx (2)

958-958: LGTM!

The fileInfo variable is correctly retrieved using the useAtomValue hook from the statFile atom.


1010-1010: LGTM!

The fileinfo prop is correctly passed to the CodeEditor component with the retrieved file info.

@@ -169,12 +170,13 @@ export function CodeEditor({ blockId, text, language, filename, meta, onChange,

const editorOpts = useMemo(() => {
const opts = defaultEditorOptions();
opts.readOnly = fileinfo.readonly;
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Issue Found: readonly Property Missing on FileInfo Type
Our search indicates that the FileInfo type defined in ./frontend/types/gotypes.d.ts does not include a readonly property, yet it is being accessed in frontend/app/view/codeeditor/codeeditor.tsx (line 173).

  • The only properties in the FileInfo type are path, dir, name, notfound, and opts.
  • This discrepancy can lead to potential runtime errors when setting opts.readOnly based on fileinfo.readonly.

Please update the FileInfo type definition to include the readonly: boolean property if that information is expected to be available at runtime.

🔗 Analysis chain

Verify the existence of readonly property on FileInfo type.

Please ensure that the readonly property exists on the FileInfo type to prevent potential runtime errors.

Run the following script to verify the property:


I'm going to re-run a search that checks for FileInfo definitions including the "readonly" property in their context. This will help ensure that we manually verify the existence (or absence) of the property.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for readonly property in FileInfo type/interface.

# Test: Search for readonly property in FileInfo type
ast-grep --pattern 'type FileInfo = {
  $$$
  readonly: boolean
  $$$
}'

# Test: Search for readonly property in FileInfo interface
ast-grep --pattern 'interface FileInfo {
  $$$
  readonly: boolean
  $$$
}'

Length of output: 152


Script:

#!/bin/bash
# Search for FileInfo definitions and include several lines of context to capture the "readonly" property.
echo "Searching FileInfo interface definitions with context:"
rg -n "interface FileInfo" --context 5 .

echo "Searching FileInfo type definitions with context:"
rg -n "type FileInfo" --context 5 .

Length of output: 1974

@oneirocosm oneirocosm merged commit 6bcf65d into main Feb 4, 2025
8 checks passed
@oneirocosm oneirocosm deleted the sylvie/readonly-editor branch February 4, 2025 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant