@nrwl/remix 1.0.0-alpha.12 → 1.0.0-alpha.13

package/README.md

@@ -27,6 +27,31 @@ npx nx dev demo
 
 You can also run `nx build demo` and `nx start demo`.
 
+## Existing workspaces
+
+You can add Remix to any existing Nx workspace.
+
+First, install the plugin:
+
+```bash
+npm install --save-dev @nrwl/remix
+
+# Or with yarn
+yarn add -D @nrwl/remix
+```
+
+Then, run the setup generator:
+
+```bash
+npx nx g @nrwl/remix:setup
+```
+
+You can then add your first app and run it:
+
+```bash
+npx nx g @nrwl/remix:app demo
+```
+
 ## Workspace libraries
 
 The Remix setup leverages npm/yarn/pnpm workspaces and Nx buildable libraries.
@@ -55,7 +80,7 @@ export default function App() {
 }
 ```
 
-Now, run the dev server again to see the new library in action!
+Now, run the dev server again to see the new library in action.
 
 ```bash
 npx nx dev demo

package/generators.json

@@ -7,12 +7,17 @@
     "preset": {
       "factory": "./src/generators/preset/preset.impl",
       "schema": "./src/generators/preset/schema.json",
-      "description": "Generate a new remix workspace"
+      "description": "Generate a new Remix workspace"
+    },
+    "setup": {
+      "factory": "./src/generators/setup/setup.impl",
+      "schema": "./src/generators/setup/schema.json",
+      "description": "Setup a Remix workspace"
     },
     "application": {
       "factory": "./src/generators/application/application.impl",
       "schema": "./src/generators/application/schema.json",
-      "description": "Generate a new remix application",
+      "description": "Generate a new Remix application",
       "aliases": ["app"],
       "x-type": "application"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nrwl/remix",
-  "version": "1.0.0-alpha.12",
+  "version": "1.0.0-alpha.13",
   "main": "src/index.js",
   "generators": "./generators.json",
   "dependencies": {

package/src/generators/preset/preset.impl.js

@@ -4,45 +4,20 @@ const tslib_1 = require("tslib");
 const devkit_1 = require("@nrwl/devkit");
 const normalize_options_1 = require("./lib/normalize-options");
 const application_impl_1 = require("../application/application.impl");
+const setup_impl_1 = require("../setup/setup.impl");
 const run_tasks_in_serial_1 = require("@nrwl/workspace/src/utilities/run-tasks-in-serial");
 function default_1(tree, _options) {
     return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
         const options = (0, normalize_options_1.normalizeOptions)(tree, _options);
         const tasks = [];
-        const pm = (0, devkit_1.detectPackageManager)();
         const appGenTask = yield (0, application_impl_1.default)(tree, {
             name: options.projectName,
             tags: options.tags,
             skipFormat: true,
         });
         tasks.push(appGenTask);
-        // Enable yarn/npm/pnpm workspaces for buildable libs
-        if (pm !== 'pnpm') {
-            (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
-                var _a;
-                (_a = json.workspaces) !== null && _a !== void 0 ? _a : (json.workspaces = ['libs/*']);
-                return json;
-            });
-        }
-        else {
-            tree.write('pnpm-workspace.yaml', `packages:
-  - 'libs/*`);
-        }
-        // Ignore nested project files
-        const ignoreFile = tree.read('.gitignore').toString();
-        tree.write('.gitignore', `${ignoreFile
-            .replace('/dist', 'dist')
-            .replace('/node_modules', 'node_modules')}
-  # Remix files
-  apps/**/build
-  apps/**/.cache
-  `);
-        (0, devkit_1.updateJson)(tree, 'nx.json', (json) => {
-            json.targetDependencies.dev = [
-                { target: 'build', projects: 'dependencies' },
-            ];
-            return json;
-        });
+        const setupGenTask = yield (0, setup_impl_1.default)(tree, {});
+        tasks.push(setupGenTask);
         // No need for workspace.json in latest Nx
         tree.delete('workspace.json');
         yield (0, devkit_1.formatFiles)(tree);

package/src/generators/preset/preset.impl.js.map

@@ -1 +1 @@
-{"version":3,"file":"preset.impl.js","sourceRoot":"","sources":["../../../../../../packages/nx-remix/src/generators/preset/preset.impl.ts"],"names":[],"mappings":";;;AAAA,yCAMsB;AAGtB,+DAA2D;AAC3D,sEAAmE;AACnE,2FAAqF;AAErF,mBAA+B,IAAU,EAAE,QAAgC;;QACzE,MAAM,OAAO,GAAG,IAAA,oCAAgB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACjD,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,MAAM,EAAE,GAAG,IAAA,6BAAoB,GAAE,CAAC;QAElC,MAAM,UAAU,GAAG,MAAM,IAAA,0BAAoB,EAAC,IAAI,EAAE;YAClD,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvB,qDAAqD;QACrD,IAAI,EAAE,KAAK,MAAM,EAAE;YACjB,IAAA,mBAAU,EAAC,IAAI,EAAE,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE;;gBACxC,MAAA,IAAI,CAAC,UAAU,oCAAf,IAAI,CAAC,UAAU,GAAK,CAAC,QAAQ,CAAC,EAAC;gBAC/B,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,IAAI,CAAC,KAAK,CACR,qBAAqB,EACrB;YACM,CACP,CAAC;SACH;QAED,8BAA8B;QAC9B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;QACtD,IAAI,CAAC,KAAK,CACR,YAAY,EACZ,GAAG,UAAU;aACV,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC;aACxB,OAAO,CAAC,eAAe,EAAE,cAAc,CAAC;;;;GAI5C,CACA,CAAC;QAEF,IAAA,mBAAU,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;YACnC,IAAI,CAAC,kBAAkB,CAAC,GAAG,GAAG;gBAC5B,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE;aAC9C,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,0CAA0C;QAC1C,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAE9B,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,IAAA,sCAAgB,EAAC,GAAG,KAAK,CAAC,CAAC;IACpC,CAAC;CAAA;AApDD,4BAoDC"}
+{"version":3,"file":"preset.impl.js","sourceRoot":"","sources":["../../../../../../packages/nx-remix/src/generators/preset/preset.impl.ts"],"names":[],"mappings":";;;AAAA,yCAAoE;AAGpE,+DAA2D;AAC3D,sEAAmE;AACnE,oDAAiD;AACjD,2FAAqF;AAErF,mBAA+B,IAAU,EAAE,QAAgC;;QACzE,MAAM,OAAO,GAAG,IAAA,oCAAgB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACjD,MAAM,KAAK,GAAwB,EAAE,CAAC;QAEtC,MAAM,UAAU,GAAG,MAAM,IAAA,0BAAoB,EAAC,IAAI,EAAE;YAClD,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvB,MAAM,YAAY,GAAG,MAAM,IAAA,oBAAc,EAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpD,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEzB,0CAA0C;QAC1C,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAE9B,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,IAAA,sCAAgB,EAAC,GAAG,KAAK,CAAC,CAAC;IACpC,CAAC;CAAA;AApBD,4BAoBC"}

package/src/generators/setup/schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "NxRemixSetup",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "packageManager": {
+      "type": "string",
+      "description": "The package manager to setup for",
+      "enum": ["yarn", "npm", "pnpm"]
+    }
+  }
+}

