Skip to content

Conversation

@ara2105
Copy link

@ara2105 ara2105 commented Dec 26, 2025

Fixes #18

Here is the Zplit app design - https://www.figma.com/design/MzAfV4ex1zItWjsOu4Tk5I/Zplit---Aradhya?t=SvChlLcttDv30Swo-1

Created a new folder and added the .fig file for the same.

Summary by CodeRabbit

  • Documentation

    • Added documentation for extension discovery cache configuration and behavior.
  • Chores

    • Added extension discovery manifest file for development tooling support.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Dec 26, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Introduces extension discovery infrastructure for the Zplit package by adding two new files to .dart_tool/extension_discovery: a README documenting the purpose and behavior of the extension discovery cache, and a VS Code manifest file registering the Zplit package as an extension.

Changes

Cohort / File(s) Summary
Extension Discovery Configuration
.dart_tool/extension_discovery/README.md, .dart_tool/extension_discovery/vs_code.json
Added extension discovery infrastructure: README explains cache behavior, versioning, and constraints; VS Code manifest registers Zplit package with root URI and package URI mappings.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A cache of extensions appears in the tooling drawer,
Where Zplit hops into VS Code's marketplace floor,
No need to mutate, just read the README sign,
This discovery magic makes packages align! ✨

Pre-merge checks and finishing touches

❌ Failed checks (3 warnings)
Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title claims to add a Figma design file, but the actual changes are .dart_tool configuration files (README.md and vs_code.json) for extension discovery, which are unrelated to design files. Update the PR title to accurately describe the actual changes: adding extension discovery configuration files, or ensure the PR contains the intended design file changes.
Linked Issues check ⚠️ Warning Issue #18 requests design refinement discussions and iterative feedback, but the PR only adds .dart_tool configuration files with no design content, failing to address the issue's coding requirements. Include the actual Figma design file (.fig) or design documentation in the PR to address the design refinement objective stated in issue #18.
Out of Scope Changes check ⚠️ Warning The PR adds .dart_tool/extension_discovery configuration files which appear unrelated to the stated objective of adding app design files for issue #18. Remove out-of-scope .dart_tool changes or clarify their relationship to the design refinement objective and ensure design files are included.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@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: 3

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a490608 and cc9cfa9.

📒 Files selected for processing (3)
  • .dart_tool/extension_discovery/README.md
  • .dart_tool/extension_discovery/vs_code.json
  • design/Zplit - Aradhya.fig
🧰 Additional context used
🪛 LanguageTool
.dart_tool/extension_discovery/README.md

[style] ~23-~23: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...o access information from this folder. Feel free to delete this folder --------------------...

(FEEL_FREE_TO_STYLE_ME)

🪛 markdownlint-cli2 (0.18.1)
.dart_tool/extension_discovery/README.md

10-10: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)


11-11: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

Comment on lines 10 to 11
* Do not read (or rely) the contents of this folder.
* Do write to this folder.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix list indentation in Markdown.

The unordered list items at lines 10–11 have incorrect indentation (1 space instead of 0). This violates Markdown best practices and may cause rendering issues in some parsers.

🔎 Proposed fix
-DO NOT USE THIS FOLDER
+DO NOT USE THIS FOLDER
-----------------------
 
- * Do not read (or rely) the contents of this folder.
- * Do write to this folder.
+* Do not read (or rely) the contents of this folder.
+* Do NOT write to this folder.

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

10-10: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)


11-11: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

🤖 Prompt for AI Agents
In .dart_tool/extension_discovery/README.md around lines 10 to 11 the unordered
list items are indented with one extra leading space; remove the leading space
so each bullet asterisk begins at column 0 (no indentation) to correct the
Markdown list indentation and ensure consistent rendering.

----------------------

* Do not read (or rely) the contents of this folder.
* Do write to this folder.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Clarify the intent: line 11 should say "Do NOT write."

Line 11 currently reads "Do write to this folder" but given the section heading "DO NOT USE THIS FOLDER" and the surrounding documentation, this appears to be a typo. It should state "Do NOT write to this folder" to be consistent with the stated purpose (the cache is managed by the extension_discovery system, not by users).

The proposed fix above addresses both the indentation and this clarification.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

11-11: Unordered list indentation
Expected: 0; Actual: 1

(MD007, ul-indent)

🤖 Prompt for AI Agents
In .dart_tool/extension_discovery/README.md around line 11, the sentence "Do
write to this folder" contradicts the section heading and should be corrected to
"Do NOT write to this folder"; update that line to the negated form and fix
indentation if needed so it matches surrounding formatting and the intent that
the folder is managed by extension_discovery and should not be manually written
to.

@@ -0,0 +1 @@
{"version":2,"entries":[{"package":"zplit","rootUri":"../","packageUri":"lib/"}]} No newline at end of file
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if .dart_tool is in .gitignore
if [ -f .gitignore ]; then
  echo "=== Checking .gitignore for .dart_tool ==="
  grep -n "\.dart_tool" .gitignore || echo ".dart_tool NOT found in .gitignore"
else
  echo ".gitignore file not found"
fi

# List what's currently being tracked in .dart_tool
echo -e "\n=== Files tracked in .dart_tool ==="
git ls-files .dart_tool/ 2>/dev/null || echo "No files tracked in .dart_tool"

# Also check the directory structure
echo -e "\n=== .dart_tool directory structure ==="
ls -la .dart_tool/ 2>/dev/null | head -20 || echo ".dart_tool directory does not exist in working directory"

Repository: StabilityNexus/Zplit

Length of output: 868


Remove .dart_tool/ directory and add it to .gitignore immediately.

The .dart_tool/ directory is being tracked in version control but should not be. These are auto-generated build and cache files created by Dart/Flutter tools (package_config.json, package_graph.json, web_plugin_registrant.dart, vs_code.json, etc.). They are already in the repository:

  1. Add .dart_tool/ to .gitignore
  2. Run git rm -r --cached .dart_tool/ to remove these files from version control
  3. Commit the changes

Keeping these files committed causes unnecessary repository bloat, merge conflicts in team environments, and violates Dart/Flutter project conventions.

🤖 Prompt for AI Agents
In .dart_tool/extension_discovery/vs_code.json around lines 1 to 1: the
.dart_tool directory is committed but should be ignored; add a line
".dart_tool/" to the repository .gitignore (or ensure it exists), then run git
rm -r --cached .dart_tool/ to remove the tracked files while keeping them
locally, and commit the updated .gitignore and removal so .dart_tool/ is no
longer tracked.

@M4dhav
Copy link
Contributor

M4dhav commented Dec 26, 2025

Please rename the file to zplit-design, and for future reference, not that all PRs must be raised to dev instead of main

@M4dhav M4dhav self-requested a review December 26, 2025 11:42
@M4dhav M4dhav added good first issue Good for newcomers design labels Dec 26, 2025
@M4dhav M4dhav changed the base branch from main to dev December 26, 2025 11:42
@ara2105
Copy link
Author

ara2105 commented Dec 26, 2025

Okay @M4dhav Understood, will do the asked.

@M4dhav
Copy link
Contributor

M4dhav commented Dec 26, 2025

please rename it to exactly zplit-design, all lowercase and with a dash seperator instead of space. Also, please do not use force pushes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

design good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refine base design for Zplit

2 participants