fix(qwik-nx): got route generator to work (#45)

Author: shairez

.github/actions/test/action.yml

@@ -18,9 +18,9 @@ runs:
       shell: bash
       run: pnpx nx affected:build --base=last-release --exclude="add-nx-to-qwik"
 
-    # - name: Test
-    #   shell: bash
-    #   run: npx nx affected --target=test --base=last-release
+    - name: Test
+      shell: bash
+      run: npx nx affected --target=test --base=last-release
 
     # - name: E2E Tests
     #   shell: bash

README.md

@@ -55,6 +55,12 @@ nx generate qwik-nx:lib
 nx generate qwik-nx:component
 ```
 
+### Generating a route
+
+```
+nx generate qwik-nx:route
+```
+
 ### Setting up Tailwind CSS
 
 ```

packages/qwik-nx/README.md

@@ -12,7 +12,12 @@
         "main": "packages/qwik-nx/src/index.ts",
         "tsConfig": "packages/qwik-nx/tsconfig.lib.json",
         "assets": [
-          "packages/qwik-nx/*.md",
+          "README.md",
+          {
+            "input": "./assets",
+            "glob": "qwik-nx.png",
+            "output": "./assets"
+          },
           {
             "input": "./packages/qwik-nx/src",
             "glob": "**/!(*.ts)",

packages/qwik-nx/project.json

@@ -34,7 +34,10 @@ function addFiles(tree: Tree, options: NormalizedSchema) {
   );
 }
 
-export default async function (tree: Tree, options: QwikAppGeneratorSchema) {
+export async function appGenerator(
+  tree: Tree,
+  options: QwikAppGeneratorSchema
+) {
   const normalizedOptions = normalizeOptions(tree, options);
   const tasks: GeneratorCallback[] = [];
 
@@ -90,3 +93,5 @@ export default async function (tree: Tree, options: QwikAppGeneratorSchema) {
 
   return runTasksInSerial(...tasks);
 }
+
+export default appGenerator;

packages/qwik-nx/src/generators/application/generator.ts

@@ -4,14 +4,13 @@ export interface QwikAppGeneratorSchema {
   name: string;
   tags?: string;
   directory?: string;
-
-  style: 'css' | 'scss' | 'styl' | 'less' | 'none';
-  linter: Linter;
-  skipFormat: boolean;
+  style?: 'css' | 'scss' | 'styl' | 'less' | 'none';
+  linter?: Linter;
+  skipFormat?: boolean;
   tailwind?: boolean;
-  unitTestRunner: 'vitest' | 'none';
-  strict: boolean;
-  e2eTestRunner: 'playwright' | 'cypress' | 'none';
+  unitTestRunner?: 'vitest' | 'none';
+  strict?: boolean;
+  e2eTestRunner?: 'playwright' | 'cypress' | 'none';
   // router: 'qwik-city' | 'none'; // TODO: add setup w/o qwik-city
 }
 

packages/qwik-nx/src/generators/application/schema.d.ts

@@ -0,0 +1,13 @@
+import { component$ } from '@builder.io/qwik';
+
+export default component$(() => {
+  return (
+    <>
+      
+      <Slot />
+      
+    </>
+  );
+});
+
+

packages/qwik-nx/src/generators/route/files/layout/__routeName__/layout.tsx__template__

@@ -0,0 +1,11 @@
+import { component$ } from '@builder.io/qwik';
+
+export default component$(() => {
+  return (
+    <div>
+      This is the <%= routeName %>
+    </div>
+  );
+});
+
+

packages/qwik-nx/src/generators/route/files/route/__routeName__/index.tsx__template__

@@ -1,20 +1,40 @@
 import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
-import { Tree, readProjectConfiguration } from '@nrwl/devkit';
+import { Tree } from '@nrwl/devkit';
 
-import generator from './generator';
+import { routeGenerator } from './generator';
 import { RouteGeneratorSchema } from './schema';
+import appGenerator from '../application/generator';
 
 describe('route generator', () => {
-  let appTree: Tree;
-  const options: RouteGeneratorSchema = { name: 'test' };
+  function setup() {
+    const appTree = createTreeWithEmptyWorkspace();
+    appGenerator(appTree, { name: 'testApp' });
 
-  beforeEach(() => {
-    appTree = createTreeWithEmptyWorkspace();
+    const routeOptions: RouteGeneratorSchema = {
+      name: 'fake-route',
+      project: 'test-app',
+    };
+
+    return {
+      appTree,
+      routeOptions,
+    };
+  }
+
+  it('should generate the route index.tsx in the right location', async () => {
+    const { appTree, routeOptions } = setup();
+    await routeGenerator(appTree, routeOptions);
+    expect(
+      appTree.exists('test-app/src/routes/fake-route/index.tsx')
+    ).toBeTruthy();
   });
 
-  it('should run successfully', async () => {
-    await generator(appTree, options);
-    const config = readProjectConfiguration(appTree, 'test');
-    expect(config).toBeDefined();
+  it('should generate layout.tsx if selected', async () => {
+    const { appTree, routeOptions } = setup();
+    routeOptions.addLayout = true;
+    await routeGenerator(appTree, routeOptions);
+    expect(
+      appTree.exists('test-app/src/routes/fake-route/layout.tsx')
+    ).toBeTruthy();
   });
 });