package/src/generators/setup/setup.impl.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nrwl/devkit';
+export default function (tree: Tree, options: {
+    packageManager?: 'yarn' | 'npm' | 'pnpm';
+}): Promise<() => void>;

package/src/generators/setup/setup.impl.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nrwl/devkit");
+function default_1(tree, options) {
+    var _a;
+    return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        const pm = (_a = options.packageManager) !== null && _a !== void 0 ? _a : (0, devkit_1.detectPackageManager)();
+        // Enable yarn/npm/pnpm workspaces for buildable libs
+        if (pm !== 'pnpm') {
+            (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
+                var _a;
+                if (!json.workspaces) {
+                    (_a = json.workspaces) !== null && _a !== void 0 ? _a : (json.workspaces = ['libs/*']);
+                }
+                return json;
+            });
+        }
+        else {
+            if (!tree.exists('pnpm-workspace.yaml')) {
+                tree.write('pnpm-workspace.yaml', `packages:
+  - 'libs/*`);
+            }
+        }
+        // Ignore nested project files
+        let ignoreFile = tree.read('.gitignore').toString();
+        if (ignoreFile.indexOf('/dist') !== -1) {
+            ignoreFile = ignoreFile.replace('/dist', 'dist');
+        }
+        if (ignoreFile.indexOf('/node_modules') !== -1) {
+            ignoreFile = ignoreFile.replace('/node_modules', 'node_modules');
+        }
+        if (ignoreFile.indexOf('# Remix files') === -1) {
+            ignoreFile = `${ignoreFile
+                .replace('/dist', 'dist')
+                .replace('/node_modules', 'node_modules')}
+  # Remix files
+  apps/**/build
+  apps/**/.cache
+  `;
+        }
+        tree.write('.gitignore', ignoreFile);
+        (0, devkit_1.updateJson)(tree, 'nx.json', (json) => {
+            var _a;
+            if (Array.isArray((_a = json.targetDependencies) === null || _a === void 0 ? void 0 : _a.dev)) {
+                if (!json.targetDependencies.dev.some((x) => x.target === 'build' && x.projects === 'dependencies')) {
+                    json.targetDependencies.dev.push({
+                        target: 'build',
+                        projects: 'dependencies',
+                    });
+                }
+            }
+            else {
+                json.targetDependencies = Object.assign(Object.assign({}, json.targetDependencies), { dev: [{ target: 'build', projects: 'dependencies' }] });
+            }
+            return json;
+        });
+        yield (0, devkit_1.formatFiles)(tree);
+        return () => {
+            // Reserved for additional processing needed
+        };
+    });
+}
+exports.default = default_1;
+//# sourceMappingURL=setup.impl.js.map

