Skip to content

Conversation

@yorukot
Copy link
Owner

@yorukot yorukot commented Jun 13, 2025

There was a previous issue (can't seem to find it now :/) where we discussed whether the project name should be Superfile or superfile. The agreed convention back then was to use superfile (lowercase).

This PR updates user-facing texts to consistently use superfile. Go naming conventions (e.g., exported identifiers) are left unchanged for now, since they don’t affect what users see.

Summary by CodeRabbit

  • Style
    • Updated capitalization of "Superfile" to "superfile" across user-facing text, headers, prompts, documentation, and error messages for consistency.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

Walkthrough

This update standardizes the capitalization of the term "superfile" across documentation, user interface strings, test assertions, and error messages by changing it from "Superfile" to "superfile." No logic, control flow, or functionality was altered—only string literals and documentation text were updated.

Changes

File(s) Change Summary
README.md, website/src/content/docs/contribute/file-struct.md Section headers and directory descriptions updated to use "superfile" (lowercase)
src/internal/ui/prompt/consts.go Constant string promptHeadlineText changed to "superfile Prompt"
src/internal/ui/prompt/model_test.go Test assertions updated to expect "superfile Prompt" in rendered output
testsuite/core/base_test.py, testsuite/tests/chooser_file_test.py Assertion error messages updated to "superfile is not running"/"superfile is still running"

Suggested labels

documentation

Poem

A bunny hopped and changed a name,
From "Superfile" to "superfile"—all the same!
Lowercase letters now dance in delight,
Across docs and prompts, they look just right.
With every test and every line,
The humble "superfile" begins to shine!
🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 14f551e and 1791074.

📒 Files selected for processing (6)
  • README.md (1 hunks)
  • src/internal/ui/prompt/consts.go (1 hunks)
  • src/internal/ui/prompt/model_test.go (4 hunks)
  • testsuite/core/base_test.py (2 hunks)
  • testsuite/tests/chooser_file_test.py (1 hunks)
  • website/src/content/docs/contribute/file-struct.md (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (3)
testsuite/tests/chooser_file_test.py (1)
testsuite/core/spf_manager.py (1)
  • is_spf_running (29-34)
testsuite/core/base_test.py (1)
testsuite/core/spf_manager.py (1)
  • is_spf_running (29-34)
src/internal/ui/prompt/model_test.go (1)
src/config/icon/icon.go (1)
  • Terminal (42-42)
🪛 LanguageTool
website/src/content/docs/contribute/file-struct.md

[uncategorized] ~73-~73: Possible missing comma found.
Context: ...nctions ### testsuite/ - superfile's testsuite written in Python - Automatically test...

(AI_HYDRA_LEO_MISSING_COMMA)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (go)
🔇 Additional comments (11)
website/src/content/docs/contribute/file-struct.md (1)

73-73: Consistent lowercase naming
The term “superfile” is correctly styled in lowercase here.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~73-~73: Possible missing comma found.
Context: ...nctions ### testsuite/ - superfile's testsuite written in Python - Automatically test...

(AI_HYDRA_LEO_MISSING_COMMA)

README.md (1)

136-136: Consistent lowercase naming in header
The “Start superfile” section header correctly uses lowercase.

testsuite/tests/chooser_file_test.py (1)

34-34: Assertion message updated to lowercase
The error message now consistently uses “superfile” in lowercase.

src/internal/ui/prompt/consts.go (1)

8-8: UI prompt constant adjusted for lowercase
The prompt headline text is updated to “superfile Prompt” to match naming conventions.

testsuite/core/base_test.py (3)

80-80: Assertion message updated to lowercase
Updated to use “superfile” in lowercase for the running status assertion.


115-115: Assertion message updated to lowercase
Updated to use “superfile” in lowercase for the closed status assertion.


117-117: Assertion message updated to lowercase
Updated to use “superfile” in lowercase for the running status assertion.

src/internal/ui/prompt/model_test.go (4)

242-242: Basic Render (Shell Mode) header uses lowercase "superfile".

Updated the expected header to reflect the new lowercase naming convention, in line with the change to promptHeadlineText.


253-253: Basic Render (SPF Mode) header uses lowercase "superfile".

Consistently updated the SPF mode header to lowercase "superfile" to match the standard.


295-295: Result Message (Success) header uses lowercase "superfile".

Aligned the success-case prompt header with the lowercase naming.


308-308: Result Message (Error) header uses lowercase "superfile".

Updated the error-case prompt header to lowercase "superfile" for consistency.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@yorukot yorukot merged commit 0d77a5f into main Jun 13, 2025
8 checks passed
@lazysegtree lazysegtree deleted the Superfile-to-superfile branch June 14, 2025 01:24
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Jul 28, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [yorukot/superfile](https://github.com/yorukot/superfile) | patch | `v1.3.1` -> `v1.3.3` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>yorukot/superfile (yorukot/superfile)</summary>

### [`v1.3.3`](https://github.com/yorukot/superfile/releases/tag/v1.3.3)

[Compare Source](yorukot/superfile@v1.3.2...v1.3.3)

Hey folks. Releasing v1.3.3 with bug fix related to config file, and improvements in metadata panel feature.

#### Install:

[**Click me to know how to install**](https://github.com/yorukot/superfile?tab=readme-ov-file#installation)

#### Highlights

- Fixed a bug in config file correction that would make config file invalid. Thanks [@&#8203;estebandpena](https://github.com/estebandpena) for reporting the issue, and [@&#8203;wassup05](https://github.com/wassup05) for the fix.

#### Detailed Change Summary

<details><summary>Details</summary>
<p>

##### Update
- feat: Metadata loading via bubbletea's tea.Cmd method, removed usage channels and custom goroutines [#&#8203;947](yorukot/superfile#947) by @&#8203;lazysegtree
- feat: Metadata panel into separate package, UI bug fixes, Code improvements [#&#8203;950](yorukot/superfile#950) by @&#8203;lazysegtree
- feat: add support for Python virtual environment in testsuite setup [#&#8203;956](yorukot/superfile#956) by @&#8203;Khitoshi

##### Bug fix
- fix: windows test ci [#&#8203;941](yorukot/superfile#941) by @&#8203;claykom
- fix: fixing `config.toml` [#&#8203;952](yorukot/superfile#952) by @&#8203;wassup05

</p>
</details> 

**Full Changelog**: yorukot/superfile@v1.3.2...v1.3.3

### [`v1.3.2`](https://github.com/yorukot/superfile/releases/tag/v1.3.2)

[Compare Source](yorukot/superfile@v1.3.1...v1.3.2)

Hey folks. Releasing v1.3.2 with multiple new features including implementation image preview using kitty protocol, and various bug fixes and internal improvements.

##### **You can now preview images in high quality — no more pixelation!**

<img width="1267" height="670" alt="image" src="https://github.com/user-attachments/assets/0f7ec48e-9386-4716-92a5-4a02783f6612" />

#### Install:
[**Click me to know how to install**](https://github.com/yorukot/superfile?tab=readme-ov-file#installation)

#### Highlights
- Added image preview via kitty protocol. Thanks @&#8203;JassonCordones and @&#8203;yorukot for the implementation.
- Added Zoxide support for path resolution in initial configuration. Thanks @&#8203;yorukot for this.
- New 0x96f Theme by @&#8203;filipjanevski 
- Various usability and layout bug fixes. See "Detailed Change Summary" below.  Thanks to @&#8203;larsn03  @&#8203;Frost-Phoenix  @&#8203;TheLazron @&#8203;vkhatsiur @&#8203;Khitoshi @&#8203;claykom 

##### Developer Improvements
- Added CI Action to run unit tests and build for windows.
- Updated contribution guidelines and MR template
- Added a dev.sh script for building, linting and running tests for faster development workflows.

####  Detailed Change Summary

<details><summary>Details</summary>
<p>

##### Update
- Normalize user-facing naming to superfile [#&#8203;880](yorukot/superfile#880) by @&#8203;yorukot
- Add kitty protocol for image preview [#&#8203;841](yorukot/superfile#841) by @&#8203;JassonCordones
- feat: add Zoxide support for path resolution in initial configuration [#&#8203;892](yorukot/superfile#892) by @&#8203;yorukot
- feat: update superfile's help output [#&#8203;908](yorukot/superfile#908) by @&#8203;yorukot
- feat: Add Action to Publish to Winget [#&#8203;925](yorukot/superfile#925) by @&#8203;claykom
- feat: update superfile build test for the windows and macOS [#&#8203;922](yorukot/superfile#922) by @&#8203;yorukot
- Theme: add 0x96f theme [#&#8203;860](yorukot/superfile#860) by @&#8203;filipjanevski

##### Bug fix
- fix: outdated and broken nix flake [#&#8203;846](yorukot/superfile#846) by @&#8203;Frost-Phoenix
- fix: handle UTF-8 BOM in file reader [#&#8203;865](yorukot/superfile#865) by @&#8203;vkhatsiur
- fix icon displayed on spf prompt when nerdfont disabled [#&#8203;878](yorukot/superfile#878) by @&#8203;claykom
- fix: create item check for dot-entries [#&#8203;817](yorukot/superfile#817) by @&#8203;TheLazron
- fix: prevent pasting a directory into itself, avoiding infinite loop [#&#8203;887](yorukot/superfile#887) by @&#8203;yorukot
- fix: clear search bar value on parent directory reset [#&#8203;906](yorukot/superfile#906) by @&#8203;yorukot
- fix: enhance terminal pixel detection and response handling [#&#8203;904](yorukot/superfile#904) by @&#8203;yorukot
- fix: Cannot Build superfile on Windows [#&#8203;921](yorukot/superfile#921) by @&#8203;claykom
- fix: Improve command tokenization to handle quotes and escapes [#&#8203;931](yorukot/superfile#931) by @&#8203;Khitoshi
- fix: Dont read special files, and prevent freeze [#&#8203;932](yorukot/superfile#932) by @&#8203;lazysegtree
- Compress all files selected [#&#8203;821](yorukot/superfile#821) by @&#8203;larsn03

##### Optimization
- Metadata and filepanel rendering refactor [#&#8203;867](yorukot/superfile#867) by @&#8203;JassonCordones
- refactor: simplify panel mode handling in file movement logic [#&#8203;907](yorukot/superfile#907) by @&#8203;yorukot
- refactor: standardize TODO comments and ReadMe to README [#&#8203;913](yorukot/superfile#913) by @&#8203;yorukot

##### Documentation
- enhance: add detailed documentation for InitIcon function and update … [#&#8203;879](yorukot/superfile#879) by @&#8203;yorukot
- docs: add documentation for image preview [#&#8203;882](yorukot/superfile#882) by @&#8203;yorukot
- docs: update contributing guide and MR template [#&#8203;885](yorukot/superfile#885) by @&#8203;yorukot
- docs: update README and plugin documentation for clarity and structure [#&#8203;902](yorukot/superfile#902) by @&#8203;yorukot
- feat(docs): Update arch install package docs [#&#8203;929](yorukot/superfile#929) by @&#8203;booth-w

##### CI/CD
- ci: add MR title linting with semantic-pull-request action [#&#8203;884](yorukot/superfile#884) by @&#8203;yorukot
- ci: improve MR workflows with contributor greeting and title linter fix [#&#8203;886](yorukot/superfile#886) by @&#8203;yorukot

##### Dependencies
- build(deps): bump prismjs from 1.29.0 to 1.30.0 in /website [#&#8203;786](yorukot/superfile#786) by @&#8203;dependabot[bot]
- fix(deps): update dependency astro to v5.8.0 [#&#8203;787](yorukot/superfile#787) by @&#8203;renovate[bot]
- chore(deps): bump vite from 6.3.3 to 6.3.5 in /website [#&#8203;822](yorukot/superfile#822) by @&#8203;dependabot[bot]
- fix(deps): update dependency sharp to v0.34.2 [#&#8203;909](yorukot/superfile#909) by @&#8203;renovate[bot]
- fix(deps): update astro monorepo [#&#8203;894](yorukot/superfile#894) by @&#8203;renovate[bot]
- fix(deps): update fontsource monorepo to v5.2.6 [#&#8203;910](yorukot/superfile#910) by @&#8203;renovate[bot]

##### Misc
- chore(license): update copyright year [#&#8203;895](yorukot/superfile#895) by @&#8203;yorukot
- feat: add ignore missing field flag [#&#8203;881](yorukot/superfile#881) by @&#8203;claykom
- feat: add sitemap integration and update giscus input position [#&#8203;912](yorukot/superfile#912) by @&#8203;yorukot

</p>
</details> 

#### New Contributors
* @&#8203;filipjanevski made their first contribution in yorukot/superfile#860
* @&#8203;larsn03 made their first contribution in yorukot/superfile#821
* @&#8203;vkhatsiur made their first contribution in yorukot/superfile#865
* @&#8203;claykom made their first contribution in yorukot/superfile#878
* @&#8203;TheLazron made their first contribution in yorukot/superfile#817
* @&#8203;Khitoshi made their first contribution in yorukot/superfile#931

**Full Changelog**: yorukot/superfile@v1.3.1...v1.3.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MC42Mi4xIiwidXBkYXRlZEluVmVyIjoiNDAuNjIuMSIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
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.

3 participants