Skip to content

Commit e1861f3

Browse files
Michael DavisMichael Davis
authored andcommitted
updating param style to match csdx
1 parent 516b05b commit e1861f3

3 files changed

Lines changed: 10 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
![Node.js CI](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/workflows/Node.js%20CI/badge.svg)
33

44
## Description
5-
Generate TypeScript typings from Contentstack Content Types. Interfaces and fields are annotated with jsdoc comments.
5+
Generate TypeScript typings from Contentstack Content Types. Interfaces and fields are annotated with JSDoc comments.
66

77
## How to install this plugin
88

@@ -12,14 +12,14 @@ $ csdx plugins:install contentstack-cli-tsgen
1212

1313
## `csdx tsgen`
1414

15-
Generate TypeScript typings from a Stack.
15+
generate TypeScript typings from a Stack
1616

1717
```
1818
USAGE
1919
$ csdx tsgen
2020
2121
OPTIONS
22-
-a, --token-alias=token-alias (required) Delivery Token Alias
22+
-a, --token-alias=token-alias (required) Delivery token alias
2323
-d, --[no-]doc Include documentation comments
2424
-o, --output=output (required) Full path to output
2525
-p, --prefix=prefix Interface prefix, e.g. "I"
@@ -30,7 +30,7 @@ EXAMPLES
3030
$ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts" --no-doc
3131
```
3232

33-
_See code: [src/commands/tsgen.ts](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v1.0.4/src/commands/tsgen.ts)_
33+
_See code: [src/commands/tsgen.ts](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v1.0.5/src/commands/tsgen.ts)_
3434
<!-- commandsstop -->
3535

3636
## Supported Fields
@@ -73,7 +73,7 @@ interface BuiltinExample {
7373
};
7474
};
7575
/** SEO */
76-
seo?: ISeo;
76+
seo?: Seo;
7777
/** Single line textbox */
7878
single_line?: string;
7979
/** Multi line textbox */

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@
3737
],
3838
"homepage": "https://github.com/Contentstack-Solutions/contentstack-cli-tsgen",
3939
"keywords": [
40-
"contentstack-plugin"
40+
"contentstack",
41+
"contentstack-plugin",
42+
"typescript"
4143
],
4244
"license": "MIT",
4345
"oclif": {

src/commands/tsgen.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import {stackConnect, StackConnectionConfig} from '../lib/stack/client'
33
import tsgenRunner from '../lib/tsgen/runner'
44

55
export default class TypeScriptCodeGeneratorCommand extends Command {
6-
static description = 'Generate TypeScript typings from a Stack.';
6+
static description = 'generate TypeScript typings from a Stack';
77

88
static examples = [
99
'$ csdx tsgen -a "delivery-token-alias" -o "contentstack/generated.d.ts"',
@@ -14,7 +14,7 @@ export default class TypeScriptCodeGeneratorCommand extends Command {
1414
static flags = {
1515
'token-alias': flags.string({
1616
char: 'a',
17-
description: 'Delivery Token Alias',
17+
description: 'Delivery token alias',
1818
hidden: false,
1919
multiple: false,
2020
required: true,

0 commit comments

Comments
 (0)