feat: add pathPrefix option for subfolder deployment

Author: daKmoR

Diff for: .changeset/wet-waves-wait.md

@@ -0,0 +1,5 @@
+---
+'@rocket/cli': patch
+---
+
+Add a pathPrefix option to allow deployment to a subdirectory

Diff for: docs/docs/configuration/overview.md

@@ -9,11 +9,8 @@ import { rocketLaunch } from '@rocket/launch';
 
 export default {
   presets: [rocketLaunch()],
-  build: {
-    emptyOutputDir: true,
-    pathPrefix: 'subfolder-only-for-build',
-    serviceWorkerFileName: 'service-worker.js',
-  },
+  emptyOutputDir: true,
+  pathPrefix: 'subfolder-only-for-build',
 };
 ```
 

Diff for: docs/guides/configuration/getting-started.md

@@ -12,7 +12,6 @@ import { absoluteBaseUrlNetlify } from '@rocket/core/helpers';
 
 export default /** @type {Partial<import('@rocket/cli').RocketCliOptions>} */ ({
   presets: [rocketLaunch(), rocketBlog(), rocketSearch()],
-  emptyOutputDir: false,
   absoluteBaseUrl: absoluteBaseUrlNetlify('http://localhost:8080'),
 });
 ```

Diff for: packages/cli/src/RocketStart.js

@@ -9,6 +9,14 @@ import { metaConfigToWebDevServerConfig } from 'plugins-manager';
 export class RocketStart {
   commands = ['start'];
 
+  /**
+   * @param {RocketCliOptions} config
+   */
+  setupCommand(config) {
+    delete config.pathPrefix;
+    return config;
+  }
+
   /**
    * @param {object} options
    * @param {RocketCliOptions} options.config

Diff for: packages/cli/test-node/RocketCli.e2e.test.js

@@ -203,35 +203,43 @@ describe('RocketCli e2e', () => {
     );
   });
 
-  it.skip('can add a pathprefix for the build output', async () => {
+  it('can add a pathprefix that will not influence the start command', async () => {
     cli = new RocketCli({
       argv: [
-        'build',
+        'start',
         '--config-file',
-        path.join(__dirname, 'e2e-fixtures', 'content', 'eleventy.rocket.config.js'),
+        path.join(__dirname, 'e2e-fixtures', 'content', 'pathprefix.rocket.config.js'),
       ],
     });
     await execute();
 
-    // const indexHtml = await readOutput('index.html', {
-    //   type: 'start',
-    // });
-    // expect(indexHtml).to.equal("<p>Markdown in 'docs/page/index.md'</p>");
+    const indexHtml = await readOutput('link/index.html', {
+      type: 'start',
+    });
+    expect(indexHtml).to.equal(
+      ['<p><a href="../../">home</a></p>', '<p><a href="/">absolute home</a></p>'].join('\n'),
+    );
   });
 
-  it.skip('works with an empty object in rocket.config.js', async () => {
+  it('can add a pathPrefix that will be used in the build command', async () => {
     cli = new RocketCli({
       argv: [
         'build',
         '--config-file',
-        path.join(__dirname, 'e2e-fixtures', 'content', 'empty.rocket.config.js'),
+        path.join(__dirname, 'e2e-fixtures', 'content', 'pathPrefix.rocket.config.js'),
       ],
     });
     await execute();
 
-    // const indexHtml = await readOutput('index.html', {
-    //   type: 'start',
-    // });
-    // expect(indexHtml).to.equal("<p>Markdown in 'docs/page/index.md'</p>");
+    const indexHtml = await readOutput('link/index.html', {
+      stripServiceWorker: true,
+      stripToBody: true,
+    });
+    expect(indexHtml).to.equal(
+      [
+        '<p><a href="../../">home</a></p>',
+        '<p><a href="/my-sub-folder/">absolute home</a></p>',
+      ].join('\n'),
+    );
   });
 });

Diff for: packages/cli/test-node/e2e-fixtures/content/docs/link.md

@@ -1 +1,7 @@
+---
+layout: layout.njk
+---
+
 [home](../index.md)
+
+<a href="{{ '/' | url }}">absolute home</a>

Diff for: packages/cli/test-node/e2e-fixtures/content/pathprefix.rocket.config.js renamed to packages/cli/test-node/e2e-fixtures/content/pathPrefix.rocket.config.js

@@ -1,6 +1,6 @@
 /** @type {Partial<import("../../../types/main").RocketCliOptions>} */
 const config = {
-  pathPrefix: 'my-sub-folder',
+  pathPrefix: '/my-sub-folder/',
 };
 
 export default config;

Diff for: packages/eleventy-plugin-mdjs-unified/package.json

@@ -31,7 +31,7 @@
     "mdjs"
   ],
   "dependencies": {
-    "@mdjs/core": "^0.6.0",
+    "@mdjs/core": "^0.6.1",
     "es-module-lexer": "^0.3.26",
     "unist-util-visit": "^2.0.3"
   },