Skip to content

Commit c14351c

Browse files
zainforbjszainforbjs
authored
Merge pull request #1850 from wheels-dev/fix/wheels-cli-docs-update
commit: update wheels cli docs - updating outputs of commands
2 parents 61dd87c + 8b1988e commit c14351c

29 files changed

+801
-424
lines changed

‎cli/src/commands/wheels/init.cfc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ component extends="base" {
6464

6565
// Create a server.json if one doesn't exist
6666
if(!fileExists(serverJsonLocation)){
67-
var appName = ask( message = "Please enter an application name: we use this to make the server.json servername unique: ", defaultResponse = 'myapp');
67+
var appName = ask( message = "Please enter an application name (we use this to make the server.json servername unique): ", defaultResponse = 'myapp');
6868
appName = helpers.stripSpecialChars(appName);
6969
var setEngine = ask( message = 'Please enter a default cfengine: ', defaultResponse = 'lucee@6' );
7070

@@ -84,7 +84,7 @@ component extends="base" {
8484
// Create a box.json if one doesn't exist
8585
if(!fileExists(boxJsonLocation)){
8686
if(!isDefined("appName")) {
87-
var appName = ask("Please enter an application name: we use this to make the box.json servername unique: ");
87+
var appName = ask("Please enter an application name (we use this to make the box.json servername unique): ");
8888
appName = helpers.stripSpecialChars(appName);
8989
}
9090
var boxJSON = fileRead( getTemplate('/BoxJSON.txt' ) );

‎docs/src/command-line-tools/commands/analysis/analyze-code.md‎

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,55 @@ wheels analyze code --path=app/models --fix --report --verbose
132132

133133
### Console Output (Default)
134134
```
135-
Analyzing code quality...
135+
Analyzing code quality with report and verbose output...
136+
137+
Configuration:
138+
Path: C:\Users\Hp\db_app\app\models\
139+
Severity filter: warning
140+
Fix mode: enabled
141+
Output format: console
142+
Report generation: enabled
143+
144+
Scanning for files... + C:\Users\Hp\db_app\app\models\Model.cfc
145+
Found 1 files to analyze
146+
Analyzing file 1/1: C:\Users\Hp\db_app\app\models\Model.cfc
147+
File has 7 lines
148+
Running code style checks...
149+
Running security checks...
150+
Running performance checks...
151+
Running best practice checks...
152+
Running complexity analysis...
153+
Checking naming conventions...
154+
Detecting code smells...
155+
Checking for deprecated functions...
156+
Checking Wheels conventions...
157+
Found 0 issues total, 0 after severity filter
158+
Analyzing: [==================================================] 100% Complete!
159+
Starting duplicate code detection...
160+
Detecting duplicate code... Found 0 duplicate blocks
161+
162+
Applying automatic fixes...
163+
Fixed 0 issues automatically
164+
165+
Re-analyzing after fixes with verbose output...
166+
Scanning for files... + C:\Users\Hp\db_app\app\models\Model.cfc
167+
Found 1 files to analyze
168+
Analyzing file 1/1: C:\Users\Hp\db_app\app\models\Model.cfc
169+
File has 7 lines
170+
Running code style checks...
171+
Running security checks...
172+
Running performance checks...
173+
Running best practice checks...
174+
Running complexity analysis...
175+
Checking naming conventions...
176+
Detecting code smells...
177+
Checking for deprecated functions...
178+
Checking Wheels conventions...
179+
Found 0 issues total, 0 after severity filter
180+
Analyzing: [==================================================] 100% Complete!
181+
Starting duplicate code detection...
182+
Detecting duplicate code... Found 0 duplicate blocks
183+
136184
137185
Scanning for files... Found 51 files to analyze
138186
Analyzing: [==================================================] 100% Complete!
@@ -160,6 +208,8 @@ Deprecated Calls: 0
160208
161209
Grade: A (100/100)
162210
Excellent! No issues found. Your code is pristine!
211+
Generating HTML report...
212+
HTML report generated: C:\Users\Hp\db_app\reports\code-analysis .....html
163213
```
164214

165215
### JSON Output

‎docs/src/command-line-tools/commands/analysis/analyze-performance.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Target: all
101101
Threshold: 100ms
102102
103103
[====================] 100% Complete!
104-
104+
Profiling mode disabled
105105
==================================================
106106
PERFORMANCE ANALYSIS COMPLETE
107107
==================================================

‎docs/src/command-line-tools/commands/application-utilities/about.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,11 @@ wheels about
2626

2727
Output:
2828
```
29-
_____ _______ ___ _
30-
/ ____| ____\ \ / / | | |
31-
| | | |__ \ \ /\ / /| |__ ___ ___| |___
32-
| | | __| \ \/ \/ / | '_ \ / _ \/ _ \ / __|
33-
| |____| | \ /\ / | | | | __/ __/ \__ \
34-
\_____|_| \/ \/ |_| |_|\___|\___|_|___/
29+
\ \ / / | | |
30+
\ \ /\ / /| |__ ___ ___| |___
31+
\ \/ \/ / | '_ \ / _ \/ _ \ / __|
32+
\ /\ / | | | | __/ __/ \__ \
33+
\/ \/ |_| |_|\___|\___|_|___/
3534
3635
Wheels Framework
3736
Version: 2.5.0

‎docs/src/command-line-tools/commands/config/config-diff.md‎

Lines changed: 58 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,13 @@ project_root/
109109
The table output is organized into clear sections:
110110

111111
```
112-
========================================
112+
==================================================
113113
Configuration Comparison: development vs production
114-
========================================
114+
==================================================
115115
116-
[SETTINGS CONFIGURATION]
116+
117+
ENVIRONMENT VARIABLES
118+
--------------------------------------------------
117119
118120
Different Values:
119121
┌──────────────────────┬────────────┬────────────┐
@@ -147,72 +149,72 @@ Different Values:
147149
│ DEBUG_MODE │ true │ false │
148150
└──────────────┴────────────────┴────────────────┘
149151
150-
========================================
151-
SUMMARY
152-
========================================
152+
==================================================
153+
SUMMARY
154+
==================================================
153155
Settings:
154-
Total: 25
155-
Identical: 20
156-
Different: 2
157-
Unique: 3
156+
Total: 25
157+
Identical: 20
158+
Different: 2
159+
Unique: 3
158160
159161
Environment Variables:
160-
Total: 15
161-
Identical: 10
162-
Different: 2
163-
Unique: 3
162+
Total: 15
163+
Identical: 10
164+
Different: 2
165+
Unique: 3
164166
165167
Overall:
166-
Total configurations: 40
167-
Identical: 30
168-
Different: 4
169-
Unique: 6
170-
Similarity: 75%
168+
Total configurations: 40
169+
Identical: 30
170+
Different: 4
171+
Unique: 6
172+
Similarity: 75%
171173
```
172174

173175
### JSON Format
174176

175177
```json
176178
{
177-
"env1": "development",
178-
"env2": "production",
179-
"comparisons": {
180-
"settings": {
181-
"identical": [...],
182-
"different": [...],
183-
"onlyInFirst": [...],
184-
"onlyInSecond": [...]
185-
},
186-
"env": {
187-
"identical": [...],
188-
"different": [...],
189-
"onlyInFirst": [...],
190-
"onlyInSecond": [...]
191-
}
192-
},
193-
"summary": {
194-
"settings": {
195-
"totalSettings": 25,
196-
"identical": 20,
197-
"different": 2,
198-
"onlyInFirst": 1,
199-
"onlyInSecond": 2
200-
},
201-
"env": {
202-
"totalVariables": 15,
203-
"identical": 10,
204-
"different": 2,
205-
"onlyInFirst": 1,
206-
"onlyInSecond": 2
179+
"ENV1": "development",
180+
"ENV2": "production",
181+
"COMPARISONS":{
182+
"SETTINGS":{
183+
"IDENTICAL":[...],
184+
"DIFFERENT":[...],
185+
"ONLYINSECOND":[...],
186+
"ONLYINFIRST":[...]
187+
},
188+
"ENV": {
189+
"ONLYINSECOND":[...],
190+
"DIFFERENT":[...],
191+
"IDENTICAL":[...],
192+
"ONLYINFIRST":[...]
193+
}
207194
},
208-
"overall": {
209-
"total": 40,
210-
"identical": 30,
211-
"different": 4,
212-
"unique": 6,
213-
"similarity": 75
195+
"SUMMARY": {
196+
"ENV":{
197+
"TOTALVARIABLES":12,
198+
"ONLYINSECOND":1,
199+
"DIFFERENT":0,
200+
"IDENTICAL":0,
201+
"ONLYINFIRST":11
202+
},
203+
"OVERALL":{
204+
"UNIQUE":12,
205+
"SIMILARITY":14,
206+
"DIFFERENT":0,
207+
"TOTAL":14,
208+
"IDENTICAL":2
209+
},
210+
"SETTINGS":{
211+
"ONLYINSECOND":0,
212+
"TOTALSETTINGS":2,
213+
"DIFFERENT":0,
214+
"IDENTICAL":2,
215+
"ONLYINFIRST":0
216+
}
214217
}
215-
}
216218
}
217219
```
218220

‎docs/src/command-line-tools/commands/core/deps.md‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,18 +126,27 @@ The report includes:
126126

127127
Example output:
128128
```
129-
Dependency Report:
129+
==================================================
130+
Wheels Dependency Manager
131+
==================================================
132+
133+
Generating dependency report...
134+
==================================================
135+
Dependency Report
136+
==================================================
130137
131138
Generated: 2025-09-19 11:38:44
132139
Wheels Version: 3.0.0-SNAPSHOT
133140
CFML Engine: Lucee 5.4.6.9
134141
135142
Dependencies:
143+
--------------------------------------------------
136144
cbvalidation @ ^4.6.0+28 - Installed: No
137145
shortcodes @ ^0.0.4 - Installed: No
138146
wirebox @ ^7.4.2+24 - Installed: No
139147
140148
Dev Dependencies:
149+
--------------------------------------------------
141150
testbox @ ^6.4.0+17 - Installed: Yes
142151
143152
Checking for outdated packages...
@@ -147,9 +156,12 @@ Checking for outdated packages...
147156
│ testbox@^6.4.. │ 6.4.0+17 │ 6.4.0+17 │ 6.4.0+17 │ /testbox │
148157
└────────────────┴───────────┴──────────┴──────────┴─────────────────────┘
149158
159+
Checking for outdated packages...
160+
161+
Checking for outdated dependencies, please wait...
150162
There are no outdated dependencies!
151163
152-
Full report exported to: dependency-report-20250919-113851.json
164+
[SUCCESS]: Full report exported to: dependency-report-20250919-113851.json
153165
```
154166

155167
## Integration with CommandBox

‎docs/src/command-line-tools/commands/core/destroy.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ wheels d user
7171

7272
This will prompt this along with a confirmation:
7373
```
74-
================================================
75-
= Watch Out! =
76-
================================================
74+
==================================================
75+
Watch Out!
76+
==================================================
7777
This will delete the associated database table 'users', and
7878
the following files and directories:
7979

‎docs/src/command-line-tools/commands/core/init.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ wheels init
3838

3939
Example interaction:
4040
```
41-
==================================== Wheels init ===================================
41+
==================================================
42+
Wheels init
43+
==================================================
4244
This function will attempt to add a few things
4345
to an EXISTING Wheels installation to help
4446
the CLI interact.
@@ -50,10 +52,10 @@ Example interaction:
5052
We're going to try and do the following:
5153
- create a box.json to help keep track of the wheels version
5254
- create a server.json
53-
====================================================================================
55+
--------------------------------------------------
5456
5557
Sound ok? [y/n] y
56-
Please enter an application name: myapp
58+
Please enter an application name (we use this to make the server.json servername unique): myapp
5759
Please enter a default cfengine: lucee5
5860
```
5961

0 commit comments

Comments
 (0)