Expand use of prettier to all tracked files (#17311)

.github/release-drafter.yml

@@ -1,8 +1,8 @@
 categories:
-  - title: 'Dependency updates'
+  - title: "Dependency updates"
     collapse-after: 3
     labels:
-      - 'Dependencies'
+      - "Dependencies"
 template: |
   ## What's Changed
 

.github/workflows/codeql-analysis.yml

@@ -17,7 +17,7 @@ jobs:
       matrix:
         # Override automatic language detection by changing the below list
         # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
-        language: ['javascript']
+        language: ["javascript"]
         # Learn more...
         # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
 

.prettierignore

@@ -0,0 +1,3 @@
+CLA.md
+CODE_OF_CONDUCT.md
+LICENSE.md

.vscode/launch.json

@@ -9,9 +9,7 @@
       "webRoot": "${workspaceFolder}/hass_frontend",
       "disableNetworkCache": true,
       "preLaunchTask": "Develop Frontend",
-      "outFiles": [
+      "outFiles": ["${workspaceFolder}/hass_frontend/frontend_latest/*.js"]
-        "${workspaceFolder}/hass_frontend/frontend_latest/*.js"
-      ]
     },
     {
       "name": "Debug Gallery",
@@ -39,6 +37,6 @@
       "webRoot": "${workspaceFolder}/cast/dist",
       "disableNetworkCache": true,
       "preLaunchTask": "Develop Cast"
-    },
+    }
   ]
 }

cast/public/service_worker.js

