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

Better visibility that custom integration directory must be the same name as DOMAIN #30144

Closed
jamesonuk opened this issue Dec 4, 2023 · 1 comment

Comments

@jamesonuk
Copy link

Feedback

See https://community.home-assistant.io/t/config-flow-strings-json-not-working/504312
The code bug report was closed as won't do so I think there needs to be something more explicit in the dev docs.

If you name your custom component anything other than your domain then it all seems to work but it will not pick up strings / translations and there is no logging or feedback to highlight this.

It would be really helpful for new developers to add to a few pages that this is a mandatory thing
https://developers.home-assistant.io/docs/creating_integration_file_structure just says that the example domain of mobile_app is in the mobile_app directory, it does not make it clear that things won't work unless it is in a directory of the same name. I suspect this should also be included in the config flow and a few other places where translations are mentioned

URL

https://developers.home-assistant.io/docs/config_entries_config_flow_handler/

Version

No response

Additional information

No response

@frenck
Copy link
Member

frenck commented Dec 5, 2023

This issue is created in the wrong repository. Nevertheless, the developer documentation lists this multiple times. As a matter of fact, it is the absolute first sentence of the integration structure page:

CleanShot 2023-12-05 at 12 23 47@2x

An example is provided in that same paragraph again, to make it more visually concrete as well.

../Frenck

@frenck frenck closed this as not planned Won't fix, can't repro, duplicate, stale Dec 5, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jan 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants