Skip to content

Commit

Permalink
feat: add initial structure of the project and first feature to valid…
Browse files Browse the repository at this point in the history
…ate asyncapi files (#5)
  • Loading branch information
jotamusik committed Jun 18, 2021
1 parent 6a71fcc commit 8dbc2c7
Show file tree
Hide file tree
Showing 21 changed files with 22,288 additions and 3 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
root = true

[*]
indent_style = tab
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.yml]
indent_style = space
indent_size = 2
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@

.DS_Store
/node_modules/
/dist/
.idea
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
WORK IN PROGRESS
<h5 align="center">
<br>
<a href="https://www.asyncapi.org"><img src="https://github.com/asyncapi/parser-nodejs/raw/master/assets/logo.png" alt="AsyncAPI logo" width="200"></a>
<br>
AsyncAPI CLI
</h5>
<p align="center">
<em>CLI to work with your AsyncAPI files. Currently supports validation, but it is under development for more features.</em>
</p>

CLI to work with your AsyncAPI files. You can validate them, use generator and even bootstrap a new file.
### Install
```bash
$ npm install --global @asyncapi/cli
```

Feel free to jump into the issues/PRs section and give your feedback on what we want to work on.
### CLI
```
$ asyncapi --help
Usage
$ asyncapi command options
Commands
validate
Options
-c --context Your AsyncAPI specification
-w --watch Enable watchMode (not implemented yet)
Examples
$ asyncapi validate --context=specification.yml
```
Loading

0 comments on commit 8dbc2c7

Please sign in to comment.