Add JSDoc headers to scripts and improve sync-manifest tool#178
Closed
orlin369 wants to merge 49 commits intoALLTERCO:mainfrom
Closed
Add JSDoc headers to scripts and improve sync-manifest tool#178orlin369 wants to merge 49 commits intoALLTERCO:mainfrom
orlin369 wants to merge 49 commits intoALLTERCO:mainfrom
Conversation
- Add AGENTS.md with coding standards, git workflow, and contribution rules - Extract changelog to dedicated CHANGELOG.md file - Add "Who is this for?" section to README.md - Add documentation links (Script Index, Changelog, Contributing, License) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add Claude temporary files - Add Node.js artifacts (node_modules, lock files) - Add build outputs and IDE files - Add OS files, logs, and environment files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- add The Pill collection README and link from root README - register UART peripheral scripts in examples manifest - update changelog for the new collection Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- rename blu-assistant-scripts to blu-assistant - keep BLU assistant files together Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- move BLE sensor and button scripts - include BLU integrations and Hue control Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- consolidate LoRa scripts under lora/ - keep encrypted and cover/light subfolders Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- group MQTT scripts under mqtt/ - include Home Assistant boolean control Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- group load, threshold, and outage scripts - include Victron MPPT integration Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- group switch, input, and cover handlers - include domoticz cover fixes Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- group weather-based automations - include NTC and temperature adjustments Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- group HTTP handlers and notifications - include Prometheus, Pushed, Telegram Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- group provisioning and watchdog scripts - keep network utilities together Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- group scene and schedule utilities - include remoterpc and objects examples Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- point manifest entries at new folders - fix LoRa README doc paths Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- document capability folders in README - refresh AGENTS structure and changelog Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- move and rename the ThingSpeak example - register it in the examples manifest Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- apply .shelly.js suffix to all scripts - keep folder structure unchanged Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh docs and manifest paths - update tool and script references Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- update SHELLY_MJS.md for .shelly.js - note extension rename in changelog Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- document purpose of each examples folder - list scripts in new README files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- relocate TELEGRAM-BOT.md - link guide from http-integrations README Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- document upload and index utilities - include usage and requirements Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- register ble_btn_in_range in manifest - list script in ble README - note addition in changelog Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- add sync-manifest utility - expand manifest integrity checks - document tools usage Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- update SHELLY_MJS.md for latest scripts Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh BLE/BLU scripts - align behavior and comments Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh input and switch howto scripts Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh HTTP handlers and integrations - align comments and defaults Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh LoRa sender/receiver scripts - align defaults and comments Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh MQTT and HA scripts - align comments and defaults Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh watchdog and provisioning examples Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh load management and monitoring Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh scene and schedule utilities Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh input, switch, and cover examples Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh UART peripheral examples - align comments and defaults Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- refresh weather and sensor examples Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Update AGENTS.md with comprehensive code structure pattern - Add two-header documentation standard (metadata + detailed docs) - Include section separator examples (// ====) - Add header guidelines table - Update tools/README.md to reference AGENTS.md for standards Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- make layout folders clickable in README Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- order layout links alphabetically Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Adds standard JSDoc headers to 17 existing scripts across ble, blu-assistant, lora, mqtt, power-energy, switch-input, and weather-env directories. Also adds new Cury Light Language v2 script. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Updates extract_metadata_from_file() to prioritize JSDoc-style headers (@title, @description) over legacy comment patterns. Also updates manifest with 18 new script entries using extracted metadata. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
These files are in EXCLUDE_DIRS and should not be in the manifest. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes:
Added @title and @description JSDoc headers to 17 scripts that were missing them:
ble/ - 2 files (ble-mopeka, ble-PTM215B-button)
blu-assistant/ - 9 files (add-to-wifi, bthome-webhook, config-mqtt, create-demo-virtual-components, delete-all-vcomponents, factory-reset-device, full-config, gen3-update-matter, print-label-online)
lora/ - 1 file (lora-lightcontrol-initiator)
mqtt/ - 1 file (shelly1p-mqtt-autodiscover)
power-energy/ - 1 file (power-threshold-limit-output)
switch-input/ - 2 files (double-press-switch, double-press-double-switch)
weather-env/ - 1 file (script-temperature-adjust)
New script: cury/cury-light-language-2.shelly.js - Expressive light patterns for Shelly Cury with 9 communication states
Fixed tools/sync-manifest.py to support JSDoc-style @title and @description tags (previously only supported // Title: format)
Updated examples-manifest.json with 18 new entries using extracted metadata
Removed 2 excluded _backup entries from manifest (files in EXCLUDE_DIRS shouldn't be listed)
Stats: 20 files changed, 715 insertions(+), 253 deletions(-)