@@ -1,3 +1,3 @@
-self.addEventListener("fetch", function(event) {
+self.addEventListener("fetch", (event) => {
   event.respondWith(fetch(event.request));
 });

demo/public/service_worker.js

@@ -1,3 +1,3 @@
-self.addEventListener("fetch", function(event) {
+self.addEventListener("fetch", (event) => {
   event.respondWith(fetch(event.request));
 });

gallery/src/pages/Text/remove-delete-add-create.markdown

@@ -4,53 +4,63 @@ subtitle: The difference between remove/delete and add/create.
 ---
 
 # Remove vs Delete
+
 Remove and Delete are quite similar, but can be frustrating if used inconsistently.
 
 ## Remove
+
 Take away and set aside, but kept in existence.
 
 For example:
-* Removing a user's permission
+
-* Removing a user from a group
+- Removing a user's permission
-* Removing links between items
+- Removing a user from a group
-* Removing a widget
+- Removing links between items
-* Removing a link
+- Removing a widget
-* Removing an item from a cart
+- Removing a link
+- Removing an item from a cart
 
 ## Delete
+
 Erase, rendered nonexistent or nonrecoverable.
 
 For example:
-* Deleting a field
+
-* Deleting a value in a field
+- Deleting a field
-* Deleting a task
+- Deleting a value in a field
-* Deleting a group
+- Deleting a task
-* Deleting a permission
+- Deleting a group
-* Deleting a calendar event
+- Deleting a permission
+- Deleting a calendar event
 
 # Add vs Create
+
 In most cases, Create can be paired with Delete, and Add can be paired with Remove.
 
 ## Add
+
 An already-exisiting item.
 
 For example:
-* Adding a permission to a user
+
-* Adding a user to a group
+- Adding a permission to a user
-* Adding links between items
+- Adding a user to a group
-* Adding a widget
+- Adding links between items
-* Adding a link
+- Adding a widget
-* Adding an item to a cart
+- Adding a link
+- Adding an item to a cart
 
 ## Create
+
 Something made from scratch.
 
 For example:
-* Creating a new field
+
-* Creating a new value in a field
+- Creating a new field
-* Creating a new task
+- Creating a new value in a field
-* Creating a new group
+- Creating a new task
-* Creating a new permission
+- Creating a new group
-* Creating a new calendar event
+- Creating a new permission
+- Creating a new calendar event
 
 Based on this is [UX magazine article](https://uxmag.com/articles/ui-copy-remove-vs-delete2-banner).

gallery/src/pages/brand/logo.markdown

@@ -10,7 +10,6 @@ As a community, we are proud of our logo. Follow these guidelines to ensure it a
 
 ![Logo](/images/logo.png)
 
-
 ## Using the icon
 
 Our icon is a shorter and most used version of our logo. The icon can exist without the wordmark, the wordmark should never exist without the icon.

gallery/src/pages/components/ha-alert.markdown

@@ -11,6 +11,7 @@ subtitle: An alert displays a short, important message in a way that attracts th
 </style>
 
 # Alert `<ha-alert>`
+
 The alert offers four severity levels that set a distinctive icon and color.
 
 <ha-alert alert-type="error">
@@ -35,38 +36,46 @@ The alert offers four severity levels that set a distinctive icon and color.
 2. [Implementation](#implementation)
 
 ### Resources
+
 | Type           | Link                                                                                                                                                                      | Status    |
-|----------------|----------------------------------|-----------|
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
 | Design         | <a href="https://www.figma.com/community/file/967153512097289521/Home-Assistant-DesignKit" rel="noopener noreferrer" target="_blank">Home Assistant DesignKit</a> (Figma) | Available |
 | Implementation | <a href="https://github.com/home-assistant/frontend/blob/dev/src/components/ha-alert.ts" rel="noopener noreferrer" target="_blank">Web Component</a> (GitHub)             | Available |
 
 ## Guidelines
+
 ### Usage
+
 An alert displays a short, important message in a way that attracts the user's attention without interrupting the user's task.
 
 ### Anatomy
-*Documentation coming soon*
+
+_Documentation coming soon_
 
 ### Error alert
+
 Error alerts
-*Real world example coming soon*
+_Real world example coming soon_
 
 ### Warning alert
+
 Warning alerts
-*Real world example coming soon*
+_Real world example coming soon_
 
 ### Info alert
+
 Info alerts
-*Real world example coming soon*
+_Real world example coming soon_
 
 ### Success alert
+
 Success alerts
-*Real world example coming soon*
+_Real world example coming soon_
 
 ### Placement
 
-
 ### Accessibility
+
 (WAI-ARIA: [https://www.w3.org/TR/wai-aria-practices/#alert](https://www.w3.org/TR/wai-aria-practices/#alert))
 
 When the component is dynamically displayed, the content is automatically announced by most screen readers. At this time, screen readers do not inform users of alerts that are present when the page loads.
@@ -78,6 +87,7 @@ Actions must have a tab index of 0 so that they can be reached by keyboard-only
 ## Implementation
 
 ### Example Usage
+
 **Alert type**
 
 <ha-alert alert-type="error">
@@ -96,17 +106,12 @@ Actions must have a tab index of 0 so that they can be reached by keyboard-only
   This is an success alert — check it out!
 </ha-alert>
 
-
 ```html
-<ha-alert alert-type="error">
+<ha-alert alert-type="error"> This is an error alert — check it out! </ha-alert>
-  This is an error alert — check it out!
-</ha-alert>
 <ha-alert alert-type="warning">
   This is a warning alert — check it out!
 </ha-alert>
-<ha-alert alert-type="info">
+<ha-alert alert-type="info"> This is an info alert — check it out! </ha-alert>
-  This is an info alert — check it out!
-</ha-alert>
 <ha-alert alert-type="success">
   This is a success alert — check it out!
 </ha-alert>
@@ -154,13 +159,14 @@ The `title ` option should not be used without a description.
 
 **Slotted icon**
 
-*Documentation coming soon*
+_Documentation coming soon_
 
 ### API
+
 **Properties/Attributes**
 
 | Name        | Type    | Default | Description                                           |
-|-------------|---------|---------|-------------------------------------------------------|
+| ----------- | ------- | ------- | ----------------------------------------------------- |
 | title       | string  | ``      | Title to display.                                     |
 | alertType   | string  | `info`  | Severity level that set a distinctive icon and color. |
 | dismissable | boolean | `false` | Gives the option to close the alert.                  |
@@ -170,8 +176,8 @@ The `title ` option should not be used without a description.
 
 **Events**
 
-*Documentation coming soon*
+_Documentation coming soon_
 
 **CSS Custom Properties**
 
-*Documentation coming soon*
+_Documentation coming soon_

gallery/src/pages/components/ha-dialogs.markdown

@@ -10,21 +10,25 @@ Our dialogs are based on the latest version of Material Design. Specs and guidel
 # Highlighted guidelines
 
 ## Content
-* A best practice is to always use a title, even if it is optional by Material guidelines.
+
-* People mainly read the title and a button. Put the most important information in those two.
+- A best practice is to always use a title, even if it is optional by Material guidelines.
-* Try to avoid user generated content in the title, this could make the title unreadable long.
+- People mainly read the title and a button. Put the most important information in those two.
-* If users become unsure, they read the description. Make sure this explains what will happen.
+- Try to avoid user generated content in the title, this could make the title unreadable long.
-* Strive for minimalism.
+- If users become unsure, they read the description. Make sure this explains what will happen.
+- Strive for minimalism.
 
 ## Buttons and X-icon
-* Keep the labels short, for example `Save`, `Delete`, `Enable`.
+
-* Dialog with actions must always have a discard button. On desktop a `Cancel` button and X-icon, on mobile only the X-icon.
+- Keep the labels short, for example `Save`, `Delete`, `Enable`.
-* Destructive actions should be a red warning button.
+- Dialog with actions must always have a discard button. On desktop a `Cancel` button and X-icon, on mobile only the X-icon.
-* Alert or confirmation dialogs only have buttons and no X-icon.
+- Destructive actions should be a red warning button.
-* Try to avoid three buttons in one dialog. Especially when you leave the dialog task unfinished.
+- Alert or confirmation dialogs only have buttons and no X-icon.
+- Try to avoid three buttons in one dialog. Especially when you leave the dialog task unfinished.
 
 ## Example
+
 ### Confirmation dialog
+
 > **Delete dashboard?**
 >
 > Dashboard [dashboard name] will be permanently deleted from Home Assistant.

gallery/src/pages/components/ha-gauge.markdown

@@ -32,7 +32,6 @@ Error color gauge
 Gauge with background color
 <ha-gauge value="75" style="--gauge-color: var(--info-color); --primary-background-color: lightgray"></ha-gauge>
 
-
 ## CSS variables
 
 ### Gauge

gallery/src/pages/concepts/home.markdown

@@ -7,18 +7,21 @@ title: Home
 This portal aims to aid designers and developers on improving the Home Assistant interface. It consists of working code, resources and guidelines.
 
 ## Home Assistant interface
+
 The Home Assistant frontend allows users to browse and control the state of their home, manage their automations and configure integrations. The frontend is designed as a mobile-first experience. It is a progressive web application and offers an app-like experience to our users. The Home Assistant frontend needs to be fast. But it also needs to work on a wide range of old devices.
 
 ### Material Design
+
 The Home Assistant interface is based on Material Design. It's a design system created by Google to quickly build high-quality digital experiences. Components and guidelines that are custom made for Home Assistant are documented on this portal. For all other components check <a href="https://material.io" rel="noopener noreferrer" target="_blank">material.io</a>.
 
 ## Designers
+
 We want to make it as easy for designers to contribute as it is for developers. There’s a lot a designer can contribute to:
 
 - Meet us at <a href="https://discord.gg/BPBc8rZ9" rel="noopener noreferrer" target="_blank">devs_ux Discord</a>. Feel free to share your designs, user test or strategic ideas.
 - Start designing with our <a href="https://www.figma.com/community/file/967153512097289521/Home-Assistant-DesignKit" rel="noopener noreferrer" target="_blank">Figma DesignKit</a>.
 - Find the lates UX <a href="https://github.com/home-assistant/frontend/discussions?discussions_q=label%3Aux" rel="noopener noreferrer" target="_blank">discussions</a> and <a href="https://github.com/home-assistant/frontend/labels/ux" rel="noopener noreferrer" target="_blank">issues</a> on GitHub. Everyone can start a new issue or discussion!
 
-
 ## Developers
+
 Everything you need to get started developing can be found in our <a href="https://developers.home-assistant.io" rel="noopener noreferrer" target="_blank">Home Assistant Developer Docs</a>.

gallery/src/pages/lovelace/introduction.markdown

@@ -1,6 +1,7 @@
 ---
 title: Introduction
 ---
+
 Dashboards have many different cards. Each card allows the user to tell
 a different story about what is going on in their house. These cards
 are very customizable, as no household is the same.

gallery/src/pages/user-test/configuration-menu.markdown

@@ -6,197 +6,217 @@ title: "User Test: Configuration menu"
 
 At the end of last year, we created one Configuration menu by merging Supervisor. In the next iteration, we want to organize our menu by creating logical grouping and combining duplicated features. We are conducting this test to see if we are on the right track.
 
-* Anyone could join
+- Anyone could join
-* Respondents recruited on Twitter, Reddit and Home Assistant Forum
+- Respondents recruited on Twitter, Reddit and Home Assistant Forum
-* This test is open for 10 days 
+- This test is open for 10 days
-* UsabilityHub for user test
+- UsabilityHub for user test
-* Figma for prototype
+- Figma for prototype
-* 6 questions
+- 6 questions
-* 3 tasks
+- 3 tasks
-* Due to some limitations by UsabilityHub, it only worked on desktop
+- Due to some limitations by UsabilityHub, it only worked on desktop
 
 # Results
+
 915 respondents took part in this test and they gave 407 comments. In general there isn’t a significant difference between:
 
-* How long a respondent has been using Home Assistant
+- How long a respondent has been using Home Assistant
-* Installation method
+- Installation method
-* How many visits to its Home Assistant in the past 3 months
+- How many visits to its Home Assistant in the past 3 months
-* Home Assistant expertise
+- Home Assistant expertise
 
 ## Overall menu change
+
 This prototype organized our menu by creating logical grouping and combining duplicated features. What do people think of this change?
 
 ### Stats
-* 2% (21) Like extremely
-* 30% (276) Like very much
-* 53% (481) Neutral
-* 12% (108) Dislike very much
-* 3% (26) Dislike extremely
 
-*3 respondents passed*
+- 2% (21) Like extremely
+- 30% (276) Like very much
+- 53% (481) Neutral
+- 12% (108) Dislike very much
+- 3% (26) Dislike extremely
+
+_3 respondents passed_
 
 ### Comments summary
+
 **Like**
 
-* Clean and decluttered
+- Clean and decluttered
-* Style looks better
+- Style looks better
-* Faster to use
+- Faster to use
-* Merging Supervisor into different pages
+- Merging Supervisor into different pages
-* Moving Developer tools to Settings
+- Moving Developer tools to Settings
 
 **Dislike**
 
-* Moving Developer tools to Settings
+- Moving Developer tools to Settings
-* More clicks for scripts and helpers
+- More clicks for scripts and helpers
-* Too many changes at once causes a high learning curve
+- Too many changes at once causes a high learning curve
-* Removing the word `Integrations` makes it harder to find them
+- Removing the word `Integrations` makes it harder to find them
-* Difference between `Addons` and `Services` is a bit subtle
+- Difference between `Addons` and `Services` is a bit subtle
-* No clear distinction between `Developer` and `System`
+- No clear distinction between `Developer` and `System`
-* Material Design got the Google image
+- Material Design got the Google image
 
 **Suggestions**
 
-* More top level menu items for example logs.
+- More top level menu items for example logs.
-* What are settings and what not? Maybe better to name it `Configuration`
+- What are settings and what not? Maybe better to name it `Configuration`
-* Devices are a first-class citizen in the domain of Home Assistant, and so shouldn't be tucked away in "Settings"
+- Devices are a first-class citizen in the domain of Home Assistant, and so shouldn't be tucked away in "Settings"
-* Rename Developer tools (or make it only for Home Assistant developers)
+- Rename Developer tools (or make it only for Home Assistant developers)
-* Separate administration (for instance creating users / adding lights etc) from development activities (creating automations and scripts)
+- Separate administration (for instance creating users / adding lights etc) from development activities (creating automations and scripts)
-* Search Bar in Settings
+- Search Bar in Settings
-* Feature to put menu items in sidebar
+- Feature to put menu items in sidebar
-* Unification of add-ons and integrations
+- Unification of add-ons and integrations
-* Adding ‘New’ hints to show what changed
+- Adding ‘New’ hints to show what changed
-* Give `About` a less prominent size
+- Give `About` a less prominent size
-* Accordion view option which puts every tab below
+- Accordion view option which puts every tab below
-* Dev mode and a Prod Mode
+- Dev mode and a Prod Mode
-* Always show config menu (on bigger screens)
+- Always show config menu (on bigger screens)
 
 ### Conclusion
+
 We should keep our focus on organizing our menu by creating logical grouping and combining duplicated features. With these changes we make more people happy:
 
-* Reconsider putting `Logs` as a top-level menu item
+- Reconsider putting `Logs` as a top-level menu item
-* Add a search bar
+- Add a search bar
-* Use the word `Integrations` with `Devices & Services`
+- Use the word `Integrations` with `Devices & Services`
-* Moving `Developer tools` to `Settings` is a good idea
+- Moving `Developer tools` to `Settings` is a good idea
-* Rename `Developer tools` to for example `Tools`
+- Rename `Developer tools` to for example `Tools`
-* Add `New` explanation popups to what has changed
+- Add `New` explanation popups to what has changed
-* We could rename `Configuration` to `Settings`
+- We could rename `Configuration` to `Settings`
-* Give `About` a less prominent size
+- Give `About` a less prominent size
 
 ## Helpers
+
 In Home Assistant you can create toggles, text fields, number sliders, timers and counters. Also known as `Helpers`. Where should they be placed?
 
 ### Stats
-* 78% (709) respondents are using helpers. They use it for:
+
-* 92% (645) automations and scenes
+- 78% (709) respondents are using helpers. They use it for:
-* 62% (422) dashboards
+- 92% (645) automations and scenes
-* 43% (296) virtual devices
+- 62% (422) dashboards
+- 43% (296) virtual devices
 
 ### Comments summary
+
 Some respondents commented that they think `Helpers` shouldn’t be listed under `Automations & Services`. Although almost all respondents use it for that specific purpose.
 
 ### Conclusion
+
 Helpers is, in addition to `Automations & Services`, also partly seen as virtual devices and dashboard entities.
 
-* We might consider promoting them in their own top-level menu item
+- We might consider promoting them in their own top-level menu item
-* Rename `Helpers` to something with `controls`
+- Rename `Helpers` to something with `controls`
 
 ## Add person
+
 The first task in this user test was to add a person. Since this has not changed in the current menu structure, this should be an easy assignment. How do people experience the navigation to this feature?
 
 ### Stats
+
 95% reached the goal screen and 98% marked the task as completed. There were 18 common paths.
 
 After the task we asked how easy it was to add a person.
 
-* 41% (378) Extremely easy
+- 41% (378) Extremely easy
-* 48% (440) Fairly easy
+- 48% (440) Fairly easy
-* 7% (67) Neutral
+- 7% (67) Neutral
-* 2% (19) Somewhat difficult
+- 2% (19) Somewhat difficult
-* 1% (11) Very difficult
+- 1% (11) Very difficult
 
 ### Comments summary
-*No mentionable comments *
+
+_No mentionable comments _
 
 ### Conclusion
+
 This test showed that the current navigation design works.
 
 ## YAML
+
 In Home Assistant you can make configuration changes in YAML files. To make these changes take effect you have to reload your YAML in the UI or do a restart. How are people doing this and can they find it in this new design?
 
 ### Stats
+
 83% reached the goal screen and 87% marked the task as completed. There were 59 common paths.
 
 After the task we asked how easy it was to reload the YAML changes.
 
-* 4% (40) Extremely easy
+- 4% (40) Extremely easy
-* 22% (204) Fairly easy
+- 22% (204) Fairly easy
-* 20% (179) Neutral
+- 20% (179) Neutral
-* 37% (336) Somewhat difficult
+- 37% (336) Somewhat difficult
-* 17% (156) Very difficult
+- 17% (156) Very difficult
 
 And we asked if they have seen that we've moved some functionality from current `Server Controls` to `Developer Tools`.
 
-* 57% (517) Yes
+- 57% (517) Yes
-* 43% (398) No
+- 43% (398) No
 
 ### Comments summary
+
 **Like**
 
-* YAML in Developer tools
+- YAML in Developer tools
 
 **Dislike**
 
-* Hidden restart and reload
+- Hidden restart and reload
-* YAML in Developer Tools
+- YAML in Developer Tools
-* Combining `Developer tools` with `Server management`
+- Combining `Developer tools` with `Server management`
-* Reload Home Assistant button isn't clear what it does
+- Reload Home Assistant button isn't clear what it does
-* Reload/restart Home Assistant in Developer Tools
+- Reload/restart Home Assistant in Developer Tools
 
 **Suggestions**
 
-* Reload all YAML button
+- Reload all YAML button
-* Dev mode and a Prod Mode
+- Dev mode and a Prod Mode
-* Show restart/reload as buttons in System instead of overflow menu
+- Show restart/reload as buttons in System instead of overflow menu
-* Explain that you can reload YAML when you want to restart your system
+- Explain that you can reload YAML when you want to restart your system
-* YAML reloading under System 
+- YAML reloading under System
 
 ### Conclusion
+
 This test showed two different kinds of user groups: UI and YAML users.
 
-* Moving `Developer tools` to `Settings` is a good idea
+- Moving `Developer tools` to `Settings` is a good idea
-* YAML users want reload YAML and Home Assistant restart in `System`
+- YAML users want reload YAML and Home Assistant restart in `System`
-* Move the restart and reload button to the `System` page from the overflow menu
+- Move the restart and reload button to the `System` page from the overflow menu
-* Add suggestion to reload YAML when a user wants to restart
+- Add suggestion to reload YAML when a user wants to restart
-* Add reload all YAML button
+- Add reload all YAML button
 
 ## Logs
+
 ### Stats
+
 70% reached the goal screen and 77% marked the task as completed. There were 48 common paths.
 
 After the task we asked to find out why your Elgato light isn't working.
 
-* 6% (57) Extremely easy
+- 6% (57) Extremely easy
-* 28% (254) Fairly easy
+- 28% (254) Fairly easy
-* 21% (188) Neutral
+- 21% (188) Neutral
-* 21% (196) Somewhat difficult
+- 21% (196) Somewhat difficult
-* 24% (220) Very difficult
+- 24% (220) Very difficult
 
 ### Comments summary
 
 **Suggestions**
 
-* Log errors on the integration page
+- Log errors on the integration page
-* Problem solving center
+- Problem solving center
 
 ### Conclusion
+
 Although this test shows that a large number of respondents manage to complete the task, they find it difficult to find out the light isn’t working.
 
-* Add logs errors/warnings to the integration page
+- Add logs errors/warnings to the integration page
-* Reconsider putting `Logs` as a top-level menu item
+- Reconsider putting `Logs` as a top-level menu item
 
 ## Learnings for next user test
-* Explain that topic is closed for comments so that you can do this test without any influence
-* Mobile test should work on mobile
-* Testing on an iPad got some bugs
-* People like doing these kind of test and we should do them more often
 
+- Explain that topic is closed for comments so that you can do this test without any influence
+- Mobile test should work on mobile
+- Testing on an iPad got some bugs
+- People like doing these kind of test and we should do them more often

lint-staged.config.js

@@ -1,6 +1,6 @@
 export default {
   "*.?(c|m){js,ts}": ["eslint --fix", "prettier --write"],
-  "!(/translations)*.{json,css,md,html}": "prettier --write",
+  "*.{json,css,md,markdown,html,y?aml}": "prettier --write",
   "translations/*/*.json": (files) =>
     'printf "%s\n" "Translation files should not be added or modified here. Instead, make the necessary modifications in src/translations/en.json. Other languages are managed externally. Please see https://developers.home-assistant.io/docs/translations/ for details." ' +
     files.join(" ") +

package.json

@@ -10,8 +10,8 @@
     "build": "script/build_frontend",
     "lint:eslint": "eslint \"**/src/**/*.{js,ts,html}\" --ignore-path .gitignore",
     "format:eslint": "eslint \"**/src/**/*.{js,ts,html}\" --fix --ignore-path .gitignore",
-    "lint:prettier": "prettier \"**/src/**/*.{js,ts,json,css,md}\" --check",
+    "lint:prettier": "prettier . --check",
-    "format:prettier": "prettier \"**/src/**/*.{js,ts,json,css,md}\" --write",
+    "format:prettier": "prettier . --write",
     "lint:types": "tsc",
     "lint:lit": "lit-analyzer \"**/src/**/*.ts\" --format markdown --outFile result.md",
     "lint": "yarn run lint:eslint && yarn run lint:prettier && yarn run lint:types",