@nrwl/remix 1.0.0-alpha.3 → 1.0.0-alpha.7

package/README.md

@@ -1,9 +1,15 @@
 <p style="text-align: center;"><img src="https://github.com/nrwl/nx-labs/raw/main/packages/nx-remix/nx-remix.png" width="600" alt="Nx - Smart, Fast and Extensible Build System"></p>
 
-## Creating new workspace
+## Creating new Remix workspace
+
+Use `--project=@nrwl/remix` when creating new workspace.
+
+e.g.
 
 ```bash
-npx create-nx-workspace@latest acme --preset=@nrwl/remix --project=demo
+npx create-nx-workspace@latest acme \
+--preset=@nrwl/remix \
+--project=demo
 ```
 
 Now, you can go into the `acme` folder and start development.
@@ -17,7 +23,9 @@ npx nx dev demo
 
 You can also run `nx build demo` and `nx start demo`.
 
-## Adding new libraries
+## Workspace libraries
+
+The Remix setup leverages npm/yarn/pnpm workspaces and Nx buildable libraries.
 
 ```bash
 npx nx g @nrwl/remix:lib mylib
@@ -35,7 +43,7 @@ export default function App() {
   return (
     <Document>
       <Layout>
-        <Mylib/>
+        <Mylib />
         <Outlet />
       </Layout>
     </Document>
@@ -43,22 +51,14 @@ export default function App() {
 }
 ```
 
-Now, build and run install.
-
-```bash
-npx nx build mylib
-yarn
-
-# or with npm workspaces
-npm install -ws
-```
-
-Finally, serve the app again.
+Now, run the dev server again to see the new library in action!
 
 ```bash
 npx nx dev demo
 ```
 
+**Note:** You must restart the server if you make any changes to your library. Luckily, with Nx cache this operation should be super fast.
+
 ## Contributing
 
 ### Running unit tests

package/package.json

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

package/src/generators/application/files/app/root.tsx__tmpl__

@@ -10,8 +10,8 @@ import {
 } from "remix";
 import type { LinksFunction } from "remix";
 
