fix: create item check for dot-entries

[TheLazron]

Solves #566

Solution

Added util function to check for the cases where name:

• equals . or ..
• has suffix /. or /..
  can be used for any further invalid names that may need a check.

Implementation allows for names that might end with dot(s)

Summary by CodeRabbit

• New Features
  • Added filename validation to prevent invalid names like ".", "..", or those ending with "/." or "/..".
  • Display of error messages in the file naming modal for invalid filenames.
  • Automatic clearing of error messages when cancelling file creation.
• Bug Fixes
  • Enhanced validation to block invalid filenames and improve user feedback during file creation.

[coderabbitai]

Walkthrough

A new function checkFileNameValidity was added to validate filenames against specific invalid patterns. This validation is integrated at the start of the createItem method in the typing modal handler, blocking creation of items with invalid filenames. The typing modal now tracks error messages, which are rendered conditionally. Additional tests were added for filename validation and file creation. The typing modal cancels also clear error messages.

Changes

File(s)	Change Summary
src/internal/function.go	Added checkFileNameValidity function to validate filenames against invalid names and suffixes.
src/internal/handle_modal.go	Added filename validation at start of createItem; sets error message and aborts on invalid input; deferred cleanup clears error message.
src/internal/type.go	Added errorMesssage string field to typingModal struct to hold validation error messages.
src/internal/model_render.go	Modified typing modal render function to conditionally display styled error message below input and tip.
src/internal/key_function.go	Cleared errorMesssage field when cancelling typing modal to reset error state.
src/internal/common/style.go	Added new exported style variable ModalErrorStyle for styling modal error messages.
src/internal/function_test.go	Added TestCheckFileNameValidity to test various valid and invalid filename scenarios for checkFileNameValidity.
src/internal/model_file_operations_test.go	Added TestFileCreation to test filename validation during file creation in model, including nested directories.

Poem

A bunny checks your file’s good name,
No dots alone, nor sneaky shame.
If endings “/.” or “/..” appear,
The bunny hops away from here!
With careful code and nimble feet,
Only valid files we greet.
🐇✨

---

📜 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 93a51ad and cbfbfee.

📒 Files selected for processing (1)

• src/internal/model_render.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/internal/model_render.go

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 0c15880 and c7e91f1.

📒 Files selected for processing (2)

• src/internal/function.go (1 hunks)
• src/internal/handle_modal.go (1 hunks)

🧰 Additional context used

🪛 golangci-lint (1.64.8)

src/internal/function.go

217-217: dupCase: 'case name == "."' is duplicated

(gocritic)

🔇 Additional comments (1)

src/internal/handle_modal.go (1)

29-31: LGTM: Properly validates filenames before creation

The implementation correctly checks if the filename is valid before attempting to create it, and returns early if validation fails. The placement right after the defer block ensures proper cleanup regardless of validation results.

[lazysegtree]

Needs work

[TheLazron]

Needs work

Thanks for the feedback :D, will make all these changes

[TheLazron]

Hey @lazysegtree, I have made the changes you mentioned

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (6)

src/internal/function.go (1)

215-224: The filename validation function looks solid, but has some performance optimizations.

The implementation correctly validates filenames against special directory entries (. and ..) as specified in the PR objectives, with proper error handling and cross-platform support using the OS-specific path separator.

Consider using errors.New instead of fmt.Errorf when no formatting is needed:

 func checkFileNameValidity(name string) error {
 	switch {
 	case name == ".", name == "..":
-		return fmt.Errorf("file name cannot be '.' or '..'")
+		return errors.New("file name cannot be '.' or '..'")
 	case strings.HasSuffix(name, fmt.Sprintf("%c.", filepath.Separator)), strings.HasSuffix(name, fmt.Sprintf("%c..", filepath.Separator)):
-		return fmt.Errorf("file name cannot end with '/.' or '/..'")
+		return errors.New("file name cannot end with '/.' or '/..'")
 	default:
 		return nil
 	}
 }

This would require adding errors to the import list.

🧰 Tools

🪛 golangci-lint (1.64.8)

218-218: fmt.Errorf can be replaced with errors.New

(perfsprint)

---

220-220: fmt.Errorf can be replaced with errors.New

(perfsprint)

src/internal/model_file_operations_test.go (1)

82-124: The test cases for file naming validation are comprehensive.

