Skip to content

Commit

Permalink
Merge branch 'master' into postman-collection
Browse files Browse the repository at this point in the history
  • Loading branch information
Shurtu-gal authored Oct 2, 2024
2 parents 3fb330d + 8f7b019 commit 7fd0894
Show file tree
Hide file tree
Showing 18 changed files with 21,825 additions and 15,766 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ lib
/test/commands/generate/models/
test/helpers
/test/fixtures/minimaltemplate
/test/fixtures/newtemplate
create-glee-app
6 changes: 6 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,12 @@
"no-use-before-define": "off",
"sonarjs/cognitive-complexity": "off"
}
},
{
"files": ["src/core/base.ts"],
"rules": {
"@typescript-eslint/ban-ts-comment": "off"
}
}
]
}
6 changes: 3 additions & 3 deletions assets/create-glee-app/templates/default/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions assets/create-glee-app/templates/tutorial/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

55 changes: 28 additions & 27 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli
$ asyncapi COMMAND
running command...
$ asyncapi (--version)
@asyncapi/cli/2.4.0 linux-x64 node-v18.20.4
@asyncapi/cli/2.4.1 linux-x64 node-v18.20.4
$ asyncapi --help [COMMAND]
USAGE
$ asyncapi COMMAND
Expand Down Expand Up @@ -99,7 +99,7 @@ EXAMPLES
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
```

_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/bundle.ts)_
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/bundle.ts)_

## `asyncapi config`

Expand All @@ -113,7 +113,7 @@ DESCRIPTION
CLI config settings
```

_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/index.ts)_
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/index.ts)_

## `asyncapi config analytics`

Expand All @@ -133,7 +133,7 @@ DESCRIPTION
Enable or disable analytics for metrics collection
```

_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/analytics.ts)_
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/analytics.ts)_

## `asyncapi config context`

Expand All @@ -147,7 +147,7 @@ DESCRIPTION
Manage short aliases for full paths to AsyncAPI documents
```

_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/index.ts)_
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/index.ts)_

## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`

Expand All @@ -169,7 +169,7 @@ DESCRIPTION
Add a context to the store
```

_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/add.ts)_
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/add.ts)_

## `asyncapi config context current`

Expand All @@ -186,7 +186,7 @@ DESCRIPTION
Shows the current context that is being used
```

_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/current.ts)_
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/current.ts)_

## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`

Expand All @@ -207,7 +207,7 @@ DESCRIPTION
Edit a context in the store
```

_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/edit.ts)_
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/edit.ts)_

## `asyncapi config context init [CONTEXT-FILE-PATH]`

Expand All @@ -230,7 +230,7 @@ DESCRIPTION
Initialize context
```

_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/init.ts)_
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/init.ts)_

## `asyncapi config context list`

Expand All @@ -247,7 +247,7 @@ DESCRIPTION
List all the stored contexts in the store
```

_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/list.ts)_
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/list.ts)_

## `asyncapi config context remove CONTEXT-NAME`

Expand All @@ -267,7 +267,7 @@ DESCRIPTION
Delete a context from the store
```

_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/remove.ts)_
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/remove.ts)_

## `asyncapi config context use CONTEXT-NAME`

Expand All @@ -287,7 +287,7 @@ DESCRIPTION
Set a context as current
```

_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/context/use.ts)_
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/context/use.ts)_

## `asyncapi config versions`

Expand All @@ -304,7 +304,7 @@ DESCRIPTION
Show versions of AsyncAPI tools used
```

_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/config/versions.ts)_
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/config/versions.ts)_

## `asyncapi convert [SPEC-FILE]`

Expand All @@ -331,7 +331,7 @@ DESCRIPTION
Convert asyncapi documents older to newer versions or OpenAPI documents to AsyncAPI
```

_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/convert.ts)_
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/convert.ts)_

## `asyncapi diff OLD NEW`

Expand Down Expand Up @@ -371,7 +371,7 @@ DESCRIPTION
Find diff between two asyncapi files
```

_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/diff.ts)_
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/diff.ts)_

## `asyncapi generate`

Expand All @@ -385,7 +385,7 @@ DESCRIPTION
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
```

_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/generate/index.ts)_
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/generate/index.ts)_

## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE`

Expand All @@ -395,7 +395,7 @@ Generates whatever you want using templates compatible with AsyncAPI Generator.
USAGE
$ asyncapi generate fromTemplate ASYNCAPI TEMPLATE [-h] [-d <value>...] [--no-interactive] [-i] [--debug] [-n <value>...]
[-o <value>] [--force-write] [-w] [-p <value>...] [--map-base-url <value>] [--registry-url <value>] [--registry-auth
<value>] [--registry-token <value>]
<value>] [--registry-token <value>] [--use-new-generator]
ARGUMENTS
ASYNCAPI - Local path, url or context-name pointing to AsyncAPI file
Expand All @@ -421,6 +421,7 @@ FLAGS
username and password
--registry-url=<value> [default: https://registry.npmjs.org] Specifies the URL of the private registry for
fetching templates and dependencies
--use-new-generator Use v2 generator, for generating from newer templates
DESCRIPTION
Generates whatever you want using templates compatible with AsyncAPI Generator.
Expand All @@ -429,7 +430,7 @@ EXAMPLES
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
```

_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/generate/fromTemplate.ts)_
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/generate/fromTemplate.ts)_

## `asyncapi generate models LANGUAGE FILE`

Expand Down Expand Up @@ -500,7 +501,7 @@ DESCRIPTION
Generates typed models
```

_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/generate/models.ts)_
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/generate/models.ts)_

## `asyncapi new`

Expand Down Expand Up @@ -558,7 +559,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/index.ts)_
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/index.ts)_

## `asyncapi new file`

Expand Down Expand Up @@ -616,7 +617,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/file.ts)_
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/file.ts)_

## `asyncapi new glee`

Expand All @@ -638,7 +639,7 @@ DESCRIPTION
Creates a new Glee project
```

_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/glee.ts)_
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/glee.ts)_

## `asyncapi new template`

Expand All @@ -662,7 +663,7 @@ DESCRIPTION
Creates a new template
```

_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/new/template.ts)_
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/new/template.ts)_

## `asyncapi optimize [SPEC-FILE]`

Expand Down Expand Up @@ -704,7 +705,7 @@ EXAMPLES
$ asyncapi optimize ./asyncapi.yaml --ignore=schema
```

_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/optimize.ts)_
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/optimize.ts)_

## `asyncapi start`

Expand All @@ -713,7 +714,7 @@ USAGE
$ asyncapi start
```

_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/start/index.ts)_
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/start/index.ts)_

## `asyncapi start studio`

Expand All @@ -732,7 +733,7 @@ DESCRIPTION
starts a new local instance of Studio
```

_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/start/studio.ts)_
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/start/studio.ts)_

## `asyncapi validate [SPEC-FILE]`

Expand Down Expand Up @@ -762,5 +763,5 @@ DESCRIPTION
validate asyncapi file
```

_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.4.0/src/commands/validate.ts)_
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v2.4.1/src/commands/validate.ts)_
<!-- commandsstop -->
Loading

0 comments on commit 7fd0894

Please sign in to comment.