iobroker.tidy 0.1.5 → 0.1.7

package/README.md

@@ -9,7 +9,7 @@
 
 [![COMMUNITY](https://img.shields.io/badge/community%20-ioBroker%20|%20forum-blue.svg)](https://forum.iobroker.net/topic/84331/tidy-adapter-alpha)
 [![MAINTAINER](https://img.shields.io/badge/maintainer-skvarel%20@%20inventwo-yellowgreen.svg)](https://github.com/skvarel)
-[![AI](https://img.shields.io/badge/ai%20assisted-cursor-blue.svg)](https://github.com/inventwo/ioBroker.tidy/blob/main/.cursor/rules/iobroker-adapter.mdc)
+[![AI](https://img.shields.io/badge/ai%20assisted-cursor-blue.svg)](https://github.com/inventwo/ioBroker.tidy/blob/main/.cursor/iobroker-adapter.mdc)
 
 [![Paypal Donation](https://img.shields.io/badge/paypal-donate%20|%20spenden-green.svg)](https://www.paypal.com/donate/?hosted_button_id=7W6M3TFZ4W9LW)
 
@@ -31,6 +31,8 @@ The **Tidy** adapter helps to find unused objects and states to clean up your sy
   - Configurable age thresholds for "stale" and "dead" detection
   - Optional automatic scanning at configurable intervals (hourly)
   - Enable/disable individual scan paths
+  - Optional complete scan of the entire object tree
+- **🌐 Complete scan**: Scan all states in the system (not limited to configured paths) via a separate result channel
 - **🎯 Manual triggers**: Each configured path gets a trigger button to run scans on demand
 - **📋 JSON table output**: Results are provided as JSON arrays, perfect for table widgets in VIS
 - **📈 Statistics**: Automatic counters for total, dead, stale, and orphaned datapoints
@@ -40,6 +42,7 @@ The **Tidy** adapter helps to find unused objects and states to clean up your sy
 ### General Settings
 
 - **Enable automatic scans**: When enabled, all configured paths are scanned automatically
+- **Scan all objects (complete)**: When enabled, the adapter scans the entire object tree and stores results in a separate `complete` channel (see below)
 - **Scan interval**: How often automatic scans should run (in hours, minimum 1)
 - **Days until 'stale'**: Datapoints not updated for this many days are marked as stale (warning)
 - **Days until 'dead'**: Datapoints not updated for this many days are marked as dead (critical)
@@ -65,6 +68,18 @@ For each configured path (e.g., "userdata"), the adapter creates:
 - **`tidy.0.userdata.staleCount`** (number): Number of stale datapoints
 - **`tidy.0.userdata.orphanedCount`** (number): Number of orphaned aliases
 
+When **Scan all objects (complete)** is enabled in the general settings, the adapter additionally creates:
+
+- **`tidy.0.complete.trigger`** (button): Click to manually start a complete scan
+- **`tidy.0.complete.result`** (json): Scan results for all states in the system
+- **`tidy.0.complete.lastScan`** (timestamp): When the last complete scan was performed
+- **`tidy.0.complete.count`** (number): Total datapoints found
+- **`tidy.0.complete.deadCount`** (number): Number of dead datapoints
+- **`tidy.0.complete.staleCount`** (number): Number of stale datapoints
+- **`tidy.0.complete.orphanedCount`** (number): Number of orphaned aliases
+
+The complete scan uses the same JSON result structure as path-based scans. Automatic scans include the complete scan when this option is enabled.
+
 ### JSON Result Structure
 
 The `result` state contains a JSON array with the following fields for each datapoint:
@@ -132,6 +147,15 @@ Use the JSON result with a table widget to display and sort your datapoints:
 4. Sort by `last_ts` (oldest first) to find the "deadest" datapoints
 5. Filter by `issue != null` to show only problematic datapoints
 
+### Complete Scan
+
+1. Enable **Scan all objects (complete)** in the general settings
+2. Save configuration — the adapter performs an initial complete scan
+3. View results in `tidy.0.complete.result`
+4. Use `tidy.0.complete.trigger` for manual rescans at any time
+
+Use the complete scan to get an overview of all states in your instance. For targeted cleanup, path-based scans (e.g. `0_userdata.0`, `alias.0`) are usually more practical.
+
 ### Automatic Maintenance
 
 1. Enable "automatic scans" in settings
@@ -150,6 +174,18 @@ If you like our work and would like to support us, we appreciate any donation.
 <!--
 	### **WORK IN PROGRESS**
 -->
+### 0.1.7 (2026-06-07)
+- (skvarel) Migrated project rules from GitHub Copilot to Cursor rules
+- (skvarel) Fixed adapter checker warning for automatic scan interval
+
+### 0.1.6 (2026-05-31)
+- (skvarel) Fixed scan when path name is left empty (result states now use path as fallback)
+- (skvarel) Added default for scan-all-objects option in adapter configuration
+- (skvarel) Fixed incorrect link to Cursor project rules in README
+- (skvarel) Unified issue tracker URL to inventwo repository
+- (skvarel) Fixed type-check script for local development
+- (skvarel) Documented complete scan feature in README
+
 ### 0.1.5 (2026-05-29)
 - (skvarel) Updated dependencies
 - (skvarel) Fixed repo checker issue
@@ -160,13 +196,6 @@ If you like our work and would like to support us, we appreciate any donation.
 ### 0.1.3 (2026-05-24)
 - (skvarel) Fixed repo checker issue
 
-### 0.1.1 (2026-04-18)
-- (skvarel) Changed name of result field to optional
-- (skvarel) Revised config
-
-### 0.1.0 (2026-04-17)
-- (skvarel) Added option for complete scan
-
 ## Older changes
 - [CHANGELOG_OLD.md](CHANGELOG_OLD.md)
 

package/io-package.json

@@ -1,8 +1,34 @@
 {
   "common": {
     "name": "tidy",
-    "version": "0.1.5",
+    "version": "0.1.7",
     "news": {
+      "0.1.7": {
+        "en": "Migrated project rules from GitHub Copilot to Cursor rules\nFixed adapter checker warning for automatic scan interval",
+        "de": "Geförderte Projektregeln von GitHub Copilot zu Cursor-Regeln\nFeste Adapter-Checker-Warnung für automatisches Scanintervall",
+        "ru": "Миграционные правила проекта от GitHub Copilot до Cursor\nПредупреждение о проверке адаптера для автоматического интервала сканирования",
+        "pt": "Regras de projeto modificadas do Copiloto GitHub para as regras do Cursor\nAviso de verificação fixa do adaptador para intervalo de varredura automática",
+        "nl": "Migrated project regels van GitHub Copilot naar Cursor regels\nWaarschuwing voor vaste adaptercontrole voor automatisch scaninterval",
+        "fr": "Règles de projet modifiées du copilote GitHub aux règles Cursor\nAvertissement de vérification de l'adaptateur fixe pour l'intervalle de balayage automatique",
+        "it": "Regole di progetto migrate da GitHub Copilot a regole Cursor\nAvvertenza a scacchi per adattatore fisso per intervallo di scansione automatico",
+        "es": "Migrated project rules from GitHub Copilot to Cursor rules\nAviso de control de adaptador fijo para intervalo de escaneo automático",
+        "pl": "Migrowane zasady projektu z GitHub Copilot do zasad kursora\nOstrzeżenie dotyczące automatycznego skanowania",
+        "uk": "Миттєві правила проекту від GitHub Copilot до правил Cursor\nВиправлено попередження перевірки адаптера для автоматичного інтервалу сканування",
+        "zh-cn": "从 GitHub 副驾驶到光标规则\n自动扫描间隔的固定适配器检查器警告"
+      },
+      "0.1.6": {
+        "en": "Fixed scan when path name is left empty (result states now use path as fallback)\nAdded default for scan-all-objects option in adapter configuration\nFixed incorrect link to Cursor project rules in README\nUnified issue tracker URL to inventwo repository\nFixed type-check script for local development\nDocumented complete scan feature in README",
+        "de": "Behobener Scan, wenn der Pfadname leer gelassen wird (Ergebnisse Zustände verwenden nun Pfad als Fallback)\nStandard für Scan-all-Objekte Option in Adapterkonfiguration hinzugefügt\nFehlerhafte Verknüpfung mit Cursor-Projektregeln in README behoben\nUnified Ausgabe Tracker URL zu erfindenwo Repository\nFixed Type-Check-Skript für lokale Entwicklung\nDokumentierte vollständige Scan-Funktion in README",
+        "ru": "Исправленное сканирование, когда имя пути оставлено пустым (в результате состояния теперь используют путь в качестве резерва)\nДобавлено по умолчанию для опции сканирования всех объектов в конфигурации адаптера\nИсправлена неправильная ссылка на правила проекта Cursor в README\nUnified Issue Tracker URL для создания репозитория\nФиксированный скрипт проверки типа для локальной разработки\nПолная функция сканирования в README",
+        "pt": "Varredura fixa quando o nome do caminho fica vazio (os estados de resultado agora usam o caminho como recuo)\nAdicionado por omissão para a opção scan-all-objects na configuração do adaptador\nLigação incorreta fixa às regras do projeto Cursor no README\nURL unificado do rastreador de problemas para inventar o repositório\nPrograma de verificação de tipo fixo para desenvolvimento local\nFuncionalidade de digitalização completa documentada no README",
+        "nl": "Fixed scan wanneer padnaam leeg gelaten wordt (resultaattoestanden gebruiken nu pad als terugval)\nStandaard toegevoegd voor optie scan-all-objecten in adapterconfiguratie\nOnjuiste link naar Cursor-projectregels in README\nUnified issue tracker URL naar inventwo repository\nVast typecontrolescript voor lokale ontwikkeling\nGedocumenteerde volledige scanfunctie in README",
+        "fr": "Correction de l'analyse lorsque le nom du chemin est laissé vide (les états de résultat utilisent maintenant le chemin comme retour)\nAjout par défaut de l'option scanner tous les objets dans la configuration de l'adaptateur\nCorrection d'un lien incorrect vers les règles du projet Cursor dans README\nURL de tracker de problèmes unifiée vers le dépôt inventwo\nCorrection du script de vérification de type pour le développement local\nFonction de numérisation complète documentée dans README",
+        "it": "Controllo fisso quando il nome del percorso viene lasciato vuoto (i risultati ora usano il percorso come fallback)\nAggiunta di default per scan-all-objects opzione nella configurazione dell'adattatore\nFisso collegamento errato alle regole del progetto Cursor in README\nURL del tracciatore di numeri unificato inventwo repository\nScript di controllo del tipo fisso per lo sviluppo locale\nFunzione di scansione completa documentata in README",
+        "es": "Escaneo fijo cuando el nombre de la ruta queda vacío (resulta estados ahora utilizan la ruta como retroceso)\nAñadido predeterminado para la opción Scan-all-objects en la configuración del adaptador\nEnlace incorrecto fijo a las reglas del proyecto Cursor en README\nUnified issue tracker URL para inventwo repository\nScript de comprobación de tipo fijo para el desarrollo local\nFunción de exploración completa documentada en README",
+        "pl": "Naprawiono skanowanie, gdy nazwa ścieżki jest pusta (stan wyniku używa ścieżki jako zapasu)\nDodano domyślne dla opcji scan- all- objects w konfiguracji adaptera\nNaprawiono nieprawidłowe łącze do zasad projektu kursora w README\nUnified issue tracker URL do wynalazku dwóch repozytorium\nStałe skrypty sprawdzania typu dla rozwoju lokalnego\nKompletna funkcja skanowania w README",
+        "uk": "Виправлено сканування, коли ім'я шляху залишається порожнім (результні стани тепер використовують шлях як випадання)\nДодано за замовчуванням для налаштування скан-all-objects\nВиправлено некоректне посилання на правила проекту Cursor в README\nУніфікований URL-адреса трекера для inventwo repository\nВиправлений сценарій типу-подібним вирізом для місцевого розвитку\nФункція повного сканування документів в README",
+        "zh-cn": "当路径名称为空时进行固定扫描( 结果状态现在使用路径作为倒置)\n在适配器配置中添加了扫描全部对象选项的默认值\n与 README 中的光标项目规则的固定错误链接\n统一问题跟踪器 URL 到 Inventwo 仓库\n本地开发的固定类型检查脚本\n在 README 中记录了完整的扫描功能"
+      },
       "0.1.5": {
         "en": "Updated dependencies\nFixed repo checker issue",
         "de": "Aktualisierte Abhängigkeiten\nProblem der Repo Checker behoben",
@@ -67,19 +93,6 @@
         "pl": "Dodano opcję do pełnego skanowania",
         "uk": "Додано варіант для повного сканування",
         "zh-cn": "添加完整扫描选项"
-      },
-      "0.0.1": {
-        "en": "initial release",
-        "de": "Erstveröffentlichung",
-        "ru": "Начальная версия",
-        "pt": "lançamento inicial",
-        "nl": "Eerste uitgave",
-        "fr": "Première version",
-        "it": "Versione iniziale",
-        "es": "Versión inicial",
-        "pl": "Pierwsze wydanie",
-        "uk": "Початкова версія",
-        "zh-cn": "首次出版"
       }
     },
     "titleLang": {
@@ -148,6 +161,7 @@
   },
   "native": {
     "autoScan": false,
+    "scanAllObjects": false,
     "scanInterval": 24,
     "daysUntilStale": 90,
     "daysUntilDead": 365,

package/main.js

@@ -59,7 +59,7 @@ class Tidy extends utils.Adapter {
 		if (this.config.autoScan && this.config.scanInterval > 0) {
 			const intervalMs = this.config.scanInterval * 60 * 60 * 1000; // Convert hours to milliseconds
 			this.log.info(`Automatic scanning enabled: Every ${this.config.scanInterval} hour(s)`);
-			this.scanInterval = setInterval(async () => {
+			this.scanInterval = this.setInterval(async () => {
 				this.log.info('Running automatic scan...');
 				await this.scanAllPaths();
 				if (this.config.scanAllObjects) {
@@ -231,7 +231,7 @@ class Tidy extends utils.Adapter {
 		try {
 			// Clear automatic scan interval
 			if (this.scanInterval) {
-				clearInterval(this.scanInterval);
+				this.clearInterval(this.scanInterval);
 				this.scanInterval = undefined;
 			}
 
@@ -251,9 +251,7 @@ class Tidy extends utils.Adapter {
 				continue;
 			}
 
-			// Fallback: use path if name is empty
-			const effectiveName = pathConfig.name && pathConfig.name.trim() ? pathConfig.name : pathConfig.path;
-			const channelId = this.sanitizeName(effectiveName);
+			const channelId = this.getChannelId(pathConfig);
 
 			// Create channel
 			await this.setObjectNotExistsAsync(channelId, {
@@ -392,9 +390,7 @@ class Tidy extends utils.Adapter {
 			// Find the corresponding path config
 			const channelId = id.replace(`${this.namespace}.`, '').replace('.trigger', '');
 			// Fallback: match also if name is empty and path is used
-			const pathConfig = this.config.paths.find(
-				p => this.sanitizeName(p.name && p.name.trim() ? p.name : p.path) === channelId,
-			);
+			const pathConfig = this.config.paths.find(p => this.getChannelId(p) === channelId);
 
 			if (pathConfig && pathConfig.enabled) {
 				await this.scanPath(pathConfig);
@@ -415,7 +411,7 @@ class Tidy extends utils.Adapter {
 	 */
 	async scanAllPaths() {
 		for (const pathConfig of this.config.paths) {
-			if (pathConfig.enabled) {
+			if (pathConfig.enabled && (pathConfig.name || pathConfig.path)) {
 				await this.scanPath(pathConfig);
 			}
 		}
@@ -431,7 +427,7 @@ class Tidy extends utils.Adapter {
 		this.log.info(`Scanning path: ${pathConfig.path}`);
 
 		try {
-			const channelId = this.sanitizeName(pathConfig.name);
+			const channelId = this.getChannelId(pathConfig);
 			const results = [];
 
 			// Get all objects under the specified path
@@ -575,6 +571,17 @@ class Tidy extends utils.Adapter {
 		return result;
 	}
 
+	/**
+	 * Resolve channel ID from path config (name with fallback to path)
+	 *
+	 * @param {object} pathConfig - Path configuration object
+	 * @returns {string} Sanitized channel ID
+	 */
+	getChannelId(pathConfig) {
+		const effectiveName = pathConfig.name && pathConfig.name.trim() ? pathConfig.name : pathConfig.path;
+		return this.sanitizeName(effectiveName);
+	}
+
 	/**
 	 * Sanitize name for use as object ID
 	 *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.tidy",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Analyzes ioBroker objects for unused datapoints and helps you clean up your instance",
   "author": {
     "name": "skvarel",
@@ -31,7 +31,7 @@
     "@iobroker/adapter-core": "^3.3.2"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^5.2.0",
+    "@alcalzone/release-script": "^5.2.1",
     "@alcalzone/release-script-plugin-iobroker": "^5.2.0",
     "@alcalzone/release-script-plugin-license": "^5.2.0",
     "@alcalzone/release-script-plugin-manual-review": "^5.2.0",
@@ -49,7 +49,6 @@
     "admin{,/!(src)/**}/!(tsconfig|tsconfig.*|.eslintrc).{json,json5}",
     "admin{,/!(src)/**}/*.{html,css,png,svg,jpg,js}",
     "lib/",
-    "www/",
     "io-package.json",
     "LICENSE",
     "main.js"
@@ -70,7 +69,7 @@
     "dev-server:stop": "powershell -NonInteractive -Command \"Get-NetTCPConnection -LocalPort 8091,26436,24436,20436 -EA SilentlyContinue | Select-Object -ExpandProperty OwningProcess -Unique | ForEach-Object { Stop-Process -Id $_ -Force -EA SilentlyContinue }; Write-Host 'dev-server stopped'\""
   },
   "bugs": {
-    "url": "https://github.com/skvarel/ioBroker.tidy/issues"
+    "url": "https://github.com/inventwo/ioBroker.tidy/issues"
   },
   "readmeFilename": "README.md"
 }