Skip to content

Commit ecf48c1

Browse files
committed
🎨 Adjust help output
1 parent fffeec9 commit ecf48c1

File tree

2 files changed

+41
-40
lines changed

2 files changed

+41
-40
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,20 @@ $ graphql-schema-diff --help
2525

2626
Options
2727
--fail-on-dangerous-changes Exit with error on dangerous changes
28-
--fail-on-breaking-changes Exit with error on breaking changes
29-
--fail-on-all-changes Exit with error on all changes
30-
--use-colors Use colors for diff terminal output
31-
--create-html-output Creates an HTML file containing the diff
32-
--html-output-directory Directory where the HTML file should be stored (Default: './schemaDiff')
33-
--header, -H Header to send to all remote schema sources
34-
--left-schema-header Header to send to left remote schema source
35-
--right-schema-header Header to send to right remote schema source
36-
--sort-schema, -s Sort schemas prior to diffing
28+
--fail-on-breaking-changes Exit with error on breaking changes
29+
--fail-on-all-changes Exit with error on all changes
30+
--use-colors Use colors for diff terminal output
31+
--create-html-output Creates an HTML file containing the diff
32+
--html-output-directory Directory where the HTML file should be stored (Default: './schemaDiff')
33+
--header, -H Header to send to all remote schema sources
34+
--left-schema-header Header to send to left remote schema source
35+
--right-schema-header Header to send to right remote schema source
36+
--sort-schema, -s Sort schemas prior to diffing
3737

3838
Examples
3939
$ graphql-schema-diff https://example.com/graphql schema.graphql
4040
$ graphql-schema-diff https://example.com/graphql schema.graphql -H 'Authorization: Bearer 123'
41+
4142
```
4243

4344
Schema locations can be:

src/cli.ts

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,54 +12,54 @@ const cli = meow(
1212
1313
Options
1414
--fail-on-dangerous-changes Exit with error on dangerous changes
15-
--fail-on-breaking-changes Exit with error on breaking changes
16-
--fail-on-all-changes Exit with error on all changes
17-
--use-colors Use colors for diff terminal output
18-
--create-html-output Creates an HTML file containing the diff
19-
--html-output-directory Directory where the HTML file should be stored (Default: './schemaDiff')
20-
--header, -H Header to send to all remote schema sources
21-
--left-schema-header Header to send to left remote schema source
22-
--right-schema-header Header to send to right remote schema source
23-
--sort-schema, -s Sort schemas prior to diffing
15+
--fail-on-breaking-changes \t Exit with error on breaking changes
16+
--fail-on-all-changes \t Exit with error on all changes
17+
--use-colors \t\t Use colors for diff terminal output
18+
--create-html-output \t Creates an HTML file containing the diff
19+
--html-output-directory \t Directory where the HTML file should be stored (Default: './schemaDiff')
20+
--header, -H \t\t Header to send to all remote schema sources
21+
--left-schema-header \t Header to send to left remote schema source
22+
--right-schema-header \t Header to send to right remote schema source
23+
--sort-schema, -s \t\t Sort schemas prior to diffing
2424
2525
Examples
2626
$ graphql-schema-diff https://example.com/graphql schema.graphql
2727
$ graphql-schema-diff https://example.com/graphql schema.graphql -H 'Authorization: Bearer 123'
2828
`,
2929
{
3030
flags: {
31-
'fail-on-dangerous-changes': {
32-
type: 'boolean'
31+
"fail-on-dangerous-changes": {
32+
type: "boolean"
3333
},
34-
'fail-on-breaking-changes': {
35-
type: 'boolean'
34+
"fail-on-breaking-changes": {
35+
type: "boolean"
3636
},
37-
'fail-on-all-changes': {
38-
type: 'boolean'
37+
"fail-on-all-changes": {
38+
type: "boolean"
3939
},
40-
'use-colors': {
41-
type: 'boolean'
40+
"use-colors": {
41+
type: "boolean"
4242
},
43-
'create-html-output': {
44-
type: 'boolean'
43+
"create-html-output": {
44+
type: "boolean"
4545
},
46-
'html-output-directory': {
47-
type: 'string',
48-
default: 'schemaDiff'
46+
"html-output-directory": {
47+
type: "string",
48+
default: "schemaDiff"
4949
},
5050
header: {
51-
type: 'string',
52-
alias: 'H'
51+
type: "string",
52+
alias: "H"
5353
},
54-
'left-schema-header': {
55-
type: 'string'
54+
"left-schema-header": {
55+
type: "string"
5656
},
57-
'right-schema-header': {
58-
type: 'string'
57+
"right-schema-header": {
58+
type: "string"
5959
},
60-
'sort-schema': {
61-
type: 'boolean',
62-
alias: 's'
60+
"sort-schema": {
61+
type: "boolean",
62+
alias: "s"
6363
}
6464
}
6565
}

0 commit comments

Comments
 (0)