Refactor configuration files

2025-06-25 01:21:52 +02:00 · 2025-05-28 18:20:20 +02:00
parent f29a90da9d
commit 6a2e64f6ad
7 changed files with 62 additions and 83 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@ -21,7 +21,6 @@
  "ignorePatterns": [
    "dist/",
    "node_modules/",
-    "*.js",
    "src/types/homeassistant/",
    "src/types/lovelace-mushroom/"
  ],
--- a/.markdownlint.jsonc
+++ b/.markdownlint.jsonc
@ -1,22 +1,18 @@
 {
-  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema.json",
+  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema-strict.json",
  "default": true,
  "MD013": {
    "line_length": 120,
    "code_block_line_length": 120,
    "heading_line_length": 80,
-    "tables": false
+    "tables": false,
  },
  "MD024": {
-    "siblings_only": true
+    "siblings_only": true,
  },
  "MD033": {
-    "allowed_elements": [
-      "br",
-      "summary",
-      "details"
-    ]
+    "allowed_elements": ["br", "summary", "details"],
  },
  "MD040": false,
-  "MD046": false
+  "MD046": false,
 }
--- a/.prettierrc
+++ b/.prettierrc
@ -9,6 +9,5 @@
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
-  "trailingComma": "all",
  "useTabs": false
 }
--- a/README.md
+++ b/README.md
@ -1,62 +1,65 @@
-# Mushroom dashboard strategy
+# Mushroom Dashboard Strategy 🍄✨

 [![Release][releaseBadge]][releaseUrl]
 [![HACS][hacsBadge]][hacsUrl]
 [![Codacy][codacyBadge]][codacyUrl]