package/src/generators/setup/setup.impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.impl.js","sourceRoot":"","sources":["../../../../../../packages/nx-remix/src/generators/setup/setup.impl.ts"],"names":[],"mappings":";;;AAAA,yCAKsB;AAEtB,mBACE,IAAU,EACV,OAEC;;;QAED,MAAM,EAAE,GAAG,MAAA,OAAO,CAAC,cAAc,mCAAI,IAAA,6BAAoB,GAAE,CAAC;QAE5D,qDAAqD;QACrD,IAAI,EAAE,KAAK,MAAM,EAAE;YACjB,IAAA,mBAAU,EAAC,IAAI,EAAE,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE;;gBACxC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;oBACpB,MAAA,IAAI,CAAC,UAAU,oCAAf,IAAI,CAAC,UAAU,GAAK,CAAC,QAAQ,CAAC,EAAC;iBAChC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,EAAE;gBACvC,IAAI,CAAC,KAAK,CACR,qBAAqB,EACrB;YACI,CACL,CAAC;aACH;SACF;QAED,8BAA8B;QAC9B,IAAI,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;QACpD,IAAI,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE;YACtC,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;SAClD;QACD,IAAI,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE;YAC9C,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;SAClE;QACD,IAAI,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,EAAE;YAC9C,UAAU,GAAG,GAAG,UAAU;iBACvB,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC;iBACxB,OAAO,CAAC,eAAe,EAAE,cAAc,CAAC;;;;GAI5C,CAAC;SACD;QACD,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAErC,IAAA,mBAAU,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE;;YACnC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,kBAAkB,0CAAE,GAAG,CAAC,EAAE;gBAC/C,IACE,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAC/B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,IAAI,CAAC,CAAC,QAAQ,KAAK,cAAc,CAC7D,EACD;oBACA,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC;wBAC/B,MAAM,EAAE,OAAO;wBACf,QAAQ,EAAE,cAAc;qBACzB,CAAC,CAAC;iBACJ;aACF;iBAAM;gBACL,IAAI,CAAC,kBAAkB,mCAClB,IAAI,CAAC,kBAAkB,KAC1B,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,GACrD,CAAC;aACH;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,OAAO,GAAG,EAAE;YACV,4CAA4C;QAC9C,CAAC,CAAC;;CACH;AAvED,4BAuEC"}