The test covers all the required validation cases for filenames, including special directory entries (. and ..), paths ending with /.or/..`, and valid filenames. The test setup and cleanup are properly handled.

There's a minor typo in the test case description:

-		{"invalid trailig slash-dot-dot", fmt.Sprintf("test%c..", filepath.Separator), true},
+		{"invalid trailing slash-dot-dot", fmt.Sprintf("test%c..", filepath.Separator), true},

src/internal/function_test.go (4)

10-10: Remove unnecessary newline.

There's an extra blank line after the function declaration that should be removed.

-func TestCheckFileNameValidity(t *testing.T) {
-
+func TestCheckFileNameValidity(t *testing.T) {

🧰 Tools

🪛 golangci-lint (1.64.8)

10-10: unnecessary leading newline

(whitespace)

---

26-26: Fix typo in error message.

The error message contains a typo: "cnnot" should be "cannot".

-			errMsg:  "file name cnnot be '.' or '..'",
+			errMsg:  "file name cannot be '.' or '..'",

---

31-31: Consider making error messages platform-agnostic.

The error messages refer to '/' which might not match the actual separator on Windows systems. Consider using a platform-agnostic message or using the filepath.Separator in the error message construction.

-			errMsg:  "file name cannot end with '/.' or '/..'",
+			errMsg:  fmt.Sprintf("file name cannot end with '%c.' or '%c..'", filepath.Separator, filepath.Separator),

Or ensure the actual implementation of checkFileNameValidity uses a platform-agnostic approach for error messages.

Also applies to: 36-36

---

73-73: Remove unnecessary trailing newline.

There's an extra blank line at the end of the function that should be removed.

-}
-
+}

🧰 Tools

🪛 golangci-lint (1.64.8)

73-73: unnecessary trailing newline

(whitespace)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between c7e91f1 and 80bc8ff.

📒 Files selected for processing (7)

• src/internal/function.go (1 hunks)
• src/internal/function_test.go (1 hunks)
• src/internal/handle_modal.go (1 hunks)
• src/internal/key_function.go (1 hunks)
• src/internal/model_file_operations_test.go (3 hunks)
• src/internal/model_render.go (1 hunks)
• src/internal/type.go (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/internal/type.go

🚧 Files skipped from review as they are similar to previous changes (1)

• src/internal/handle_modal.go

🧰 Additional context used

🧬 Code Graph Analysis (2)

src/internal/model_file_operations_test.go (3)

src/internal/test_utils.go (1)

• TeaUpdateWithErrCheck (53-57)

src/internal/utils/tea_utils.go (1)

• TeaRuneKeyMsg (5-10)

src/internal/common/default_config.go (1)

• Hotkeys (12-12)

src/internal/model_render.go (2)

src/internal/common/style_function.go (1)

• ModalBorderStyle (120-122)

src/internal/common/predefined_variable.go (2)

• ModalHeight (21-21)
• ModalWidth (20-20)

🪛 golangci-lint (1.64.8)

src/internal/function_test.go

10-10: unnecessary leading newline

(whitespace)

---

73-73: unnecessary trailing newline

(whitespace)

src/internal/function.go

218-218: fmt.Errorf can be replaced with errors.New

(perfsprint)

---

220-220: fmt.Errorf can be replaced with errors.New

(perfsprint)

🔇 Additional comments (3)

src/internal/key_function.go (1)

208-209: LGTM: Error message clearing on cancel.

Clearing the error message when the typing modal is canceled ensures that previous error states don't persist when reopening the modal, providing a clean user experience.

src/internal/model_render.go (1)

410-417: The error message rendering implementation is effective.

The code adds appropriate styling to error messages with red text and red border for clear visual feedback when filename validation fails. This enhances user experience by providing immediate, visible feedback about invalid inputs.

src/internal/function_test.go (1)

10-73: The overall test looks good but could use additional validation.

The test cases cover various scenarios for the checkFileNameValidity function, which is excellent. However, consider adding validation for the error message in cases where no error is expected to ensure it's empty.

🧰 Tools

🪛 golangci-lint (1.64.8)

10-10: unnecessary leading newline

(whitespace)

---

73-73: unnecessary trailing newline

(whitespace)

[lazysegtree]

@TheLazron Thanks for the fixes.

If you need any help in fixing the further code improvements that I have pointed out, I can do the changes. Sorry, but the code quality of this project is not so good. I have to be strict in reviews.

By the way, we have an semi-active discord (see ReadMe for badge for discord), in case you didn't knew. You can use that for more free discussion, or get any help required while contributing.

[TheLazron]

@TheLazron Thanks for the fixes.

If you need any help in fixing the further code improvements that I have pointed out, I can do the changes. Sorry, but the code quality of this project is not so good. I have to be strict in reviews.

By the way, we have an semi-active discord (see ReadMe for badge for discord), in case you didn't knew. You can use that for more free discussion, or get any help required while contributing.

Thanks a lot for pointing these out! >W<
Sorry got occupied with some work, will try to fix these today only

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/internal/function_test.go (2)

13-13: Remove unnecessary leading newline.

The static analysis tool correctly identifies an unnecessary leading newline.

 func TestCheckFileNameValidity(t *testing.T) {
-
 	tests := []struct {

🧰 Tools

🪛 golangci-lint (1.64.8)

13-13: unnecessary leading newline

(whitespace)

---

66-71: Improve assertion style for better readability.

The test logic using testify is much improved from previous versions. However, the static analysis tool suggests using assert.Contains for better readability.

 		if !tt.wantErr {
 			require.NoError(t, err)
 		} else {
 			require.Error(t, err)
-			assert.True(t, strings.Contains(err.Error(), tt.errMsg))
+			assert.Contains(t, err.Error(), tt.errMsg)
 		}

🧰 Tools

🪛 golangci-lint (1.64.8)

70-70: contains: use assert.Contains

(testifylint)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 80bc8ff and 2acb1c4.

📒 Files selected for processing (6)

• src/internal/common/style.go (2 hunks)
• src/internal/function.go (2 hunks)
• src/internal/function_test.go (1 hunks)
• src/internal/handle_modal.go (1 hunks)
• src/internal/model_file_operations_test.go (2 hunks)
• src/internal/model_render.go (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• src/internal/common/style.go

🚧 Files skipped from review as they are similar to previous changes (4)

• src/internal/function.go
• src/internal/model_file_operations_test.go
• src/internal/handle_modal.go
• src/internal/model_render.go

🧰 Additional context used

🪛 golangci-lint (1.64.8)

src/internal/function_test.go

70-70: contains: use assert.Contains

(testifylint)

---

13-13: unnecessary leading newline

(whitespace)

🔇 Additional comments (3)

src/internal/function_test.go (3)

9-10: LGTM! Testify imports properly added.

The testify imports have been correctly added as requested in previous reviews, following the standard pattern used across the codebase.

---

21-59: Excellent test case coverage.

The test cases comprehensively cover both valid and invalid filename scenarios, including platform-specific path separators and edge cases. The error messages are consistent and informative.

---

34-34:

✅ Verification successful

Verify error message format consistency.

Ensure that the dynamic error messages using fmt.Sprintf match the actual error messages returned by the checkFileNameValidity function implementation.

Also applies to: 39-39

---

🏁 Script executed:

#!/bin/bash
# Description: Verify the actual error messages returned by checkFileNameValidity function
# Expected: Error messages should match the test expectations

echo "Searching for checkFileNameValidity function implementation:"
ast-grep --pattern 'func checkFileNameValidity($name) error {
  $$$
}'

echo -e "\nSearching for error message patterns:"
rg "file name cannot end with" --type go -A 2 -B 2

Length of output: 1583

---

Error message formats are consistent – no changes needed.

Both the implementation in src/internal/function.go and the test expectations in src/internal/function_test.go use the identical format string:

"file name cannot end with '%c.' or '%c..'"

and pass filepath.Separator twice, so the test’s errMsg matches the actual error returned by checkFileNameValidity.

[lazysegtree]

@TheLazron There are merge conflicts in this. Can you resolve them? It would be best to rebase this branch with latest main.

And please remove that file named ... that is visible in PR diff. and that comment related to m.typingModal.errorMesssage = ""

[TheLazron]

@TheLazron There are merge conflicts in this. Can you resolve them? It would be best to rebase this branch with latest main.

And please remove that file named ... that is visible in PR diff. and that comment related to m.typingModal.errorMesssage = ""

Can you please check if the following were resolved? I did perform the rebase

Not sure do I need to make another pr from my working branch?