jCloud/jcloud-docsgen
2
1 Fork 0
generated from jCloud/repository-template
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases 13 Wiki Activity

Refactor(utils): mark ExistingDirectory and ExistingFile as deprecated #14

Merged
jakob.scheid merged 4 commits from refactor/remove-existing-file-class into main 2026-09-05 14:44:21 +02:00
Conversation 1 Commits 4 Files Changed 9
+67 -165
jakob.scheid commented 2026-09-05 14:34:18 +02:00
Owner
Copy link
Copy source

ExistingDirectory and ExistingFile deprecation

This pull request marks the ExistingDirectory and ExistingFile utility classes as deprecated. All instances of them were replaced with pathlib.Path or completely removed, if possible.

Related issues

Partially addresses #8

# `ExistingDirectory` and `ExistingFile` deprecation This pull request marks the `ExistingDirectory` and `ExistingFile` utility classes as deprecated. All instances of them were replaced with `pathlib.Path` or completely removed, if possible. ## Related issues Partially addresses #8
jakob.scheid added this to the 0.2.0 milestone 2026-09-05 14:34:18 +02:00
jakob.scheid added the Kind/Documentation
Priority
Medium
3
Kind/ChoreKind/Refactor labels 2026-09-05 14:34:18 +02:00
jakob.scheid added this to the Project Board project 2026-09-05 14:34:18 +02:00
jakob.scheid added 3 commits 2026-09-05 14:34:18 +02:00
chore(utils): mark ExistingDirectory and ExistingFile as deprecated 5d8dbd659d
refactor: remove or update all instances of ExistingFile and ExistingDirectory in tests d54c0fb208
refactor: update all instances of ExistingFile and ExistingDirectory in source code 36cedb390b
jakob.scheid moved this to Review in Project Board on 2026-09-05 14:34:21 +02:00
jakob.scheid modified the milestone from 0.2.0 to existing-file-existing-directory-removal 2026-09-05 14:35:06 +02:00
src/jcloud_docsgen/cli.py Outdated
@@ -28,2 +26,3 @@
def existing_directory(path: str) -> pathlib.Path:
try:
return ExistingDirectory(path, *args, **kwargs)
return pathlib.Path(path)
jakob.scheid commented 2026-09-05 14:37:59 +02:00
Author
Owner
Copy link
Copy source

There is no check whether the directory exists.

There is no check whether the directory exists.
jakob.scheid marked this conversation as resolved
jakob.scheid added 1 commit 2026-09-05 14:42:26 +02:00
fix(cli): check whether project directory exists and is a directory 78e3e020be
jakob.scheid force-pushed refactor/remove-existing-file-class from 694a1c25f6 to 78e3e020be 2026-09-05 14:42:26 +02:00 Compare
jakob.scheid added spent time 6 minutes 2026-09-05 14:43:16 +02:00
jakob.scheid merged commit 3cd374c354 into main 2026-09-05 14:44:21 +02:00
jakob.scheid deleted branch refactor/remove-existing-file-class 2026-09-05 14:44:21 +02:00
jakob.scheid moved this to Done in Project Board on 2026-09-05 14:44:27 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
jakob.scheid
Labels
Clear labels
Compat/Breaking
Breaking change that will not be backward compatible
 Kind/Bug
Something is not working
 Kind/Chore
Chore and maintenance
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Refactor
Refactoring code
 Kind/Security
This is security issue
 Kind/Style
Code style changes
 Kind/Testing
Issue or pull request related to testing
 Kind/Urgent
The issue or pull request is urgent
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Medium
3
The priority is medium
Priority
Low
4
The priority is low
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Will Not Fix
3
This issue won't be fixed
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
Status
Abandoned
3
Somebody has started to work on this but abandoned work
No labels Kind/Chore Kind/Documentation Kind/Refactor
Priority
Medium
3
Milestone
No items
No Milestone existing-file-existing-directory-removal
Projects
Clear projects
No projects
Project Board
Done
Assignees
Clear assignees
jakob.scheid (Jakob Scheid) jcloud-bot (jCloudBot) Bot
No Assignees
1 Participants
Notifications
Total Time Spent: 6 minutes
jakob.scheid
6 minutes
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jCloud/jcloud-docsgen#14