fix: update localConfig from appwrite.json to appwrite.config.json #1116
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the default configuration file name from appwrite.json to appwrite.config.json to avoid naming conflicts with the appwrite package import in frameworks like Vite. The changes maintain backward compatibility by still supporting the legacy appwrite.json filename.
- Introduces new default config filename
appwrite.config.jsonwhile preserving legacy support - Refactors config file discovery logic into a reusable static method
- Updates constructor to check for both new and legacy config file locations
Meldiron
reviewed
Jul 22, 2025
Comment on lines
+128
to
+129
| static CONFIG_FILE_PATH = "{{ spec.title|caseLower }}.config.json"; | ||
| static CONFIG_FILE_PATH_LEGACY = "{{ spec.title|caseLower }}.json"; |
There was a problem hiding this comment.
As per torsten suggestion, it might be better to use library for this: https://github.com/unjs/c12
that will aslo support .js out of the box, which would be great addition for those wanting a bit of complexity.
I would never try to load such JS/TS configs on my own, trusting lib with 10M monthly downloads is better
Meldiron
approved these changes
Jul 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
since frameworks like vite allow direct import of json files,
appwrite.jsoncan be confused with theappwritepackage import. this PR shifts default config to beappwrite.config.jsonwhile keeping backwards compatibility with appwrite.jsonTest Plan
Related PRs and Issues
Have you read the Contributing Guidelines on issues?
yes.