fix(nxdoc): nxdocs fails to run if any file does not have getting sta…

…rted text
nx-dotnet · May 24, 2021 · f6b800f · f6b800f
1 parent e1b58a6
commit f6b800f
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 60 deletions.
diff --git a/docs/core/executors/format.md b/docs/core/executors/format.md
@@ -24,7 +24,6 @@ Formats and lints a project using the dotnet-format tool
 
 ### diagnostics
 
--
 - (string): A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
 - (array): A list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
 

diff --git a/docs/typescript/index.md b/docs/typescript/index.md
@@ -4,33 +4,4 @@ sidebar_position: 0
 slug: /typescript/
 ---
 
-# Getting Started
-
-> The features for this package are not yet implemented. This package will be used to generate typescript interfaces given a web-api project in the future.
-
-## Prerequisites
-
-- Have an existing nx workspace. For creating this, see [nrwl's documentation](https://nx.dev/latest/angular/getting-started/nx-setup).
-- .NET SDK is installed, and `dotnet` is available on the path. For help on this, see [Microsoft's documentation](https://dotnet.microsoft.com/learn/dotnet/hello-world-tutorial/install)
-
-## Installation
-
-### NPM
-
-```shell
-npm i --save-dev @nx-dotnet/typescript
-```
-
-### PNPM
-
-```shell
-pnpm i --save-dev @nx-dotnet/typescript
-```
-
-### Yarn
-
-```shell
-yarn add --dev @nx-dotnet/typescript
-```
-
 # API Reference
diff --git a/packages/nxdoc/src/generators/generate-docs/generator.ts b/packages/nxdoc/src/generators/generate-docs/generator.ts
@@ -30,11 +30,15 @@ export default async function (host: Tree, options: Schema) {
   }[] = [];
 
   projects.forEach((project) => {
-    const gettingStartedFile = options.gettingStartedFile.replace(
+    let gettingStartedFile: string | null = options.gettingStartedFile.replace(
       '<src>',
       project.root,
     );
 
+    gettingStartedFile = host.exists(gettingStartedFile)
+      ? gettingStartedFile
+      : null;
+
     const generatorsCollection: GeneratorsCollection = project.generators
       ? readJson<GeneratorsCollection>(host, `${project.root}/generators.json`)
       : ({} as GeneratorsCollection);
@@ -67,7 +71,7 @@ export default async function (host: Tree, options: Schema) {
         generators,
         executors,
         underscore: '_',
-        gettingStartedMd: options.gettingStartedFile
+        gettingStartedMd: gettingStartedFile
           ? readFileSync(gettingStartedFile).toString()
           : '',
         frontMatter: options.skipFrontMatter

diff --git a/...es/nxdoc/src/generators/generate-docs/templates/detail/__generatorFileName__.md b/...es/nxdoc/src/generators/generate-docs/templates/detail/__generatorFileName__.md
@@ -12,7 +12,8 @@
 
 ### <%- (schema.required?.includes?.(property)) ? `<span className="required">${property}</span>` : property %>
 
-- <% if (!config.oneOf) { %>(<%=config.type%>): <%= config.description %>
-  <%} else { config.oneOf.forEach(x => {%>
+<% if (!config.oneOf) { %>- (<%=config.type%>): <%= config.description %>
+<%} else { config.oneOf.forEach(x => {%>
+
 - (<%= x.type %>): <%=x.description%>
   <% })}})} %>
diff --git a/packages/typescript/README.md b/packages/typescript/README.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,7 +24,6 @@ Formats and lints a project using the dotnet-format tool @@
     ### diagnostics
-    -
     - (string): A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
     - (array): A list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
@@ Expand Down @@