Merge pull request #8 from BeyerleinDigital/4-create-project-generator

beyerleinf · web-flow · commit 7ed39f4552b8 · 2022-10-09T00:45:34.000+02:00
feat(generators): Implement create-project
diff --git a/packages/azure-functions/generators.json b/packages/azure-functions/generators.json
@@ -3,10 +3,10 @@
   "name": "azure-functions",
   "version": "0.0.1",
   "generators": {
-    "azure-functions": {
-      "factory": "./src/generators/azure-functions/generator",
-      "schema": "./src/generators/azure-functions/schema.json",
-      "description": "azure-functions generator"
+    "create-project": {
+      "factory": "./src/generators/create-project/generator",
+      "schema": "./src/generators/create-project/schema.json",
+      "description": "Generate an Azure Functions project."
     }
   }
 }
diff --git a/packages/azure-functions/src/generators/azure-functions/files/src/index.ts__template__ b/packages/azure-functions/src/generators/azure-functions/files/src/index.ts__template__
diff --git a/packages/azure-functions/src/generators/azure-functions/generator.spec.ts b/packages/azure-functions/src/generators/azure-functions/generator.spec.ts
diff --git a/packages/azure-functions/src/generators/create-project/files/.funcignore__tmpl__ b/packages/azure-functions/src/generators/create-project/files/.funcignore__tmpl__
@@ -0,0 +1,7 @@
+*.js.map
+*.ts
+.git*
+.vscode
+local.settings.json
+test
+.azurite
diff --git a/packages/azure-functions/src/generators/create-project/files/.gitignore__tmpl__ b/packages/azure-functions/src/generators/create-project/files/.gitignore__tmpl__
@@ -0,0 +1,48 @@
+bin
+obj
+csx
+.vs
+edge
+Publish
+
+*.user
+*.suo
+*.cscfg
+*.Cache
+project.lock.json
+
+/packages
+/TestResults
+
+/tools/NuGet.exe
+/App_Data
+/secrets
+/data
+.secrets
+appsettings.json
+local.settings.json
+
+node_modules
+dist
+
+# Local python packages
+.python_packages/
+
+# Python Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Azurite artifacts
+__blobstorage__
+__queuestorage__
+__azurite_db*__.json
diff --git a/packages/azure-functions/src/generators/create-project/files/README.md__tmpl__ b/packages/azure-functions/src/generators/create-project/files/README.md__tmpl__
@@ -0,0 +1,3 @@
+# NX Azure Functions
+
+This Azure Functions project was created using [`@beyerleinf/nx-azure-functions`](https://github.com/beyerleinf/nx-azure-functions-integration).
diff --git a/packages/azure-functions/src/generators/create-project/files/host.json__tmpl__ b/packages/azure-functions/src/generators/create-project/files/host.json__tmpl__
@@ -0,0 +1,15 @@
+{
+  "version": "2.0",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    }
+  },
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle",
+    "version": "[2.*, 3.0.0)"
+  }
+}
diff --git a/packages/azure-functions/src/generators/create-project/files/local.settings.example.json__tmpl__ b/packages/azure-functions/src/generators/create-project/files/local.settings.example.json__tmpl__
@@ -0,0 +1,7 @@
+{
+  "IsEncrypted": false,
+  "Values": {
+    "FUNCTIONS_WORKER_RUNTIME": "node",
+    "AzureWebJobsStorage": ""
+  }
+}
diff --git a/packages/azure-functions/src/generators/create-project/files/local.settings.json__tmpl__ b/packages/azure-functions/src/generators/create-project/files/local.settings.json__tmpl__
@@ -0,0 +1,7 @@
+{
+  "IsEncrypted": false,
+  "Values": {
+    "FUNCTIONS_WORKER_RUNTIME": "node",
+    "AzureWebJobsStorage": ""
+  }
+}
diff --git a/packages/azure-functions/src/generators/create-project/files/tsconfig.json__tmpl__ b/packages/azure-functions/src/generators/create-project/files/tsconfig.json__tmpl__
@@ -0,0 +1,11 @@
+{
+  "extends": "<%= offsetFromRoot %>tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es6",
+    "lib": ["DOM", "ES2021"],
+    "importHelpers": true
+  },
+  "include": ["./**/*.ts"],
+  "exclude": ["./**/*.spec.ts"]
+}
diff --git a/packages/azure-functions/src/generators/create-project/generator.ts b/packages/azure-functions/src/generators/create-project/generator.ts
@@ -1,12 +1,16 @@
 import {
+  addDependenciesToPackageJson,
   addProjectConfiguration,
   formatFiles,
   generateFiles,
   getWorkspaceLayout,
+  installPackagesTask,
   names,
   offsetFromRoot,
   Tree,
 } from '@nrwl/devkit';
