feat(core): add CI generator WIP

nrwl · Apr 4, 2022 · ba3d962 · ba3d962
1 parent b627016
commit ba3d962
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 5 deletions.
diff --git a/docs/generated/cli/create-nx-workspace.md b/docs/generated/cli/create-nx-workspace.md
@@ -33,9 +33,11 @@ The name of the application when a preset with pregenerated app is selected
 
 ### ci
 
-Default: `[]`
+Type: array
 
-Choices: `["github", "circleci", "azure"]`
+Choices: ["github", "circleci", "azure"]
+
+Default: []
 
 Generate a CI workflow file
 

diff --git a/docs/generated/packages/workspace.json b/docs/generated/packages/workspace.json
@@ -654,6 +654,49 @@
       "aliases": [],
       "hidden": false,
       "path": "/packages/workspace/src/generators/npm-package/schema.json"
+    },
+    {
+      "name": "ci-workflow",
+      "factory": "./src/generators/ci-workflow/ci-workflow#ciWorkflowGenerator",
+      "schema": {
+        "$schema": "http://json-schema.org/schema",
+        "$id": "NxWorkspaceNpmPackage",
+        "title": "Generate a CI workflow.",
+        "description": "Generate a CI workflow.",
+        "cli": "nx",
+        "type": "object",
+        "properties": {
+          "ci": {
+            "type": "string",
+            "description": "CI provider.",
+            "$default": { "$source": "argv", "index": 0 },
+            "default": "github",
+            "x-prompt": {
+              "message": "What is your target CI provider?",
+              "type": "list",
+              "items": [
+                { "value": "github", "label": "Github Actions" },
+                { "value": "circleci", "label": "Circle CI" },
+                { "value": "azure", "label": "Azure DevOps" }
+              ]
+            }
+          },
+          "name": {
+            "type": "string",
+            "description": "Workflow name.",
+            "$default": { "$source": "argv", "index": 0 },
+            "x-prompt": "How should we name your workflow?",
+            "pattern": "^[a-zA-Z].*$"
+          }
+        },
+        "required": ["ci"],
+        "presets": []
+      },
+      "description": "Generete a CI workflow.",
+      "implementation": "/packages/workspace/src/generators/ci-workflow/ci-workflow#ciWorkflowGenerator.ts",
+      "aliases": [],
+      "hidden": false,
+      "path": "/packages/workspace/src/generators/ci-workflow/schema.json"
     }
   ],
   "executors": [

diff --git a/docs/packages.json b/docs/packages.json
@@ -275,7 +275,8 @@
         "workspace-generator",
         "run-commands",
         "convert-to-nx-project",
-        "npm-package"
+        "npm-package",
+        "ci-workflow"
       ]
     }
   }

diff --git a/packages/create-nx-workspace/bin/create-nx-workspace.ts b/packages/create-nx-workspace/bin/create-nx-workspace.ts
@@ -671,8 +671,8 @@ async function determineCI(
           type: 'multiselect',
           choices: [
             { name: 'GitHub Actions', value: 'github' },
-            { name: 'CircleCI', value: 'circleci' },
-            { name: 'Azure', value: 'azure' },
+            { name: 'Circle CI', value: 'circleci' },
+            { name: 'Azure DevOps', value: 'azure' },
           ],
         },
       ])

diff --git a/packages/workspace/generators.json b/packages/workspace/generators.json
@@ -141,6 +141,12 @@
       "schema": "./src/generators/npm-package/schema.json",
       "description": "Create a minimal NPM package.",
       "x-type": "library"
+    },
+
+    "ci-workflow": {
+      "factory": "./src/generators/ci-workflow/ci-workflow#ciWorkflowGenerator",
+      "schema": "./src/generators/ci-workflow/schema.json",
+      "description": "Generete a CI workflow."
     }
   }
 }
diff --git a/packages/workspace/src/generators/ci-workflow/ci-workflow.ts b/packages/workspace/src/generators/ci-workflow/ci-workflow.ts
@@ -0,0 +1,10 @@
+import { Tree } from '@nrwl/devkit';
+
+export interface Schema {
+  name?: string;
+  ci: 'github' | 'azure' | 'circleci';
+}
+
+export async function ciWorkflowGenerator(tree: Tree, options: Schema) {
+  // TODO: Implement
+}
diff --git a/packages/workspace/src/generators/ci-workflow/schema.json b/packages/workspace/src/generators/ci-workflow/schema.json
@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "NxWorkspaceNpmPackage",
+  "title": "Generate a CI workflow.",
+  "description": "Generate a CI workflow.",
+  "cli": "nx",
+  "type": "object",
+  "properties": {
+    "ci": {
+      "type": "string",
+      "description": "CI provider.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "default": "github",
+      "x-prompt": {
+        "message": "What is your target CI provider?",
+        "type": "list",
+        "items": [
+          { "value": "github", "label": "Github Actions" },
+          { "value": "circleci", "label": "Circle CI" },
+          { "value": "azure", "label": "Azure DevOps" }
+        ]
+      }
+    },
+    "name": {
+      "type": "string",
+      "description": "Workflow name.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "How should we name your workflow?",
+      "pattern": "^[a-zA-Z].*$"
+    }
+  },
+  "required": ["ci"]
+}