Update README (#74)

Author: DangoDev

.prettierrc

@@ -1,5 +1,6 @@
 {
   "printWidth": 100,
+  "proseWrap": "always",
   "singleQuote": true,
   "trailingComma": "es5"
 }

README.md

@@ -30,10 +30,9 @@ npx @manifoldco/swagger-to-ts schema.yaml --wrapper "declare namespace OpenAPI"
 # 🚀 schema.yaml -> schema.d.ts [2ms]
 ```
 
-This will save a `schema.ts` file in the current folder under the TypeScript
-[namespace][namespace] `OpenAPI` (namespaces are required because chances of
-collision among specs is highly likely). The CLI can accept YAML or JSON for
-the input file.
+This will save a `schema.ts` file in the current folder under the TypeScript [namespace][namespace]
+`OpenAPI` (namespaces are required because chances of collision among specs is highly likely). The
+CLI can accept YAML or JSON for the input file.
 
 #### Wrapper option
 
@@ -46,8 +45,7 @@ declare namespace MyNamespace {}
 declare module MyModule {}
 ```
 
-The `--wrapper` flag lets you specify any of the above with a string (omit
-the `{}`):
+The `--wrapper` flag lets you specify any of the above with a string (omit the `{}`):
 
 ```bash
 npx @manifoldco/swagger-to-ts schema.yaml --wrapper "namespace API"
@@ -56,24 +54,24 @@ npx @manifoldco/swagger-to-ts schema.yaml --wrapper "declare namespace API"
 npx @manifoldco/swagger-to-ts schema.yaml --wrapper "declare module '@api'"
 ```
 
-By default, wrapper is `declare namespace OpenAPI2`. You can skip exposing types via a wrapper by adding the `--nowrapper` flag:
+By default, wrapper is `declare namespace OpenAPI2`. You can skip exposing types via a wrapper by
+adding the `--nowrapper` flag:
 
 ```bash
 npx @manifoldco/swagger-to-ts schema.yaml --nowrapper
 ```
 
-As mentioned before, this uses [Prettier][prettier] to clean up output, so
-extra spaces are generally OK here. Prettier also will err on cleanup if you
-specify invalid TypeScript, letting you know on generation if anything went
-wrong.
+As mentioned before, this uses [Prettier][prettier] to clean up output, so extra spaces are
+generally OK here. Prettier also will err on cleanup if you specify invalid TypeScript, letting you
+know on generation if anything went wrong.
 
-_Note: previous versions of the CLI tool used `--namespace` and `--export`.
-These have both been deprecated in favor of `--wrapper`._
+_Note: previous versions of the CLI tool used `--namespace` and `--export`. These have both been
+deprecated in favor of `--wrapper`._
 
 #### CamelCasing properties
 
-Within interfaces, you may want to convert `snake_case` properties to
-`camelCase` by adding the `--camelcase` flag:
+Within interfaces, you may want to convert `snake_case` properties to `camelCase` by adding the
+`--camelcase` flag:
 
 ```bash
 npx @manifoldco/swagger-to-ts schema.yaml --camelcase --wrapper "declare namespace OpenAPI" --output schema.d.ts
@@ -83,9 +81,8 @@ npx @manifoldco/swagger-to-ts schema.yaml --camelcase --wrapper "declare namespa
 
 #### Generating multiple schemas
 
-Say you have multiple schemas you need to parse. I’ve found the simplest way
-to do that is to use npm scripts. In your `package.json`, you can do
-something like the following:
+Say you have multiple schemas you need to parse. I’ve found the simplest way to do that is to use
+npm scripts. In your `package.json`, you can do something like the following:
 
 ```json
 "scripts": {
@@ -97,18 +94,19 @@ something like the following:
 
 Rinse and repeat for more specs.
 
-For anything more complicated, or for generating specs dynamically, you can
-also use the Node API (below).
+For anything more complicated, or for generating specs dynamically, you can also use the Node API
+(below).
 
 #### CLI Options
 
-| Option                | Alias |           Default            | Description                                                |
-| :-------------------- | :---- | :--------------------------: | :--------------------------------------------------------- |
-| `--wrapper`           | `-w`  | `declare namespace OpenAPI2` | How should this export the types?                          |
-| `--output [location]` | `-o`  |           (stdout)           | Where should the output file be saved?                     |
-| `--swagger [version]` | `-s`  |             `2`              | Which Swagger version to use. Currently only supports `2`. |
-| `--camelcase`         | `-c`  |           `false`            | Convert `snake_case` properties to `camelCase`?            |
-| `--nowrapper`         | `-nw` |           `false`            | Disables rendering a wrapper                               |
+| Option                | Alias |           Default            | Description                                                              |
+| :-------------------- | :---- | :--------------------------: | :----------------------------------------------------------------------- |
+| `--wrapper`           | `-w`  | `declare namespace OpenAPI2` | How should this export the types?                                        |
+| `--output [location]` | `-o`  |           (stdout)           | Where should the output file be saved?                                   |
+| `--swagger [version]` | `-s`  |             `2`              | specify Swagger version (currently only supports `2`)                    |
+| `--camelcase`         | `-c`  |           `false`            | convert `snake_case` properties to `camelCase`                           |
+| `--injectWarning`     | `-iw` |           `false`            | injects an “autogenerated file” warning at the top of the generated file |
+| `--nowrapper`         | `-nw` |           `false`            | disables rendering a wrapper                                             |
 
 ### Node
 
@@ -124,14 +122,12 @@ const input = JSON.parse(readFileSync('spec.json', 'utf8')); // Input can be any
 const output = swaggerToTS(input, { wrapper: 'declare namespace MyAPI' }); // Outputs TypeScript defs as a string (to be parsed, or written to a file)
 ```
 
-The Node API is a bit more flexible: it will only take a JS object as input
-(OpenAPI format), and return a string of TS definitions. This lets you pull
-from any source (a Swagger server, local files, etc.), and similarly lets you
-parse, post-process, and save the output anywhere.
+The Node API is a bit more flexible: it will only take a JS object as input (OpenAPI format), and
+return a string of TS definitions. This lets you pull from any source (a Swagger server, local
+files, etc.), and similarly lets you parse, post-process, and save the output anywhere.
 
-If your specs are in YAML, you’ll have to convert them to JS objects using a
-library such as [js-yaml][js-yaml]. If you’re batching large folders of
-specs, [glob][glob] may also come in handy.
+If your specs are in YAML, you’ll have to convert them to JS objects using a library such as
+[js-yaml][js-yaml]. If you’re batching large folders of specs, [glob][glob] may also come in handy.
 
 #### Node Options