feat: add "preset" generator (#10)

* feat(preset): feat: add "preset" generator: initial files

re #7

* fix(qwik-nx): fix build on new version (#11)

* feat: application & library generator updates (#5)

* chore(qwik-nx): release version 0.2.0

* fix: fix npm publish dist

dist folder in npm publish was pointing to the wrong folder

* chore(qwik-nx): release version 0.2.1

* fix: moved vite to dependencies (#12)

* Update README.md

* chore(qwik-nx): release version 0.2.2

* refactor(generator.ts): point generator to application

update projectDirectory, projectRoot, and projectType as an application"

fix #7

* feat(preset/files): added preset files"

added qwik application files to be use to create nx workspace

* feat(update generator.ts): update generator and schema

* docs(readme): added preset workspace

create nx with qwik-nx preset

* feat(preset): refactor generator

reuse application generator codes and interfaces

* refactor(generator): reuse applciation generator

reuse addFiles from application generator

* refactor(generator): reuse application generator

reuse existing generator and remove unnecessary codes

* fix: update schema props for preset

* fix: cleanup

* fix: cleanup

* fix: revert verdaccio guidelines

* style: added ▶

* fix: fix nexted folder for workspace preset

Co-authored-by: Shai Reznik <[email protected]>
Co-authored-by: Dmitriy Stepanenko <[email protected]>
Co-authored-by: @qwikifiers <[email protected]>

Author: 4 people

.npmrc

@@ -1 +1 @@
-save-exact = true
+save-exact = true

CONTRIBUTING.md

@@ -138,6 +138,16 @@ After your pull request is merged, you can safely delete your branch and pull th
 
 <br/>
 
-### ▶ 9. That's it! Thank you for your contribution! 🙏💓
+## ▶ 9. Publishing to a local registry
+
+To test if your changes will actually work once the changes are published,
+it can be useful to publish to a local registry.
+
+- Run `npm i -g verdaccio` in Terminal 1 (keep it running)
+- Run `verdaccio
+- Run `npm adduser --registry http://localhost:4873` in Terminal 2 (real credentials are not required, you just need to be logged in. You can use your own login details.
+- Run `npm publish [package] --registry=http://localhost:4783`
+
+### ▶ 10. That's it! Thank you for your contribution! 🙏💓
 
 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

README.md

@@ -31,6 +31,12 @@ npm install -D qwik-nx
 
 ## Usage
 
+### Generating a workspace
+
+```
+npx create-nx-workspace org-workspace --preset=qwik-nx
+```
+
 ### Generating an application
 
 ```

packages/qwik-nx/generators.json

@@ -29,6 +29,11 @@
       "schema": "./src/generators/library/schema.json",
       "description": "library generator",
       "aliases": ["lib"]
+    },
+    "preset": {
+      "factory": "./src/generators/preset/generator",
+      "schema": "./src/generators/preset/schema.json",
+      "description": "preset generator"
     }
   }
 }

packages/qwik-nx/src/generators/preset/generator.spec.ts

@@ -0,0 +1,27 @@
+import { createTreeWithEmptyWorkspace } from '@nrwl/devkit/testing';
+import { Tree, readProjectConfiguration } from '@nrwl/devkit';
+
+import generator from './generator';
+import { QwikWorkspacePresetGeneratorSchema } from './schema';
+
+describe('preset generator', () => {
+  let appTree: Tree;
+  const options: QwikWorkspacePresetGeneratorSchema = {
+    name: 'test',
+    style: 'css',
+    linter: 'none',
+    skipFormat: false,
+    unitTestRunner: 'none',
+    strict: false,
+  };
+
+  beforeEach(() => {
+    appTree = createTreeWithEmptyWorkspace();
+  });
+
+  it('should run successfully', async () => {
+    await generator(appTree, options);
+    const config = readProjectConfiguration(appTree, 'test');
+    expect(config).toBeDefined();
+  });
+});

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

@@ -0,0 +1,13 @@
+import { Tree } from '@nrwl/devkit';
+import { QwikWorkspacePresetGeneratorSchema } from './schema';
+import applicationGenerator from '../application/generator';
+
+export default async function (
+  tree: Tree,
+  options: QwikWorkspacePresetGeneratorSchema
+) {
+  options.directory = '';
+  options.name = options.qwikAppName ?? options.name;
+  options.style = options.qwikAppStyle ?? options.style;
+  return applicationGenerator(tree, options);
+}

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

@@ -0,0 +1,13 @@
+export interface QwikWorkspacePresetGeneratorSchema {
+  name: string;
+  qwikAppName: string;
+  tags?: string;
+  directory?: string;
+
+  style: 'css' | 'scss' | 'styl' | 'less' | 'none';
+  qwikAppStyle: 'css' | 'scss' | 'styl' | 'less' | 'none';
+  linter: 'eslint' | 'none';
+  skipFormat: boolean;
+  unitTestRunner: 'vitest' | 'none';
+  strict: boolean;
+}

packages/qwik-nx/src/generators/preset/schema.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "QwikNxPreset",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "qwikAppName": {
+      "type": "string",
+      "description": "",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use?"
+    },
+    "tags": {
+      "type": "string",
+      "description": "Add tags to the project (used for linting)",
+      "alias": "t"
+    },
+    "qwikAppStyle": {
+      "description": "The file extension to be used for style files.",
+      "type": "string",
+      "default": "css",
+      "alias": "s",
+      "x-prompt": {
+        "message": "Which stylesheet format would you like to use?",
+        "type": "list",
+        "items": [
+          {
+            "value": "css",
+            "label": "CSS"
+          },
+          {
+            "value": "scss",
+            "label": "SASS(.scss)       [ http://sass-lang.com                     ]"
+          },
+          {
+            "value": "styl",
+            "label": "Stylus(.styl)     [ http://stylus-lang.com                   ]"
+          },
+          {
+            "value": "less",
+            "label": "LESS              [ http://lesscss.org                       ]"
+          }
+        ],
+        "default": "css"
+      }
+    },
+    "linter": {
+      "description": "The tool to use for running lint checks.",
+      "type": "string",
+      "enum": ["eslint", "none"],
+      "default": "eslint"
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["vitest", "none"],
+      "description": "Test runner to use for unit tests.",
+      "default": "vitest"
+    },
+    "strict": {
+      "type": "boolean",
+      "description": "Creates an application with strict mode and strict type checking.",
+      "default": true
+    }
+  },
+  "required": ["name"]
+}