@visulima/jsdoc-open-api 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## @visulima/jsdoc-open-api [1.2.0](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@1.1.1...@visulima/jsdoc-open-api@1.2.0) (2022-11-15)
+
+
+### Features
+
+* added new packages for faster api creation ([#14](https://github.com/visulima/visulima/issues/14)) ([eb64fcf](https://github.com/visulima/visulima/commit/eb64fcf33f2a75ea48262ad6e71f80e159a93972))
+
+
+
+### Dependencies
+
+* **@visulima/readdir:** upgraded to 1.3.0
+
+## @visulima/jsdoc-open-api [1.1.1](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@1.1.0...@visulima/jsdoc-open-api@1.1.1) (2022-10-31)
+
+
+### Bug Fixes
+
+* **jsdoc-open-api:** make bin file executable ([469cb9b](https://github.com/visulima/visulima/commit/469cb9bd32e1815354a46c1dd6fca8c1a3532f32))
+* **jsdoc-open-api:** removed second to in the txt ([dc5eebb](https://github.com/visulima/visulima/commit/dc5eebb96c220c21171753238eb6b1d7c2da58a1))
+
 ## @visulima/jsdoc-open-api [1.1.0](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@1.0.3...@visulima/jsdoc-open-api@1.1.0) (2022-10-29)
 
 

package/README.md

@@ -119,7 +119,7 @@ const withOpenApi = ({ definition, sources, verbose, output = "swagger/swagger.j
 module.exports = withOpenApi;
 ```
 
-#### next.config.js
+#### Next.config.js
 ```js
 const withOpenApi = require("./with-open-api");
 
@@ -147,7 +147,7 @@ module.exports = withOpenApi({
 })(nextConfig);
 ```
 
-## OpenApi yaml syntax
+## OpenApi YAML syntax
 
 The library will take the contents of @openapi (or @swagger):
 
@@ -246,7 +246,7 @@ For example, this JSON object:
 }
 ```
 
-can be represented as:
+Can be represented as:
 
 ```yaml
 components:
@@ -263,7 +263,7 @@ components:
         - name
 ```
 
-and then referenced in the request body schema and response body schema as follows:
+And then referenced in the request body schema and response body schema as follows:
 
 ```js
 /**

package/bin/index.js

@@ -28,7 +28,7 @@ const package_ = require("../package.json");
 const program = new Command();
 const defaultConfigName = ".openapirc.js";
 
-program.name("@visulima/jsdoc-open-api").description("CLI to to generate OpenAPI (Swagger) documentation from JSDoc's").version(package_.version);
+program.name("@visulima/jsdoc-open-api").description("CLI to generate OpenAPI (Swagger) documentation from JSDoc's").version(package_.version);
 
 program
     .command("init")

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@visulima/jsdoc-open-api",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "description": "Generates swagger doc based on JSDoc.",
     "keywords": [
         "visulima",
@@ -65,13 +65,13 @@
         "clean": "rimraf node_modules dist",
         "coverage": "vitest run --coverage",
         "dev": "pnpm predev && pnpm run build --watch",
-        "lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs --cache --cache-strategy content .",
+        "lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs",
         "lint:eslint:fix": "pnpm run lint:eslint --fix",
         "test": "vitest"
     },
     "dependencies": {
         "@apidevtools/swagger-parser": "^10.1.0",
-        "@visulima/readdir": "1.2.0",
+        "@visulima/readdir": "1.3.0",
         "cli-progress": "^3.11.2",
         "commander": "^9.4.1",
         "comment-parser": "^1.3.1",