feat(repo): docs generator prints options

nx-dotnet · May 21, 2021 · bddc5b5 · bddc5b5
1 parent a7828c5
commit bddc5b5
Show file tree

Hide file tree

Showing 25 changed files with 398 additions and 83 deletions.
diff --git a/docs/core/core.md b/docs/core/core.md
diff --git a/docs/core/executors/app.md b/docs/core/executors/app.md
@@ -0,0 +1,31 @@
+# app
+
+## NxDotnet Application Generator
+
+## Options
+
+### name (string)
+
+### tags (string)
+
+Add tags to the project (used for linting)
+
+### directory (string)
+
+A directory where the project is placed
+
+### template (string)
+
+The template to instantiate when the command is invoked. Each template might have specific options you can pass.
+
+### language (string)
+
+Which language should the project use?
+
+### testTemplate (string)
+
+Which template should be used for creating the tests project?
+
+### skipOutputPathManipulation (boolean)
+
+Skip XML changes for default build path
diff --git a/docs/core/executors/init.md b/docs/core/executors/init.md
@@ -0,0 +1,3 @@
+# init
+
+## Initialize NxDotnet
diff --git a/docs/core/executors/lib.md b/docs/core/executors/lib.md
@@ -0,0 +1,27 @@
+# lib
+
+## NxDotnet Library Generator
+
+## Options
+
+### name (string)
+
+### tags (string)
+
+Add tags to the project (used for linting)
+
+### directory (string)
+
+A directory where the project is placed
+
+### template (string)
+
+The template to instantiate when the command is invoked. Each template might have specific options you can pass.
+
+### language (string)
+
+Which language should the project use?
+
+### testTemplate (string)
+
+Which template should be used for creating the tests project?
diff --git a/docs/core/executors/nuget-reference.md b/docs/core/executors/nuget-reference.md
@@ -0,0 +1,37 @@
+# nuget-reference
+
+## Options
+
+### project (string)
+
+### packageName (string)
+
+Which package should be added?
+
+### version (string)
+
+The package version to add.
+
+### framework (string)
+
+Adds a package reference only when targeting a specific framework.
+
+### packageDirectory (string)
+
+The directory where to restore the packages. The default package restore location is %userprofile%\.nuget\packages on Windows and ~/.nuget/packages on macOS and Linux. For more information, see [Managing the global packages, cache, and temp folders in NuGet](https://docs.microsoft.com/en-us/nuget/consume-packages/managing-the-global-packages-and-cache-folders).
+
+### prerelease (boolean)
+
+Allows prerelease packages to be installed. Available since .NET Core 5 SDK
+
+### source (string)
+
+The URI of the NuGet package source to use during the restore operation.
+
+### noRestore (boolean)
+
+Adds a package reference without performing a restore preview and compatibility check.
+
+### allowVersionMismatch (boolean)
+
+Ignores single version principle for this package across all apps in the workspace
diff --git a/docs/core/executors/project-reference.md b/docs/core/executors/project-reference.md
@@ -0,0 +1,13 @@
+# project-reference
+
+## NxDotnet Application Generator
+
+## Options
+
+### project (string)
+
+Host project
+
+### reference (string)
+
+Source project
diff --git a/docs/core/executors/restore.md b/docs/core/executors/restore.md
@@ -0,0 +1 @@
+# restore
diff --git a/docs/core/executors/sync.md b/docs/core/executors/sync.md
@@ -0,0 +1 @@
+# sync
diff --git a/docs/core/generators/app.md b/docs/core/generators/app.md
@@ -0,0 +1,31 @@
+# app
+
+## NxDotnet Application Generator
+
+## Options
+
+### name (string)
+
+### tags (string)
+
+Add tags to the project (used for linting)
+
+### directory (string)
+
+A directory where the project is placed
+
+### template (string)
+
+The template to instantiate when the command is invoked. Each template might have specific options you can pass.
+
+### language (string)
+
+Which language should the project use?
+
+### testTemplate (string)
+
+Which template should be used for creating the tests project?
+
+### skipOutputPathManipulation (boolean)
+
+Skip XML changes for default build path
diff --git a/docs/core/generators/init.md b/docs/core/generators/init.md
@@ -0,0 +1,3 @@
+# init
+
+## Initialize NxDotnet
diff --git a/docs/core/generators/lib.md b/docs/core/generators/lib.md
@@ -0,0 +1,27 @@
+# lib
+
+## NxDotnet Library Generator
+
+## Options
+
+### name (string)
+
+### tags (string)
+
+Add tags to the project (used for linting)
+
+### directory (string)
+
+A directory where the project is placed
+
+### template (string)
+
+The template to instantiate when the command is invoked. Each template might have specific options you can pass.
+
+### language (string)
+
+Which language should the project use?
+
+### testTemplate (string)
+
+Which template should be used for creating the tests project?
diff --git a/docs/core/generators/nuget-reference.md b/docs/core/generators/nuget-reference.md
@@ -0,0 +1,37 @@
+# nuget-reference
+
+## Options
+
+### project (string)
+
+### packageName (string)
+
+Which package should be added?
+
+### version (string)
+
+The package version to add.
+
+### framework (string)
+
+Adds a package reference only when targeting a specific framework.
+
+### packageDirectory (string)
+
+The directory where to restore the packages. The default package restore location is %userprofile%\.nuget\packages on Windows and ~/.nuget/packages on macOS and Linux. For more information, see [Managing the global packages, cache, and temp folders in NuGet](https://docs.microsoft.com/en-us/nuget/consume-packages/managing-the-global-packages-and-cache-folders).
+
+### prerelease (boolean)
+
+Allows prerelease packages to be installed. Available since .NET Core 5 SDK
+
+### source (string)
+
+The URI of the NuGet package source to use during the restore operation.
+
+### noRestore (boolean)
+
+Adds a package reference without performing a restore preview and compatibility check.
+
+### allowVersionMismatch (boolean)
+
+Ignores single version principle for this package across all apps in the workspace
diff --git a/docs/core/generators/project-reference.md b/docs/core/generators/project-reference.md
@@ -0,0 +1,13 @@
+# project-reference
+
+## NxDotnet Application Generator
+
+## Options
+
+### project (string)
+
+Host project
+
+### reference (string)
+
+Source project
diff --git a/docs/core/generators/restore.md b/docs/core/generators/restore.md
@@ -0,0 +1 @@
+# restore
diff --git a/docs/core/generators/sync.md b/docs/core/generators/sync.md
@@ -0,0 +1 @@
+# sync
diff --git a/docs/core/index.md b/docs/core/index.md
@@ -0,0 +1,53 @@
+# core
+
+## Generators
+
+### [lib](./generators/lib.md)
+
+nx-dotnet generator
+
+### [app](./generators/app.md)
+
+Generate a new C# project.
+
+### [project-reference](./generators/project-reference.md)
+
+Adds a reference from one project to another.
+
+### [init](./generators/init.md)
+
+init generator
+
+### [sync](./generators/sync.md)
+
+sync generator
+
+### [nuget-reference](./generators/nuget-reference.md)
+
+nuget-reference generator
+
+### [restore](./generators/restore.md)
+
+Restores NuGet packages and .NET tools used by the workspace
+
+## Executors
+
+### [build](./executors/build.md)
+
+build executor
+
+### [serve](./executors/serve.md)
+
+serve executor
+
+### [test](./executors/test.md)
+
+test executor
+
+### [publish](./executors/publish.md)
+
+publish executor
+
+### [format](./executors/format.md)
+
+Formats and lints a project using the dotnet-format tool
diff --git a/docs/typescript/index.md b/docs/typescript/index.md
@@ -0,0 +1 @@
+# typescript
diff --git a/docs/typescript/typescript.md b/docs/typescript/typescript.md
diff --git a/packages/core/src/generators/app/schema.json b/packages/core/src/generators/app/schema.json
@@ -43,6 +43,7 @@
       "type": "string",
       "description": "Which template should be used for creating the tests project?",
       "default": "nunit",
+      "enum": ["nunit", "xunit", "mstest", "none"],
       "x-prompt": {
         "message": "Which template should be used for creating the tests project",
         "type": "list",

diff --git a/packages/typescript/executors.json b/packages/typescript/executors.json
@@ -1,10 +1,10 @@
 {
   "$schema": "http://json-schema.org/schema",
   "executors": {
-    "build": {
-      "implementation": "./src/executors/build/executor",
-      "schema": "./src/executors/build/schema.json",
-      "description": "build executor"
-    }
+    // "build": {
+    //   "implementation": "./src/executors/build/executor",
+    //   "schema": "./src/executors/build/schema.json",
+    //   "description": "build executor"
+    // }
   }
 }
diff --git a/packages/typescript/generators.json b/packages/typescript/generators.json
@@ -3,10 +3,10 @@
   "name": "typescript",
   "version": "0.0.1",
   "generators": {
-    "typescript": {
-      "factory": "./src/generators/typescript/generator",
-      "schema": "./src/generators/typescript/schema.json",
-      "description": "typescript generator"
-    }
+    // "typescript": {
+    //   "factory": "./src/generators/typescript/generator",
+    //   "schema": "./src/generators/typescript/schema.json",
+    //   "description": "typescript generator"
+    // }
   }
 }