-import globalStylesUrl from "./styles/global.css";
-import darkStylesUrl from "./styles/dark.css";
+import globalStylesUrl from "~/styles/global.css";
+import darkStylesUrl from "~/styles/dark.css";
 
 // https://remix.run/api/app#links
 export let links: LinksFunction = () => {

package/src/generators/application/files/app/routes/demos/about.tsx__tmpl__

@@ -1,7 +1,7 @@
 import { Outlet } from "remix";
 import type { MetaFunction, LinksFunction } from "remix";
 
-import stylesUrl from "../../styles/demos/about.css";
+import stylesUrl from "~/styles/demos/about.css";
 
 export let meta: MetaFunction = () => {
   return {

package/src/generators/application/files/tsconfig.json__tmpl__

@@ -1,5 +1,4 @@
 {
-  "extends": "../../tsconfig.base.json",
   "include": ["remix.env.d.ts", "**/*.ts", "**/*.tsx"],
   "compilerOptions": {
     "lib": ["DOM", "DOM.Iterable", "ES2019"],
@@ -9,7 +8,9 @@
     "resolveJsonModule": true,
     "target": "ES2019",
     "strict": true,
-
+    "paths": {
+      "~/*": ["./app/*"]
+    },
     // Remix takes care of building everything in `remix build`.
     "noEmit": true
   }

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

@@ -1,3 +1,3 @@
-import { Tree } from '@nrwl/devkit';
+import { GeneratorCallback, Tree } from '@nrwl/devkit';
 import { NxRemixGeneratorSchema } from './schema';
-export default function (tree: Tree, options: NxRemixGeneratorSchema): Promise<import("@nrwl/devkit").GeneratorCallback>;
+export default function (tree: Tree, options: NxRemixGeneratorSchema): Promise<GeneratorCallback>;

package/src/generators/library/library.impl.js

@@ -4,10 +4,14 @@ const tslib_1 = require("tslib");
 const devkit_1 = require("@nrwl/devkit");
 const library_1 = require("@nrwl/react/src/generators/library/library");
 const linter_1 = require("@nrwl/linter");
+const child_process_1 = require("child_process");
+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 tasks = [];
         const name = (0, devkit_1.names)(options.name).fileName;
-        const task = yield (0, library_1.libraryGenerator)(tree, {
+        const pm = (0, devkit_1.detectPackageManager)();
+        const libGenTask = yield (0, library_1.libraryGenerator)(tree, {
             name,
             // Remix can only work with buildable libs and yarn/npm workspaces
             buildable: true,
@@ -21,7 +25,28 @@ function default_1(tree, options) {
             linter: linter_1.Linter.EsLint,
             component: true,
         });
-        return task;
+        tasks.push(libGenTask);
+        // Nest dist under project root to we can link it
+        const project = (0, devkit_1.readProjectConfiguration)(tree, name);
+        project.targets.build.options = Object.assign(Object.assign({}, project.targets.build.options), { outputPath: `libs/${name}/dist` });
+        (0, devkit_1.updateProjectConfiguration)(tree, name, project);
+        // Link workspaces
+        tasks.push(() => {
+            let command;
+            if (pm === 'npm') {
+                command = `npm install -ws`;
+            }
+            else if (pm === 'yarn') {
+                command = `yarn`;
+            }
+            else if (pm === 'pnpm') {
+                command = `pnpm install`;
+            }
+            (0, child_process_1.execSync)(command, {
+                stdio: [0, 1, 2],
+            });
+        });
+        return (0, run_tasks_in_serial_1.runTasksInSerial)(...tasks);
     });
 }
 exports.default = default_1;

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

@@ -1 +1 @@
-{"version":3,"file":"library.impl.js","sourceRoot":"","sources":["../../../../../../packages/nx-remix/src/generators/library/library.impl.ts"],"names":[],"mappings":";;;AAAA,yCAA2C;AAC3C,wEAA8E;AAE9E,yCAAsC;AAEtC,mBAA+B,IAAU,EAAE,OAA+B;;QACxE,MAAM,IAAI,GAAG,IAAA,cAAK,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;QAE1C,MAAM,IAAI,GAAG,MAAM,IAAA,0BAAgB,EAAC,IAAI,EAAE;YACxC,IAAI;YAEJ,kEAAkE;YAClE,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,OAAO;YAEjB,KAAK,EAAE,KAAK;YACZ,cAAc,EAAE,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,KAAK;YACnB,MAAM,EAAE,eAAM,CAAC,MAAM;YACrB,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;CAAA;AArBD,4BAqBC"}
+{"version":3,"file":"library.impl.js","sourceRoot":"","sources":["../../../../../../packages/nx-remix/src/generators/library/library.impl.ts"],"names":[],"mappings":";;;AAAA,yCAOsB;AACtB,wEAA8E;AAE9E,yCAAsC;AACtC,iDAAyC;AACzC,2FAAqF;AAErF,mBAA+B,IAAU,EAAE,OAA+B;;QACxE,MAAM,KAAK,GAAwB,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,IAAA,cAAK,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;QAC1C,MAAM,EAAE,GAAG,IAAA,6BAAoB,GAAE,CAAC;QAElC,MAAM,UAAU,GAAG,MAAM,IAAA,0BAAgB,EAAC,IAAI,EAAE;YAC9C,IAAI;YAEJ,kEAAkE;YAClE,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,OAAO;YAEjB,KAAK,EAAE,KAAK;YACZ,cAAc,EAAE,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,KAAK;YACnB,MAAM,EAAE,eAAM,CAAC,MAAM;YACrB,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvB,iDAAiD;QACjD,MAAM,OAAO,GAAG,IAAA,iCAAwB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACrD,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,mCACxB,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,KAChC,UAAU,EAAE,QAAQ,IAAI,OAAO,GAChC,CAAC;QACF,IAAA,mCAA0B,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAEhD,kBAAkB;QAClB,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YACd,IAAI,OAAe,CAAC;YACpB,IAAI,EAAE,KAAK,KAAK,EAAE;gBAChB,OAAO,GAAG,iBAAiB,CAAC;aAC7B;iBAAM,IAAI,EAAE,KAAK,MAAM,EAAE;gBACxB,OAAO,GAAG,MAAM,CAAC;aAClB;iBAAM,IAAI,EAAE,KAAK,MAAM,EAAE;gBACxB,OAAO,GAAG,cAAc,CAAC;aAC1B;YACD,IAAA,wBAAQ,EAAC,OAAO,EAAE;gBAChB,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;aACjB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,IAAA,sCAAgB,EAAC,GAAG,KAAK,CAAC,CAAC;IACpC,CAAC;CAAA;AA/CD,4BA+CC"}

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

@@ -1,3 +1,3 @@
-import { Tree } from '@nrwl/devkit';
+import { GeneratorCallback, Tree } from '@nrwl/devkit';
 import { NxRemixGeneratorSchema } from './schema';
-export default function (tree: Tree, _options: NxRemixGeneratorSchema): Promise<import("@nrwl/devkit").GeneratorCallback>;
+export default function (tree: Tree, _options: NxRemixGeneratorSchema): Promise<GeneratorCallback>;

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

@@ -4,24 +4,47 @@ 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 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 task = yield (0, application_impl_1.default)(tree, {
+        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
-        (0, devkit_1.updateJson)(tree, 'package.json', (json) => {
-            var _a;
-            (_a = json.workspaces) !== null && _a !== void 0 ? _a : (json.workspaces = ['dist/libs/*']);
-            return json;
-        });
+        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
+  `);
+        const nxJson = (0, devkit_1.readJson)(tree, 'nx.json');
+        nxJson.targetDependencies.dev = [
+            { target: 'build', projects: 'dependencies' },
+        ];
         // No need for workspace.json in latest Nx
         tree.delete('workspace.json');
         yield (0, devkit_1.formatFiles)(tree);
-        return task;
+        return (0, run_tasks_in_serial_1.runTasksInSerial)(...tasks);
     });
 }
 exports.default = default_1;

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,yCAA6D;AAG7D,+DAA2D;AAC3D,sEAAmE;AAEnE,mBAA+B,IAAU,EAAE,QAAgC;;QACzE,MAAM,OAAO,GAAG,IAAA,oCAAgB,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEjD,MAAM,IAAI,GAAG,MAAM,IAAA,0BAAoB,EAAC,IAAI,EAAE;YAC5C,IAAI,EAAE,OAAO,CAAC,WAAW;YACzB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,qDAAqD;QACrD,IAAA,mBAAU,EAAC,IAAI,EAAE,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE;;YACxC,MAAA,IAAI,CAAC,UAAU,oCAAf,IAAI,CAAC,UAAU,GAAK,CAAC,aAAa,CAAC,EAAC;YACpC,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,IAAI,CAAC;IACd,CAAC;CAAA;AArBD,4BAqBC"}
+{"version":3,"file":"preset.impl.js","sourceRoot":"","sources":["../../../../../../packages/nx-remix/src/generators/preset/preset.impl.ts"],"names":[],"mappings":";;;AAAA,yCAOsB;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,MAAM,MAAM,GAAG,IAAA,iBAAQ,EAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACzC,MAAM,CAAC,kBAAkB,CAAC,GAAG,GAAG;YAC9B,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE;SAC9C,CAAC;QAEF,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;AAlDD,4BAkDC"}