fix(type-safe-api): add missing gitignores for manifest files and remove openapi generator config (#869)

* fix(type-safe-api): add missing gitignores for manifest files and remove openapi generator config

Add missing .gitignore entries for the `.tsapi-manifest` file.

Remove the OpenAPI generator CLI configs from projects which no longer use OpenAPI generator.

* feat(type-safe-api): deprecate html2 documentation format

Deprecate HTML2 documentation format. HTML_REDOC should be used for HTML documentation instead.

The HTML2 documentation format will be removed in 0.24.0.

Author: cogwirrel

packages/type-safe-api/src/project/codegen/documentation/generated-html-redoc-documentation-project.ts

@@ -2,7 +2,6 @@
 SPDX-License-Identifier: Apache-2.0 */
 import { Project, ProjectOptions, Task } from "projen";
 import { GeneratedHtmlRedocDocumentationOptions } from "../../types";
-import { OpenApiToolsJsonFile } from "../components/open-api-tools-json-file";
 import { TypeSafeApiCommandEnvironment } from "../components/type-safe-api-command-environment";
 
 export interface GeneratedHtmlRedocDocumentationProjectOptions
@@ -21,11 +20,6 @@ export class GeneratedHtmlRedocDocumentationProject extends Project {
     super(options);
     TypeSafeApiCommandEnvironment.ensure(this);
 
-    // Add OpenAPI Generator cli configuration
-    OpenApiToolsJsonFile.ensure(this).addOpenApiGeneratorCliConfig(
-      options.openApiGeneratorCliConfig
-    );
-
     this.generateTask = this.addTask("generate");
     this.generateTask.exec(
       `npx --yes @redocly/[email protected] build-docs "${options.specPath}" --output ./index.html`

packages/type-safe-api/src/project/codegen/documentation/generated-markdown-documentation-project.ts

@@ -2,7 +2,6 @@
 SPDX-License-Identifier: Apache-2.0 */
 import { Project, ProjectOptions, Task } from "projen";
 import { GeneratedMarkdownDocumentationOptions } from "../../types";
-import { OpenApiToolsJsonFile } from "../components/open-api-tools-json-file";
 import { TypeSafeApiCommandEnvironment } from "../components/type-safe-api-command-environment";
 import {
   buildCodegenCommandArgs,
@@ -26,11 +25,6 @@ export class GeneratedMarkdownDocumentationProject extends Project {
     super(options);
     TypeSafeApiCommandEnvironment.ensure(this);
 
-    // Add OpenAPI Generator cli configuration
-    OpenApiToolsJsonFile.ensure(this).addOpenApiGeneratorCliConfig(
-      options.openApiGeneratorCliConfig
-    );
-
     this.generateTask = this.addTask("generate");
     this.generateTask.exec(
       buildTypeSafeApiExecCommand(
@@ -45,14 +39,9 @@ export class GeneratedMarkdownDocumentationProject extends Project {
     this.compileTask.spawn(this.generateTask);
 
     if (!options.commitGeneratedCode) {
-      this.gitignore.addPatterns(
-        ".openapi-generator",
-        "Apis",
-        "Models",
-        "README.md"
-      );
-    } else {
-      this.gitignore.addPatterns(".openapi-generator");
+      this.gitignore.addPatterns("Apis", "Models", "README.md");
     }
+
+    this.gitignore.addPatterns(".openapi-generator", ".tsapi-manifest");
   }
 }

packages/type-safe-api/src/project/codegen/documentation/generated-plantuml-documentation-project.ts

@@ -2,7 +2,6 @@
 SPDX-License-Identifier: Apache-2.0 */
 import { Project, ProjectOptions, Task } from "projen";
 import { GeneratedPlantumlDocumentationOptions } from "../../types";
-import { OpenApiToolsJsonFile } from "../components/open-api-tools-json-file";
 import { TypeSafeApiCommandEnvironment } from "../components/type-safe-api-command-environment";
 import {
   buildCodegenCommandArgs,
@@ -26,11 +25,6 @@ export class GeneratedPlantumlDocumentationProject extends Project {
     super(options);
     TypeSafeApiCommandEnvironment.ensure(this);
 
-    // Add OpenAPI Generator cli configuration
-    OpenApiToolsJsonFile.ensure(this).addOpenApiGeneratorCliConfig(
-      options.openApiGeneratorCliConfig
-    );
-
     this.generateTask = this.addTask("generate");
     this.generateTask.exec(
       buildTypeSafeApiExecCommand(
@@ -45,9 +39,9 @@ export class GeneratedPlantumlDocumentationProject extends Project {
     this.compileTask.spawn(this.generateTask);
 
     if (!options.commitGeneratedCode) {
-      this.gitignore.addPatterns(".openapi-generator", "schemas.plantuml");
-    } else {
-      this.gitignore.addPatterns(".openapi-generator");
+      this.gitignore.addPatterns("schemas.plantuml");
     }
+
+    this.gitignore.addPatterns(".openapi-generator", ".tsapi-manifest");
   }
 }

packages/type-safe-api/src/project/codegen/infrastructure/cdk/generated-java-cdk-infrastructure-base-project.ts

@@ -128,6 +128,8 @@ export abstract class GeneratedJavaCdkInfrastructureBaseProject extends JavaProj
       "echo $(pwd) > src/main/resources/project-absolute-path.txt"
     );
 
+    this.gitignore.addPatterns(".tsapi-manifest", ".openapi-generator");
+
     this.preCompileTask.spawn(generateTask);
   }
 

packages/type-safe-api/src/project/codegen/library/generated-typescript-library-project.ts

@@ -92,12 +92,7 @@ export abstract class GeneratedTypescriptLibraryProject extends TypeScriptProjec
 
     if (!options.commitGeneratedCode) {
       // Ignore all the generated code
-      this.gitignore.addPatterns(
-        "src",
-        ".npmignore",
-        "README.md",
-        ".openapi-generator"
-      );
+      this.gitignore.addPatterns("src", ".npmignore", "README.md");
     }
 
     this.gitignore.addPatterns(".openapi-generator", ".tsapi-manifest");

packages/type-safe-api/src/project/languages.ts

@@ -59,6 +59,7 @@ export enum DocumentationFormat {
   /**
    * OpenAPI Generator 'html2' documentation
    * @see https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/html2.md
+   * @deprecated Will be removed in 0.24.0. Please use HTML_REDOC instead for HTML documentation.
    */
   HTML2 = "html2",
   /**

packages/type-safe-api/src/project/types.ts

@@ -505,6 +505,7 @@ export interface GeneratedDocumentationOptions {
   readonly htmlRedoc?: GeneratedHtmlRedocDocumentationOptions;
   /**
    * Generated html2 documentation project options
+   * @deprecated Will be removed in 0.24.0. Please use HTML_REDOC for HTML documentation.
    */
   readonly html2?: GeneratedHtml2DocumentationOptions;
   /**
@@ -541,6 +542,7 @@ export interface GeneratedDocumentationProjects {
   readonly htmlRedoc?: Project;
   /**
    * Generated html2 documentation project
+   * @deprecated Will be removed in 0.24.0. Please use HTML_REDOC for HTML documentation.
    */
   readonly html2?: Project;
   /**