From e1f3feaf008a4cfe1d2ac641077d526f1d8e2891 Mon Sep 17 00:00:00 2001 From: nicodes Date: Tue, 27 Oct 2026 00:08:43 +0100 Subject: [PATCH] Use lowercase product names in user-facing text --- .github/workflows/ci.yml | 2 +- .github/workflows/dependency-policy.yml | 2 +- .github/workflows/release.yml | 2 +- AGENTS.md | 5 +++++ README.md | 10 +++++----- gd/addon/plugin.cfg | 2 +- gd/addon/plugin.gd | 12 ++++++------ tools/package_gd.py | 2 +- tools/verify_gd_package.py | 2 +- 9 files changed, 22 insertions(+), 17 deletions(-) create mode 100644 AGENTS.md diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 16b4ab5..dee9ae5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with: persist-credentials: false - - name: Set up locked Komizo + - name: Set up locked komizo uses: nicodes/komizo/setup@40086036977a5fc0119d6c4c1d5eb6ae3ab3b4b9 env: GH_TOKEN: ${{ github.token }} diff --git a/.github/workflows/dependency-policy.yml b/.github/workflows/dependency-policy.yml index 61b2f6d..ac4a432 100644 --- a/.github/workflows/dependency-policy.yml +++ b/.github/workflows/dependency-policy.yml @@ -44,7 +44,7 @@ jobs: persist-credentials: false ref: main timeout-minutes: 3 - - name: Set up locked Komizo + - name: Set up locked komizo uses: nicodes/komizo/setup@40086036977a5fc0119d6c4c1d5eb6ae3ab3b4b9 env: GH_TOKEN: ${{ github.token }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index c392fae..99144f1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -35,7 +35,7 @@ jobs: with: fetch-depth: 0 persist-credentials: false - - name: Set up locked Komizo + - name: Set up locked komizo uses: nicodes/komizo/setup@40086036977a5fc0119d6c4c1d5eb6ae3ab3b4b9 env: GH_TOKEN: ${{ github.token }} diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..0b7a64c --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,5 @@ +# Repository instructions + +# Product naming + +Use `gd-playwright` in lowercase in user-facing text. Keep language identifiers, environment variables and protocol fields in their technical spelling. Usage documentation is generated from private `nicodes/docs`. diff --git a/README.md b/README.md index 85bc43e..ee8d42e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + # gd-playwright @@ -24,7 +24,7 @@ gdam install @aviorstudio/gd-playwright ### Manual -Copy `gd/addon/` into `res://addons/@aviorstudio_gd-playwright/` and enable `GD Playwright Client` in `Project Settings -> Plugins`. +Copy `gd/addon/` into `res://addons/@aviorstudio_gd-playwright/` and enable `gd-playwright` in `Project Settings -> Plugins`. The plugin installs an autoload named `PlaywrightService`. You can also add `autoload.gd` manually as an autoload with that name. @@ -72,8 +72,8 @@ PlaywrightService.scan_scene() The editor also includes tool menu actions: -- `GD Playwright: Scan Scene For Metadata` -- `GD Playwright: Convert Metadata To Tags` +- `gd-playwright: Scan Scene For Metadata` +- `gd-playwright: Convert Metadata To Tags` Use `PlaywrightEventEmitter` when a scene should author a named event in the Inspector: @@ -296,4 +296,4 @@ See `LICENSE`. ## Repository development -Install the [Komizo release](https://github.com/nicodes/komizo#install) matching `komizo.lock`, then run `komizo check`. The locked addon recipe supplies Godot and templates; the project retains its Go, package and installed-editor checks, plus browser and web-export assertions. Use `komizo run test` for the focused test suite. +Install the [komizo release](https://github.com/nicodes/komizo#install) matching `komizo.lock`, then run `komizo check`. The locked addon recipe supplies Godot and templates; the project retains its Go, package and installed-editor checks, plus browser and web-export assertions. Use `komizo run test` for the focused test suite. diff --git a/gd/addon/plugin.cfg b/gd/addon/plugin.cfg index 5268612..6747cc1 100644 --- a/gd/addon/plugin.cfg +++ b/gd/addon/plugin.cfg @@ -1,5 +1,5 @@ [plugin] -name="GD Playwright" +name="gd-playwright" description="Godot web test bridge for Playwright — event emission and coordinate-free element map." author="Avior Studio" version="0.0.7" diff --git a/gd/addon/plugin.gd b/gd/addon/plugin.gd index 45aac55..ca38eb1 100644 --- a/gd/addon/plugin.gd +++ b/gd/addon/plugin.gd @@ -9,8 +9,8 @@ const PlaywrightTagNodeScript = preload("src/playwright_tag_node.gd") const PlaywrightStatePublisherScript = preload("src/playwright_state_publisher.gd") const PlaywrightEventEmitterScript = preload("src/playwright_event_emitter.gd") -const MENU_SCAN_METADATA := "GD Playwright: Scan Scene For Metadata" -const MENU_CONVERT_METADATA := "GD Playwright: Convert Metadata To Tags" +const MENU_SCAN_METADATA := "gd-playwright: Scan Scene For Metadata" +const MENU_CONVERT_METADATA := "gd-playwright: Convert Metadata To Tags" func _enter_tree() -> void: _register_project_settings() @@ -102,22 +102,22 @@ func _editor_icon(preferred_name: String, fallback_name: String) -> Texture2D: func _scan_scene_for_metadata() -> void: var root: Node = _get_edited_scene_root() if root == null: - push_warning("GD Playwright: open a scene before scanning metadata.") + push_warning("gd-playwright: open a scene before scanning metadata.") return var result: Dictionary = _scan_metadata_recursive(root) - print("GD Playwright: found %d playwright metadata entries and %d PlaywrightTag nodes." % [int(result.get("metadata", 0)), int(result.get("tags", 0))]) + print("gd-playwright: found %d playwright metadata entries and %d PlaywrightTag nodes." % [int(result.get("metadata", 0)), int(result.get("tags", 0))]) func _convert_metadata_to_tags() -> void: var root: Node = _get_edited_scene_root() if root == null: - push_warning("GD Playwright: open a scene before converting metadata.") + push_warning("gd-playwright: open a scene before converting metadata.") return var converted: int = _convert_metadata_recursive(root, root) if converted > 0: var editor_interface: EditorInterface = get_editor_interface() if editor_interface != null and editor_interface.has_method("mark_scene_as_unsaved"): editor_interface.call("mark_scene_as_unsaved") - print("GD Playwright: converted %d playwright metadata entries to PlaywrightTag nodes and removed converted metadata." % converted) + print("gd-playwright: converted %d playwright metadata entries to PlaywrightTag nodes and removed converted metadata." % converted) func _get_edited_scene_root() -> Node: var editor_interface: EditorInterface = get_editor_interface() diff --git a/tools/package_gd.py b/tools/package_gd.py index fbc6f69..7d59a36 100755 --- a/tools/package_gd.py +++ b/tools/package_gd.py @@ -1,5 +1,5 @@ #!/usr/bin/env python3 -"""Build the GDAM asset from the repository's closed addon manifest.""" +"""Build the gdam asset from the repository's closed addon manifest.""" from __future__ import annotations diff --git a/tools/verify_gd_package.py b/tools/verify_gd_package.py index 73ac564..06f8bb8 100755 --- a/tools/verify_gd_package.py +++ b/tools/verify_gd_package.py @@ -1,5 +1,5 @@ #!/usr/bin/env python3 -"""Fail closed unless a GDAM ZIP contains exactly the declared regular files.""" +"""Fail closed unless a gdam ZIP contains exactly the declared regular files.""" from __future__ import annotations