Merge pull request #74 from arkahna/feature/FB-161_UpdateNxPluginDisc…

…riptionsToMatchDocs

Update nx-plugin interface descriptions to match docs

.changeset/quick-icons-walk.md

@@ -0,0 +1,6 @@
+---
+'@featureboard/nx-plugin': patch
+---
+
+Update nx-plugin interface descriptions to match docs
+Fix location bug with executor

apps/examples/dotnet-api/Controllers/WeatherForecastController.cs

@@ -23,10 +23,10 @@ public WeatherForecastController(ILogger<WeatherForecastController> logger, IFea
   }
 
   [HttpGet(Name = "GetWeatherForecast")]
-  [FeatureFilter(BooleanFeature.AudiencesWrite, false)]
+  [FeatureFilter(BooleanFeature.ViewSubscribers, false)]
   public ActionResult<WeatherForecast[]> Get()
   {
-    if (_featureBoardClient.GetFeatureValue(features => features.AudiencesWrite, false))
+    if (_featureBoardClient.GetFeatureValue(features => features.ViewSubscribers, false))
     {
       return Ok(Enumerable.Range(1, 5).Select(index => new WeatherForecast
       {

libs/code-generator/src/lib/code-generator.ts

@@ -26,6 +26,9 @@ export interface CodeGeneratorOptions {
     interactive: boolean
 
     tree: Tree
+    /**
+     * Relative path to the tree root
+     */
     relativeFilePath: string
 }
 

libs/code-generator/src/lib/generators/dotnet-api/functions.ts

@@ -34,6 +34,8 @@ export function getDotNetNameSpace(tree: Tree, filePath: string): string {
     if (namespace) return namespace
 
     const parentDir = path.join(filePath, '..')
-    if (parentDir == filePath) throw new Error("Can't find .net project file")
+    if (parentDir == filePath || parentDir == '.')
+        throw new Error("Can't find .net project file")
+
     return getDotNetNameSpace(tree, parentDir)
 }

libs/nx-plugin/executors.json

@@ -3,7 +3,7 @@
         "code-gen": {
             "implementation": "./src/executors/code-gen/executor",
             "schema": "./src/executors/code-gen/schema.json",
-            "description": "Generates FeatureBoard types for your chosen language"
+            "description": "Generates code based on FeatureBoard configuration."
         }
     }
 }

libs/nx-plugin/generators.json

@@ -3,12 +3,12 @@
         "code-gen": {
             "factory": "./src/generators/code-gen/generator",
             "schema": "./src/generators/code-gen/schema.json",
-            "description": "Generates FeatureBoard types for your chosen language"
+            "description": "Generate code based on FeatureBoard configuration."
         },
         "add-code-gen-target": {
             "factory": "./src/generators/add-code-gen-target/generator",
             "schema": "./src/generators/add-code-gen-target/schema.json",
-            "description": "Adds code gen to a projects targets"
+            "description": "Adds the code-gen executor to the project target."
         }
     }
 }

libs/nx-plugin/src/executors/code-gen/executor.spec.ts

@@ -98,7 +98,6 @@ describe('code-gen executor', () => {
 
         it('should run successfully', async () => {
             const output = await codeGenExecutor(options, context, tree)
-
             expect(output?.success).toBe(true)
         })
 

libs/nx-plugin/src/executors/code-gen/executor.ts

@@ -2,10 +2,11 @@ import {
     getValidToken,
     readCurrentOrganization,
 } from '@featureboard/api-authentication'
-import type { FeatureBoardAuth } from '@featureboard/code-generator'
-import { codeGenerator } from '@featureboard/code-generator'
-import type { ExecutorContext, Tree } from '@nx/devkit'
-import { joinPathFragments } from '@nx/devkit'
+import {
+    codeGenerator,
+    type FeatureBoardAuth,
+} from '@featureboard/code-generator'
+import { joinPathFragments, type ExecutorContext, type Tree } from '@nx/devkit'
 import { FsTree, flushChanges, printChanges } from 'nx/src/generators/tree'
 import { API_ENDPOINT, CLIENT_ID } from '../../shared/config'
 import type { CodeGenExecutorSchema } from './schema'
@@ -15,6 +16,7 @@ export async function codeGenExecutor(
     context: ExecutorContext,
     tree?: Tree,
 ) {
+    console.log('codeGenExecutor', options)
     if (!context.projectName) {
         throw new Error('No projectName: name not found in in project.json')
     }

libs/nx-plugin/src/executors/code-gen/schema.json

@@ -6,11 +6,11 @@
     "type": "object",
     "properties": {
         "template": {
-            "description": "The type of the component",
+            "description": "The type of the generated code.",
             "alias": "t",
             "type": "string",
             "x-prompt": {
-                "message": "The type of the component",
+                "message": "Select the template type",
                 "type": "list",
                 "items": [
                     {
@@ -33,15 +33,15 @@
 
         "subFolder": {
             "type": "string",
-            "description": "Sub-folder to add the generated code to.",
+            "description": "The target sub-folder of the project.",
             "default": "./"
         },
 
         "dryRun": {
             "type": "boolean",
-            "description": "Only show what would be generated.",
+            "description": "Only show what would be generated, don't modify files.",
             "default": false
         }
     },
-    "required": ["template", "projectName", "featureBoardProductName"]
+    "required": ["template", "featureBoardProductName"]
 }

libs/nx-plugin/src/generators/add-code-gen-target/__snapshots__/generator.spec.ts.snap

@@ -12,7 +12,7 @@ exports[`AddCodeGenTarget generator > should update the project.json > apps/my-a
     \\"saasy-icons\\": {
       \\"executor\\": \\"@featureboard/nx-plugin:code-gen\\",
       \\"outputs\\": [
-        \\"{projectRoot}/./src/features\\"
+        \\"{projectRoot}/src/features\\"
       ],
       \\"options\\": {
         \\"template\\": \\"dotnet-api\\",

libs/nx-plugin/src/generators/add-code-gen-target/generator.spec.ts

@@ -21,7 +21,6 @@ describe('AddCodeGenTarget generator', () => {
             dryRun: false,
         }
 
-        const root = 'apps/my-app'
         addProjectConfiguration(tree, options.projectName, {
             root: `apps/${options.projectName}`,
             projectType: 'application',
@@ -38,8 +37,6 @@ describe('AddCodeGenTarget generator', () => {
     it('should update the project.json', async () => {
         await addCodeGenTargetGenerator(tree, options)
 
-        const project = readProjectConfiguration(tree, options.projectName)
-
         const projectJson = tree
             .listChanges()
             .find((x) => x.path.endsWith('project.json'))

libs/nx-plugin/src/generators/add-code-gen-target/generator.ts

@@ -36,7 +36,7 @@ export function getCodeGenExecutorConfiguration(
     }
     return {
         executor: '@featureboard/nx-plugin:code-gen',
-        outputs: [`{projectRoot}/${options.subFolder}`],
+        outputs: [`{projectRoot}/${options.subFolder}`.replace('/./', '/')],
         options: codeGenOptions,
         dependsOn: ['build'],
     }

libs/nx-plugin/src/generators/add-code-gen-target/schema.json

@@ -6,7 +6,7 @@
     "properties": {
         "projectName": {
             "type": "string",
-            "description": "The name of the project to add the component to.",
+            "description": "The name of the project to add the target to.",
             "alias": "p",
             "$default": {
                 "$source": "projectName"
@@ -18,15 +18,16 @@
             "type": "string",
             "description": "The name of the target.",
             "alias": "t",
-            "x-prompt": "What is the name of the target you want to add?"
+            "x-prompt": "What is the name of the target you want to add?",
+            "default": "code-gen"
         },
 
         "template": {
-            "description": "The type of the component",
+            "description": "The type of code the target should generate",
             "alias": "t",
             "type": "string",
             "x-prompt": {
-                "message": "The type of the component",
+                "message": "The type of the generated code",
                 "type": "list",
                 "items": [
                     {
@@ -48,7 +49,7 @@
 
         "subFolder": {
             "type": "string",
-            "description": "Sub-folder to add the generated code to.",
+            "description": "The target sub-folder of the project .",
             "default": "./"
         }
     },

libs/nx-plugin/src/generators/code-gen/schema.json

@@ -5,11 +5,11 @@
     "type": "object",
     "properties": {
         "template": {
-            "description": "The type of the component",
+            "description": "The type of the generated code.",
             "alias": "t",
             "type": "string",
             "x-prompt": {
-                "message": "The type of the component",
+                "message": "Select the template type",
                 "type": "list",
                 "items": [
                     {
@@ -26,17 +26,18 @@
 
         "projectName": {
             "type": "string",
-            "description": "The name of the project to add the component to.",
+            "description": "The name of the project to add the generated code to.",
             "alias": "p",
             "$default": {
                 "$source": "projectName"
             },
-            "x-prompt": "What is the name of the project you want to add the component to?"
+            "x-prompt": "What is the name of the project you want to add the generated code to?"
         },
 
         "featureBoardProductName": {
             "type": "string",
-            "description": "The name of the FeatureBoard product you want to pull the types from."
+            "description": "The FeatureBoard product to pull the types from.",
+            "alias": "f"
         },
 
         "featureBoardApiKey": {
@@ -46,7 +47,7 @@
 
         "subFolder": {
             "type": "string",
-            "description": "Sub-folder to add the generated code to.",
+            "description": "The target sub-folder of the project.",
             "default": "./"
         }
     },