feat: change output directory from "server" to "analog" (#300)

Closes #295 

BREAKING CHANGES:

The output for the built client/server application has changed

BEFORE:

The output for the built server application is `dist/server/public` for client and `dist/server/server` for server

AFTER:

The output for the built server application is `dist/analog/public` for client and `dist/analog/server` for server

apps/analog-app-e2e-cypress/cypress.config.ts

@@ -14,7 +14,9 @@ const cypressJsonConfig = {
 };
 export default defineConfig({
   e2e: {
-    ...nxE2EPreset(__dirname),
+    ...nxE2EPreset(__dirname, {
+      bundler: 'vite',
+    }),
     ...cypressJsonConfig,
   },
 });

apps/analog-app/project.json

@@ -10,7 +10,7 @@
         "{options.outputPath}",
         "dist/apps/analog-app/.nitro",
         "dist/apps/analog-app/ssr",
-        "dist/apps/analog-app/server"
+        "dist/apps/analog-app/analog"
       ],
       "options": {
         "configFile": "apps/analog-app/vite.config.ts",

apps/analog-app/vite.config.ts

@@ -30,8 +30,8 @@ export default defineConfig(({ mode }) => {
         nitro: {
           rootDir: 'apps/analog-app',
           output: {
-            dir: '../../../dist/apps/analog-app/server',
-            publicDir: '../../../dist/apps/analog-app/server/public',
+            dir: '../../../dist/apps/analog-app/analog',
+            publicDir: '../../../dist/apps/analog-app/analog/public',
           },
           publicAssets: [{ dir: `../../../dist/apps/analog-app/client` }],
           serverAssets: [

apps/blog-app-e2e-cypress/.eslintrc.json

@@ -0,0 +1,10 @@
+{
+  "extends": ["plugin:cypress/recommended", "../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/blog-app-e2e-cypress/cypress.config.ts

@@ -0,0 +1,21 @@
+import { defineConfig } from 'cypress';
+import { nxE2EPreset } from '@nrwl/cypress/plugins/cypress-preset';
+
+const cypressJsonConfig = {
+  fileServerFolder: '.',
+  fixturesFolder: './src/fixtures',
+  video: true,
+  videosFolder: '../../dist/cypress/apps/blog-app-e2e-cypress/videos',
+  screenshotsFolder: '../../dist/cypress/apps/blog-app-e2e-cypress/screenshots',
+  chromeWebSecurity: false,
+  specPattern: 'src/e2e/**/*.cy.{js,jsx,ts,tsx}',
+  supportFile: 'src/support/e2e.ts',
+};
+export default defineConfig({
+  e2e: {
+    ...nxE2EPreset(__dirname, {
+      bundler: 'vite',
+    }),
+    ...cypressJsonConfig,
+  },
+});

apps/blog-app-e2e-cypress/project.json

@@ -0,0 +1,30 @@
+{
+  "name": "blog-app-e2e-cypress",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/blog-app-e2e-cypress/src",
+  "projectType": "application",
+  "targets": {
+    "e2e": {
+      "executor": "@nrwl/cypress:cypress",
+      "options": {
+        "cypressConfig": "apps/blog-app-e2e-cypress/cypress.config.ts",
+        "devServerTarget": "blog-app:serve-nitro",
+        "testingType": "e2e"
+      },
+      "configurations": {
+        "watch": {
+          "watch": "true"
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["apps/blog-app-e2e-cypress/**/*.{js,ts}"]
+      }
+    }
+  },
+  "tags": [],
+  "implicitDependencies": ["blog-app"]
+}

apps/blog-app-e2e-cypress/src/e2e/app.cy.ts

@@ -0,0 +1,7 @@
+describe('blog-app', () => {
+  beforeEach(() => cy.visit('/'));
+
+  it('should redirect us to /blog', () => {
+    cy.url().should('be.equal', `${Cypress.config('baseUrl')}/blog`);
+  });
+});

apps/blog-app-e2e-cypress/src/fixtures/.gitkeep

@@ -0,0 +1 @@
+

apps/blog-app-e2e-cypress/src/support/app.po.ts

@@ -0,0 +1 @@
+// leaving this empty for now

apps/blog-app-e2e-cypress/src/support/commands.ts

@@ -0,0 +1,33 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+
+// eslint-disable-next-line @typescript-eslint/no-namespace
+declare namespace Cypress {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  // interface Chainable<Subject> {
+  //   login(email: string, password: string): void;
+  // }
+}
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => {
+//   console.log('Custom command example: Login', email, password);
+// });
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

apps/blog-app-e2e-cypress/src/support/e2e.ts

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands';

apps/blog-app-e2e-cypress/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "sourceMap": false,
+    "outDir": "../../dist/out-tsc",
+    "allowJs": true,
+    "types": ["cypress", "node"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.js", "cypress.config.ts"]
+}

apps/blog-app/project.json

@@ -11,7 +11,7 @@
         "{options.outputPath}",
         "dist/apps/blog-app/.nitro",
         "dist/apps/blog-app/ssr",
-        "dist/apps/blog-app/server"
+        "dist/apps/blog-app/analog"
       ],
       "options": {
         "configFile": "apps/blog-app/vite.config.ts",
@@ -44,6 +44,15 @@
           "buildTarget": "blog-app:build:production"
         }
       }
+    },
+    "serve-nitro": {
+      "executor": "@nrwl/web:file-server",
+      "options": {
+        "buildTarget": "blog-app:build",
+        "parallel": true,
+        "port": 3000,
+        "staticFilePath": "dist/apps/blog-app/analog/public"
+      }
     }
   },
   "tags": []

apps/blog-app/vite.config.ts

@@ -20,6 +20,7 @@ export default defineConfig(() => {
           routes: async () => {
             return [
               '/',
+              '/blog',
               '/about',
               '/blog/2022-12-27-my-first-post',
               '/blog/2022-12-31-my-second-post',
@@ -32,8 +33,8 @@ export default defineConfig(() => {
         nitro: {
           rootDir: 'apps/blog-app',
           output: {
-            dir: '../../../dist/apps/blog-app/server',
-            publicDir: '../../../dist/apps/blog-app/server/public',
+            dir: '../../../dist/apps/blog-app/analog',
+            publicDir: '../../../dist/apps/blog-app/analog/public',
           },
           publicAssets: [{ dir: `../../../dist/apps/blog-app/client` }],
           serverAssets: [

apps/docs-app/docs/features/deployment/overview.md

@@ -35,6 +35,6 @@ pnpm run build
 
 ## Build Artifacts
 
-The client build artifacts are located in the `dist/client` directory. The server for the API routes are located in the `dist/server` directory.
+The client build artifacts are located in the `dist/client` directory. The server for the API routes is located in the `dist/server` directory.
 
-If you have [server side rendering](/docs/features/server/server-side-rendering) enabled, the client build artifacts are located in the `dist/server/public` directory. The server for the API/SSR build artifacts are located in the `dist/server/server` directory.
+If you have [server side rendering](/docs/features/server/server-side-rendering) enabled, the client build artifacts are located in the `dist/analog/public` directory. The server for the API/SSR build artifacts is located in the `dist/analog/server` directory.

package.json

@@ -78,6 +78,7 @@
     "@nrwl/jest": "15.7.0",
     "@nrwl/linter": "15.7.0",
     "@nrwl/vite": "15.7.0",
+    "@nrwl/web": "15.7.0",
     "@nrwl/workspace": "15.7.0",
     "@nx-plus/docusaurus": "15.0.0-rc.0",
     "@schematics/angular": "~15.1.3",

packages/platform/src/lib/vite-nitro-plugin.ts

@@ -20,8 +20,8 @@ export function viteNitroPlugin(
     srcDir: normalizePath(`${rootDir}/src`),
     scanDirs: [normalizePath(`${rootDir}/src/server`)],
     output: {
-      dir: '../dist/server',
-      publicDir: '../dist/server/public',
+      dir: '../dist/analog',
+      publicDir: '../dist/analog/public',
       ...nitroOptions?.output,
     },
     buildDir: './dist/.nitro',