+import { jestProjectGenerator } from '@nrwl/jest';
+import { Linter, lintProjectGenerator } from '@nrwl/linter';
 import * as path from 'path';
 import { AzureFunctionsGeneratorSchema } from './schema';
 
@@ -26,7 +30,7 @@ function normalizeOptions(
     ? `${names(options.directory).fileName}/${name}`
     : name;
   const projectName = projectDirectory.replace(new RegExp('/', 'g'), '-');
-  const projectRoot = `${getWorkspaceLayout(tree).libsDir}/${projectDirectory}`;
+  const projectRoot = `${getWorkspaceLayout(tree).appsDir}/${projectDirectory}`;
   const parsedTags = options.tags
     ? options.tags.split(',').map((s) => s.trim())
     : [];
@@ -45,8 +49,9 @@ function addFiles(tree: Tree, options: NormalizedSchema) {
     ...options,
     ...names(options.name),
     offsetFromRoot: offsetFromRoot(options.projectRoot),
-    template: '',
+    tmpl: '',
   };
+
   generateFiles(
     tree,
     path.join(__dirname, 'files'),
@@ -55,22 +60,67 @@ function addFiles(tree: Tree, options: NormalizedSchema) {
   );
 }
 
-export default async function (
-  tree: Tree,
-  options: AzureFunctionsGeneratorSchema
-) {
-  const normalizedOptions = normalizeOptions(tree, options);
+function addDependencies(tree: Tree) {
+  addDependenciesToPackageJson(
+    tree,
+    {},
+    { '@azure/functions': '3.0.0', typescript: '4' }
+  );
+}
+
+function addProjectConfig(tree: Tree, normalizedOptions: NormalizedSchema) {
   addProjectConfiguration(tree, normalizedOptions.projectName, {
     root: normalizedOptions.projectRoot,
-    projectType: 'library',
-    sourceRoot: `${normalizedOptions.projectRoot}/src`,
+    projectType: 'application',
+    sourceRoot: `${normalizedOptions.projectRoot}`,
     targets: {
       build: {
         executor: '@beyerleinf/nx-azure-functions:build',
       },
+      serve: {
+        executor: '@beyerleinf/nx-azure-functions:serve',
+      },
     },
     tags: normalizedOptions.parsedTags,
   });
+}
+
+async function addLinting(tree: Tree, normalizedOptions: NormalizedSchema) {
+  return lintProjectGenerator(tree, {
+    project: normalizedOptions.projectName,
+    skipFormat: false,
+    linter: Linter.EsLint,
+  });
+}
+
+async function addJest(tree: Tree, normalizedOptions: NormalizedSchema) {
+  return jestProjectGenerator(tree, {
+    project: normalizedOptions.projectName,
+    testEnvironment: 'node',
+    setupFile: 'none',
+    compiler: 'tsc',
+    supportTsx: false,
+    js: false,
+    skipSerializers: true,
+    skipFormat: true,
+    skipPackageJson: false,
+  });
+}
+
+export default async function (
+  tree: Tree,
+  options: AzureFunctionsGeneratorSchema
+) {
+  const normalizedOptions = normalizeOptions(tree, options);
+
+  addDependencies(tree);
+  addProjectConfig(tree, normalizedOptions);
   addFiles(tree, normalizedOptions);
+
+  await addLinting(tree, normalizedOptions);
+  await addJest(tree, normalizedOptions);
+
   await formatFiles(tree);
+
+  installPackagesTask(tree);
 }
diff --git a/packages/azure-functions/src/generators/create-project/schema.d.ts b/packages/azure-functions/src/generators/create-project/schema.d.ts
diff --git a/packages/azure-functions/src/generators/create-project/schema.json b/packages/azure-functions/src/generators/create-project/schema.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/schema",
   "cli": "nx",
-  "$id": "AzureFunctions",
+  "$id": "CreateProject",
   "title": "",
   "type": "object",
   "properties": {

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,10 @@`
`3`	`3`	`"name": "azure-functions",`
`4`	`4`	`"version": "0.0.1",`
`5`	`5`	`"generators": {`
`6`		`- "azure-functions": {`
`7`		`- "factory": "./src/generators/azure-functions/generator",`
`8`		`- "schema": "./src/generators/azure-functions/schema.json",`
`9`		`- "description": "azure-functions generator"`
	`6`	`+ "create-project": {`
	`7`	`+ "factory": "./src/generators/create-project/generator",`
	`8`	`+ "schema": "./src/generators/create-project/schema.json",`
	`9`	`+ "description": "Generate an Azure Functions project."`
`10`	`10`	`}`
`11`	`11`	`}`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# NX Azure Functions`
	`2`	`+`
	`3`	+This Azure Functions project was created using [`@beyerleinf/nx-azure-functions`](https://github.com/beyerleinf/nx-azure-functions-integration).