openapi-typescript - npm Package Compare versions

Comparing version 4.3.0 to 4.4.0

dist/cjs/transform/schema.js

@@ -14,4 +14,9 @@ "use strict";
         const v = obj[k];
+        let schemaComment = "";
+        if (v.deprecated)
+            schemaComment += `@deprecated `;
         if (v.description)
-            output += (0, utils_1.comment)(v.description);
+            schemaComment += v.description;
+        if (schemaComment)
+            output += (0, utils_1.comment)(schemaComment);
         const readonly = (0, utils_1.tsReadonly)(options.immutableTypes);
@@ -18,0 +23,0 @@ const required = options.required.has(k) || (options.defaultNonNullable && hasDefaultValue(v.schema || v)) ? "" : "?";

dist/esm/transform/schema.js

@@ -11,4 +11,9 @@ import { comment, nodeType, tsArrayOf, tsIntersectionOf, tsPartial, tsReadonly, tsTupleOf, tsUnionOf } from "../utils";
         const v = obj[k];
+        let schemaComment = "";
+        if (v.deprecated)
+            schemaComment += `@deprecated `;
         if (v.description)
-            output += comment(v.description);
+            schemaComment += v.description;
+        if (schemaComment)
+            output += comment(schemaComment);
         const readonly = tsReadonly(options.immutableTypes);
@@ -15,0 +20,0 @@ const required = options.required.has(k) || (options.defaultNonNullable && hasDefaultValue(v.schema || v)) ? "" : "?";

package.json

 {
   "name": "openapi-typescript",
   "description": "Generate TypeScript types from Swagger OpenAPI specs",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "engines": {
@@ -52,5 +52,5 @@ "node": ">= 12.0.0",
     "pregenerate": "npm run build",
-    "test": "npm run build && jest --no-cache",
+    "test": "npm run build && jest --testTimeout=30000",
     "test:watch": "npm run build && jest --no-cache --watch",
-    "test:update": "npm run build && jest --no-cache --u",
+    "test:update": "npm run build && jest -u",
     "test:coverage": "npm run build && jest --no-cache --coverage && codecov",
@@ -77,9 +77,9 @@ "test:coverage:local": "npm run build && jest --no-cache --collectCoverage",
     "@types/node-fetch": "^2.5.12",
-    "@typescript-eslint/eslint-plugin": "^4.32.0",
-    "@typescript-eslint/parser": "^4.32.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "codecov": "^3.8.2",
-    "eslint": "^7.32.0",
+    "eslint": "^8.0.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.2.4",
+    "jest": "^27.2.5",
     "ts-jest": "^27.0.5",
@@ -86,0 +86,0 @@ "typescript": "^4.4.3"

README.md

@@ -6,3 +6,3 @@ [![version(scoped)](https://img.shields.io/npm/v/openapi-typescript.svg)](https://www.npmjs.com/package/openapi-typescript)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-42-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-43-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
@@ -255,2 +255,5 @@
   </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/bunkscene"><img src="https://avatars.githubusercontent.com/u/2693678?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dave Carlson</b></sub></a><br /><a href="https://github.com/drwpow/openapi-typescript/commits?author=bunkscene" title="Code">💻</a></td>
+  </tr>
 </table>
@@ -257,0 +260,0 @@

src/transform/schema.ts

@@ -22,3 +22,6 @@ import { GlobalContext } from "../types";
     // 1. JSDoc comment (goes above property)
-    if (v.description) output += comment(v.description);
+    let schemaComment = "";
+    if (v.deprecated) schemaComment += `@deprecated `;
+    if (v.description) schemaComment += v.description;
+    if (schemaComment) output += comment(schemaComment);
 
@@ -25,0 +28,0 @@ // 2. name (with “?” if optional property)

No alert changes

Improved metrics

Total package byte prevSize

248193

increased by0.42%

Lines of code

3672

increased by0.36%

Number of lines in readme file

266

increased by1.14%

No dependency changes