Skip to content

refactor(core): move internal storage to project root #1285

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

Merged
merged 1 commit into from
Jun 23, 2025

Conversation

innocenzi
Copy link
Member

@innocenzi innocenzi commented May 27, 2025

Closes #1281

Before merging, is .tempest the ideal name? Could also be storage, .internal, or something else. I like a dot directory because it's naturally ignored when scanning the hierarchy, but the name "tempest" is not generic and generally I don't like that

Also, we need to add it to .gitignore in tempestphp/tempest-app

@innocenzi innocenzi requested review from aidan-casey and brendt May 27, 2025 13:21
@erikaraujo
Copy link
Contributor

Why not .tempest/internal-storage or .temptest/storage?

@innocenzi
Copy link
Member Author

@erikaraujo That doesn't solve the issue I have with .tempest, and .tempest would be empty besides that "internal" directory 😅

@erikaraujo
Copy link
Contributor

@erikaraujo That doesn't solve the issue I have with .tempest, and .tempest would be empty besides that "internal" directory 😅

@innocenzi The reason I like my suggestion is that it clearly states that it is a framework-specific directory and then it has a more specific "internal" directory inside of it. Or maybe do .tempest/db, .tempest/cache, .tempest/logs... I lack the necessary context of everything that is stored in the internal storage (sorry!)

@innocenzi
Copy link
Member Author

There's already a few subdirectories for each concern, this example is missing local file storage and I believe there may be a few others

CleanShot 2025-05-28 at 15 29 32

I think .tempest might be the most explicit name unfortunately

@aidan-casey
Copy link
Member

@innocenzi - I think the question I would ask is whether there are going to be other items we need to store (e.g., uploads). If so, are we then creating multiple directories?

IMO, I think Laravel gets this fairly spot on in their app structure.

@innocenzi
Copy link
Member Author

I'm not sure I understand what you're asking. Local storage would be in .tempest/storage by default, in tests it would be .tempest/tests/storage/{tag}. Users may create additional storages wherever they want, if they chose to use internal_storage_path('/some/path') that would be relative to .tempest.

@aidan-casey
Copy link
Member

I'm of the mind storage is more clear to user since it will include uploads, etc.

While I can appreciate the concept of a hidden directory, I can just imagine the number of people trying to figure out where the files are because they didn't list hidden directories, etc.

@innocenzi
Copy link
Member Author

As far as I know, PhpStorm, WebStorm and VSC all show dot files and directories. A storage directory wouldn't feel like an "internal storage" though, and we'd have to move stuff like current_discovery_strategy somewhere else, right?

@brendt
Copy link
Member

brendt commented Jun 23, 2025

Yeah I think .tempest is the most obvious name, actually.

@brendt brendt marked this pull request as ready for review June 23, 2025 07:17
@brendt brendt merged commit a3afdc7 into main Jun 23, 2025
66 checks passed
@brendt brendt deleted the refactor/internal-storage-directory branch June 23, 2025 07:17
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.

Internal cache path
4 participants