+---
+
+**Effortlessly create stunning Home Assistant Dashboards with the Mushroom Dashboard Strategy!**
+
+* Are you tired of manually configuring your Home Assistant dashboards?
+  Do you love the elegant design of Mushroom cards but wish for a simpler way to organize your entities,
+  devices, and areas?
+
+The **Mushroom Dashboard Strategy** is your solution.
+It automatically generates beautiful, organized dashboards for Home Assistant,
+leveraging the power and aesthetics of Mushroom cards with minimal configuration.
+
+---
+
+## ⭐ **Why Choose Mushroom Dashboard Strategy?**
+
+* **⚡️ Automatic Dashboard Generation:** Go from zero to a beautiful dashboard with just a few lines of YAML.
+* **🏡 Intelligent Organization:** Automatically creates intuitive views for your devices, areas, and entities.
+* **🎨 Highly Customizable:** Tailor your dashboard to your unique smart home setup with extensive options.
+* **📈 Integrated Insights:** Seamlessly displays mini graph cards for your sensor data.
+
+---
+
+## 🚀 **Get Started in Minutes!**
+
+Ready to transform your Home Assistant experience?
+
+The **Mushroom Dashboard Strategy** is available through HACS (Home Assistant Community Store).
+
+➡️ *
+*[Explore the detailed documentation for Installation & Usage Guides!](https://digilive.github.io/mushroom-strategy/)**
+
+---
+
+## 📸 **Sneak Peek**
+
 ![Preview GIF](docs/images/preview.gif)

-<details>
-  <summary>More images...</summary>
+---

-![Automatic](docs/images/auto.png)
+## 🤝 **Contributing & Support**

-![Views](docs/images/views.png)
+We welcome contributions and feedback!

-![customizable](docs/images/customizable.png)
-</details>
+* Have questions or need help?
+  Check out our [Discussions](https://github.com/DigiLive/mushroom-strategy/discussions) page.

-## What is the Mushroom Dashboard Strategy?
+* Found a bug or have an idea?
+  Open an [Issue](https://github.com/DigiLive/mushroom-strategy/issues).

-Mushroom Dashboard Strategy provides a strategy for Home Assistant to automatically generate a dashboard
-using [Mushroom][mushroomUrl] cards.
+* Enjoying the Mushroom Strategy?
+  Consider giving our project a ⭐ [star on GitHub](https://github.com/DigiLive/mushroom-strategy) and exploring ways
+  to ❤️ [sponsor the project](https://github.com/sponsors/DigiLive) to support its continued development!
+  Your support helps us grow and improve.

-Dashboard cards are generated for your Home Assistant's entities, devices and areas, divided over several views.
-Starting at the Home view, you can enter an area subview.
-For easy access, separate views are generated for entities which belong to specific domains.
-
-### Features
-
-* 🛠 Automatically create a dashboard with three lines of YAML.
-* 😍 Built-in Views for device-specific controls.
-* 🎨 Many options to customize to fit your needs.
-* 📈 [Mini graph][miniGraphUrl] cards for sensor entities.
-
-> [!TIP]
-> If you like this package, please star the [project at GitHub][repositoryUrl]!
-
-## Getting started
-
-The strategy is easily installable from [HACS][hacsUrl] (Home Assistant Community Store).
-Please visit [Installation Guide][installationUrl] at our Wiki.
-
-## Need some help?
-
-Visit the [Discussions][discussionsUrl] page or
-the [Wiki][wikiUrl].
-
-## Have an idea or want to report a bug?
-
-Make sure your idea or bug isn't discussed already in our Discussions or Issues!
-Visit the [issues][issuesUrl] page.
-
-## Collaborators
-
-* [DigiLive](https://github.com/DigiLive)
-
-  [![Sponsor DigiLive][sponsorBadge]](https://github.com/sponsors/DigiLive)
-
-* [Aalian Khan](https://github.com/AalianKhan)
+---

 <!-- Badge References -->

@ -66,28 +69,12 @@ Visit the [issues][issuesUrl] page.

 [releaseBadge]: https://img.shields.io/github/v/tag/digilive/mushroom-strategy?filter=v2.3.2&label=Release

-[sponsorBadge]: https://img.shields.io/badge/Sponsor_him-%E2%9D%A4-%23db61a2.svg?&logo=github&color=%23fe8e86
-
 <!-- Repository References -->

-[codacyUrl]: https://app.codacy.com/gh/DigiLive/mushroom-strategy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
-
-[repositoryUrl]: https://github.com/DigiLive/mushroom-strategy
-
 [releaseUrl]: https://github.com/DigiLive/mushroom-strategy/releases/tag/v2.3.2

-[issuesUrl]: https://github.com/DigiLive/mushroom-strategy/issues
-
-[discussionsUrl]: https://github.com/DigiLive/mushroom-strategy/discussions
-
-[wikiUrl]: https://github.com/DigiLive/mushroom-strategy/wiki
-
-[installationUrl]: https://github.com/DigiLive/mushroom-strategy/wiki#installation
-
 <!-- Other References -->

+[codacyUrl]: https://app.codacy.com/gh/DigiLive/mushroom-strategy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
+
 [hacsUrl]: https://hacs.xyz
-
-[mushroomUrl]: https://github.com/piitaya/lovelace-mushroom
-
-[miniGraphUrl]: https://github.com/kalkih/mini-graph-card
--- a/hacs.json
+++ b/hacs.json
@ -1,5 +1,5 @@
 {
-  "name": "Mushroom Dashboard Strategy ",
+  "name": "Mushroom Dashboard Strategy",
  "render_readme": true,
  "filename": "mushroom-strategy.js",
  "homeassistant": "2024.7.0"
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -13,23 +13,23 @@ theme:
  icon:
    logo: material/mushroom
  palette:
-    - media: "(prefers-color-scheme: light)"
+    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
+    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: blue
      accent: light blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
-    - media: "(prefers-color-scheme)" # This covers both light and dark system preferences
+    - media: '(prefers-color-scheme)'
      toggle:
-        icon: material/brightness-auto # Icon for automatic mode
+        icon: material/brightness-auto
        name: Switch to light/dark mode (auto)
  features:
    - navigation.tabs
--- a/tsconfig.json
+++ b/tsconfig.json
@ -1,7 +1,5 @@
 {
-  "include": [
-    "src/**/*"
-  ],
+  "include": ["src/**/*", "webpack.config.ts", "webpack.dev.config.ts"],
  "compilerOptions": {
    // 1. Language and Environment
    "target": "ES2020",