Skip to content
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

Resolve Azle/dfx dfx.json property name conflicts #1766

Open
4 tasks
lastmjs opened this issue Apr 25, 2024 · 0 comments
Open
4 tasks

Resolve Azle/dfx dfx.json property name conflicts #1766

lastmjs opened this issue Apr 25, 2024 · 0 comments

Comments

@lastmjs
Copy link
Member

lastmjs commented Apr 25, 2024

We have introduced our own custom property names into the dfx.json file, like env, candid_gen, assets, etc. If dfx ever decides to use those names, we will have conflicts. We have thought about this and come up with some possible solutions. We are going to punt on this for now and address it in the future, either when we feel like it or when it becomes a problem.

PR checkbox: What do we do about naming clashes between dfx and Azle in the dfx.json? (We should probably nest azle-specific commands, let's wait on dfinity providing a nice nesting structure? We could always move forward on this now though, which might be a good idea because we're introducing breaking changes now anyway)

  • biggest problem is what do we do with clashes between our properties and dfx's
    • nest everything in a custom azle property and have type: azle
    • nest everything in a custom azle property without type: azle
    • handle conflicts, allow extension to choose which fields should be overwritten by the developer and which shouldn't, essentially allowing the extension to rename any fields from dfx.json
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

No branches or pull requests

1 participant