Skip to content

Commit ea83445

Browse files
committed
refactor: update commands description
1 parent 7a794a1 commit ea83445

File tree

8 files changed

+25
-20
lines changed

8 files changed

+25
-20
lines changed

commands/Build.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ import { BaseCommand, flags } from '@adonisjs/core/build/standalone'
1515
*/
1616
export default class Build extends BaseCommand {
1717
public static commandName = 'build'
18-
public static description = 'Compile Typescript code to JavaScript'
18+
public static description =
19+
'Compile project from Typescript to Javascript. Also compiles the frontend assets if using webpack encore'
1920

2021
/**
2122
* Build for production
@@ -27,7 +28,8 @@ export default class Build extends BaseCommand {
2728
* Bundle frontend assets. Defaults to true
2829
*/
2930
@flags.boolean({
30-
description: 'Bundle frontend assets when encore is installed. Use --no-assets to disable',
31+
description:
32+
'Build frontend assets when webpack encore is installed. Use --no-assets to disable',
3133
default: true,
3234
})
3335
public assets: boolean

commands/Invoke.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ import { BaseCommand, args } from '@adonisjs/core/build/standalone'
1111
import { Manifest } from '../src/Manifest'
1212

1313
/**
14-
* Invoke post install instructions
14+
* Configure a package
1515
*/
16-
export default class Invoke extends BaseCommand {
17-
public static commandName = 'invoke'
18-
public static description = 'Run post install instructions for a given AdonisJS package'
19-
public static aliases = ['configure']
16+
export default class Configure extends BaseCommand {
17+
public static commandName = 'configure'
18+
public static description = 'Configure a given AdonisJS package'
19+
public static aliases = ['invoke']
2020

2121
/**
2222
* Use yarn when building for production to install dependencies
2323
*/
2424
@args.string({
25-
description: 'Name of the package for which to invoke the post install instructions',
25+
description: 'Name of the package you want to configure',
2626
})
2727
public name: string
2828

commands/Make/Controller.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ export default class MakeController extends BaseGenerator {
4646
@args.string({ description: 'Name of the controller class' })
4747
public name: string
4848

49-
@flags.boolean({ description: 'Adds resourceful methods to the controller class', alias: 'r' })
49+
@flags.boolean({ description: 'Add resourceful methods to the controller class', alias: 'r' })
5050
public resource: boolean
5151

5252
@flags.boolean({

commands/Make/Exception.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,16 @@ export default class MakeException extends BaseGenerator {
2828
* Command meta data
2929
*/
3030
public static commandName = 'make:exception'
31-
public static description = 'Make a new exception handle'
31+
public static description = 'Make a new custom exception class'
3232

3333
@args.string({ description: 'Name of the exception class' })
3434
public name: string
3535

36-
@flags.boolean({ description: 'Add handle method to self handle the exception' })
36+
@flags.boolean({ description: 'Add the handle method to self handle the exception' })
3737
public selfHandle: boolean
3838

3939
@flags.boolean({
40-
description: 'Create the exception with the exact name as provided',
40+
description: 'Create the exception class with the exact name as provided',
4141
alias: 'e',
4242
})
4343
public exact: boolean

commands/Make/PreloadFile.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ export default class MakePreloadFile extends BaseGenerator {
3636
/**
3737
* Command description
3838
*/
39-
public static description =
40-
'Make a new preload file. Preloaded files are loaded automatically on boot'
39+
public static description = 'Make a new preload file'
4140

4241
@args.string({ description: 'Name of the file' })
4342
public name: string

commands/Make/Provider.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ export default class MakeProvider extends BaseGenerator {
3030
* Command meta data
3131
*/
3232
public static commandName = 'make:provider'
33-
public static description = 'Make a new IoC container provider'
33+
public static description = 'Make a new provider class'
3434

3535
@args.string({ description: 'Name of the provider class' })
3636
public name: string
3737

38-
@flags.boolean({ description: 'Registers provider under the ace providers array' })
38+
@flags.boolean({ description: 'Register provider under the ace providers array' })
3939
public ace: boolean
4040

4141
@flags.boolean({

commands/Serve.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ import { BaseCommand, flags } from '@adonisjs/core/build/standalone'
1515
*/
1616
export default class Serve extends BaseCommand {
1717
public static commandName = 'serve'
18-
public static description = 'Start the AdonisJS HTTP server. Optionally watch for file changes'
18+
public static description =
19+
'Start the AdonisJS HTTP server, along with the file watcher. Also starts the webpack dev server when webpack encore is installed'
1920

2021
public static settings = {
2122
stayAlive: true,
@@ -25,15 +26,18 @@ export default class Serve extends BaseCommand {
2526
* Bundle frontend assets. Defaults to true
2627
*/
2728
@flags.boolean({
28-
description: 'Start webpack dev server when encore is installed. Use --no-assets to disable',
29+
description: 'Start webpack dev server when encore is installed. Use "--no-assets" to disable',
2930
default: true,
3031
})
3132
public assets: boolean
3233

3334
/**
3435
* Allows watching for file changes
3536
*/
36-
@flags.boolean({ description: 'Watch for file changes and re-start the HTTP server', alias: 'w' })
37+
@flags.boolean({
38+
description: 'Watch for file changes and re-start the HTTP server on change',
39+
alias: 'w',
40+
})
3741
public watch: boolean
3842

3943
/**

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
},
4444
"homepage": "https://github.com/adonisjs/assembler#readme",
4545
"devDependencies": {
46-
"@adonisjs/ace": "^9.0.3",
46+
"@adonisjs/ace": "^9.0.4",
4747
"@adonisjs/core": "^5.0.5-canary-rc-1",
4848
"@adonisjs/mrm-preset": "^3.0.0",
4949
"@poppinss/dev-utils": "^1.1.0",

0 commit comments

Comments
 (0)