Skip to content

Commit ba5498f

Browse files
Copilotdermatz
andauthored
docs: Fix commands.md numbering, missing sections, and flag inconsistencies (#172)
* Initial plan * #docs - Fix numbering, add Aliases/Options sections, clarify flags in docs/commands.md Agent-Logs-Url: https://github.com/OpenForgeProject/mageforge/sessions/df856e85-1c15-4a26-93d0-d8561e9c69ac Co-authored-by: dermatz <6103201+dermatz@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: dermatz <6103201+dermatz@users.noreply.github.com>
1 parent c5d962e commit ba5498f

1 file changed

Lines changed: 18 additions & 7 deletions

File tree

docs/commands.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ bin/magento mageforge:theme:list
5454
bin/magento mageforge:theme:build [<themeCodes>...]
5555
```
5656

57+
**Aliases**:
58+
59+
- `frontend:build`
60+
5761
**Implementation Details**:
5862

5963
- `themeCodes` accepts single themes (`Vendor/theme`) or just the vendor name (`Vendor`) to target all themes of a specific vendor.
@@ -63,7 +67,6 @@ bin/magento mageforge:theme:build [<themeCodes>...]
6367
2. Determines the appropriate builder for the theme type
6468
3. Executes the build process
6569
- Displays a summary of built themes and execution time
66-
- Has an alias: `frontend:build`
6770

6871
---
6972

@@ -85,13 +88,20 @@ bin/magento mageforge:theme:build [<themeCodes>...]
8588
bin/magento mageforge:theme:watch [--theme=THEME]
8689
```
8790

91+
**Aliases**:
92+
93+
- `frontend:watch`
94+
95+
**Options**:
96+
97+
- `--theme=THEME` - Theme code in format `Vendor/theme` to watch
98+
8899
**Implementation Details**:
89100

90101
- If no theme code is provided, displays an interactive prompt to select a theme
91102
- Resolves the theme path
92103
- Determines the appropriate builder for the theme type
93104
- Starts a watch process that monitors for file changes
94-
- Has an alias: `frontend:watch`
95105

96106
---
97107

@@ -163,7 +173,7 @@ bin/magento mageforge:system:check
163173

164174
---
165175

166-
### 5. VersionCommand (`mageforge:version`)
176+
### 6. VersionCommand (`mageforge:version`)
167177

168178
**Purpose**: Displays the current and latest version of the MageForge module.
169179

@@ -185,9 +195,11 @@ bin/magento mageforge:version
185195
- Fetches the latest version from GitHub API
186196
- Displays both versions for comparison
187197

198+
> **Note**: This command requires a `composer.lock` file to be present in the Magento root directory. If `composer.lock` is absent (e.g., gitignored or not yet generated), the current version cannot be determined.
199+
188200
---
189201

190-
### 6. CompatibilityCheckCommand (`mageforge:hyva:compatibility:check`)
202+
### 7. CompatibilityCheckCommand (`mageforge:hyva:compatibility:check`)
191203

192204
**Purpose**: Scans all Magento modules for Hyvä theme compatibility issues such as RequireJS, Knockout.js, jQuery, and UI Components usage.
193205

@@ -211,7 +223,6 @@ bin/magento mageforge:hyva:compatibility:check [options]
211223
**Options**:
212224

213225
- `--show-all` / `-a` - Show all modules including compatible ones
214-
- `--third-party-only` / `-t` - Check only third-party modules (exclude Magento\_\* modules)
215226
- `--include-vendor` - Include Magento core modules in scan (default: third-party only)
216227
- `--detailed` / `-d` - Show detailed file-level issues for incompatible modules
217228

@@ -314,7 +325,7 @@ _PHTML Files (.phtml)_:
314325

315326
---
316327

317-
### 7. TokensCommand (`mageforge:hyva:tokens`)
328+
### 8. TokensCommand (`mageforge:hyva:tokens`)
318329

319330
**Purpose**: Generates Hyvä design tokens from design.tokens.json or hyva.config.json configuration files.
320331

@@ -388,7 +399,7 @@ bin/magento mageforge:hyva:tokens Hyva/default
388399

389400
---
390401

391-
### 8. InspectorCommand (`mageforge:theme:inspector`)
402+
### 9. InspectorCommand (`mageforge:theme:inspector`)
392403

393404
**Purpose**: Enable, disable, or check status of the MageForge Frontend Inspector - an interactive element inspector for debugging templates, blocks, and modules in the frontend.
394405

0 commit comments

Comments
 (0)