Version Packages

.eleventyignore

@@ -1,2 +1,4 @@
 node_modules/**
-/docs/_assets/head.html
+/docs/_assets
+/docs/_includes
+/docs/_data

docs/docs/configuration/overview.md

@@ -9,11 +9,8 @@ import { rocketLaunch } from '@rocket/launch';
 
 export default {
   presets: [rocketLaunch()],
-  build: {
+  emptyOutputDir: true,
-    emptyOutputDir: true,
+  pathPrefix: 'subfolder-only-for-build',
-    pathPrefix: 'subfolder-only-for-build',
-    serviceWorkerFileName: 'service-worker.js',
-  },
 };
 ```
 
@@ -23,11 +20,22 @@ New plugins can be added and all default plugins can be adjusted or even removed
 
 ```js
 export default {
+  // add remark/unified plugin to the markdown processing (e.g. enable special code blocks)
   setupUnifiedPlugins: [],
+
+  // add a rollup plugins to the web dev server (will be wrapped with @web/dev-server-rollup) AND the rollup build (e.g. enable json importing)
   setupDevAndBuildPlugins: [],
+
+  // add a plugin to the web dev server (will not be wrapped) (e.g. esbuild for typescript)
   setupDevPlugins: [],
+
+  // add a plugin to the rollup build (e.g. optimization steps)
   setupBuildPlugins: [],
+
+  // add a plugin to eleventy (e.g. a filter packs)
   setupEleventyPlugins: [],
+
+  // add a plugin to the cli (e.g. a new command like "rocket my-command")
   setupCliPlugins: [],
 };
 ```

docs/docs/tools/plugins-manager.md

@@ -216,7 +216,11 @@ const plugins = finalMetaPlugins.map(pluginObj => {
 
 **Examples**
 
-Rollup has a more specific helper
+Rollup has a more specific helper that handles
+
+- `config.setupPlugins`
+
+Note: if you provide `config.plugins` then it will return that directly ignoring `setupPlugins`
 
 ```js
 import { metaConfigToRollupConfig } from 'plugins-manager';
@@ -224,14 +228,19 @@ import { metaConfigToRollupConfig } from 'plugins-manager';
 const finalConfig = metaConfigToRollupConfig(currentConfig, defaultMetaPlugins);
 ```
 
-Web Dev Server has a more specific helper
+Web Dev Server has a more specific helper that handles
+
+- `config.setupPlugins`
+- `config.setupRollupPlugins`
+
+Note: if you provide `config.plugins` then it will return that directly ignoring `setupPlugins` and `setupRollupPlugins`
 
 ```js
 import { metaConfigToWebDevServerConfig } from 'plugins-manager';
 import { fromRollup } from '@web/dev-server-rollup';
 
 const finalConfig = metaConfigToWebDevServerConfig(currentConfig, defaultMetaPlugins, {
-  wrapperFunction: fromRollup,
+  rollupWrapperFunction: fromRollup,
 });
 ```
 

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'),
 });
 ```

docs/guides/first-pages/getting-started.md

@@ -51,6 +51,15 @@ Rocket uses the .gitignore file to manage it's requirements. If you skip this st
    };
    ```
 
+5. (optionally) Create a file `.eleventyignore` (this file will be needed once you start customizing presets)
+
+   ```
+   node_modules/**
+   /docs/_assets
+   /docs/_includes
+   /docs/_data
+   ```
+
 <inline-notification type="warning" title="note">
 
 All further pathes are relative to your project root (my-project in this case)

packages/blog/CHANGELOG.md

@@ -1,6 +1,14 @@
 # @rocket/blog
 
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies [a8c7173]
+  - plugins-manager@0.2.0
+
 ## 0.1.0
+
 ### Minor Changes
 
 - 1971f5d: Initial Release

packages/blog/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocket/blog",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "publishConfig": {
     "access": "public"
   },
@@ -38,6 +38,6 @@
     "testing"
   ],
   "dependencies": {
-    "plugins-manager": "^0.1.0"
+    "plugins-manager": "^0.2.0"
   }
 }

packages/cli/CHANGELOG.md

@@ -1,6 +1,23 @@
 # @rocket/cli
 
+## 0.1.2
+
+### Patch Changes
+
+- 641c7e5: Add a pathPrefix option to allow deployment to a subdirectory
+
+## 0.1.1
+
+### Patch Changes
+
+- a8c7173: Changes to config:
+  - Do not auto rollupWrap plugins added via `setupDevPlugins`.
+  - If you provide `devServer.plugins` then it will return that directly ignoring `setupDevAndBuildPlugins` and `setupDevPlugins`
+- Updated dependencies [a8c7173]
+  - plugins-manager@0.2.0
+
 ## 0.1.0
+
 ### Minor Changes
 
 - 1971f5d: Initial Release

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocket/cli",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "publishConfig": {
     "access": "public"
   },
@@ -63,7 +63,7 @@
     "command-line-args": "^5.1.1",
     "command-line-usage": "^6.1.1",
     "fs-extra": "^9.0.1",
-    "plugins-manager": "^0.1.0"
+    "plugins-manager": "^0.2.0"
   },
   "types": "dist-types/index.d.ts"
 }

packages/cli/src/RocketBuild.js

@@ -24,11 +24,6 @@ async function buildAndWrite(config) {
 }
 
 async function productionBuild(config) {
-  // const serviceWorkerFileName =
-  //   config.build && config.build.serviceWorkerFileName
-  //     ? config.build.serviceWorkerFileName
-  //     : 'service-worker.js';
-
   const mpaConfig = createMpaConfig({
     input: '**/*.html',
     output: {

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
@@ -39,10 +47,11 @@ export class RocketStart {
         clearTerminalOnReload: false,
         ...this.config.devServer,
 
-        setupPlugins: [...this.config.setupDevAndBuildPlugins, ...this.config.setupDevPlugins],
+        setupRollupPlugins: this.config.setupDevAndBuildPlugins,
+        setupPlugins: this.config.setupDevPlugins,
       },
       [],
-      { wrapperFunction: fromRollup },
+      { rollupWrapperFunction: fromRollup },
     );
 
     this.devServer = await startDevServer({

packages/cli/test-node/RocketCli.e2e.test.js

@@ -122,7 +122,7 @@ describe('RocketCli e2e', () => {
   });
 
   describe('setupDevAndBuildPlugins in config', () => {
-    it('can add a rollup plugin to build', async () => {
+    it('can add a rollup plugin via setupDevAndBuildPlugins for build command', async () => {
       cli = new RocketCli({
         argv: [
           'build',
@@ -135,7 +135,7 @@ describe('RocketCli e2e', () => {
       expect(inlineModule).to.equal('var a={test:"data"};console.log(a);');
     });
 
-    it('can add a rollup plugin to dev', async () => {
+    it('can add a rollup plugin via setupDevAndBuildPlugins for start command', async () => {
       cli = new RocketCli({
         argv: [
           'start',
@@ -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', {
+    const indexHtml = await readOutput('link/index.html', {
-    //   type: 'start',
+      type: 'start',
-    // });
+    });
-    // expect(indexHtml).to.equal("<p>Markdown in 'docs/page/index.md'</p>");
+    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', {
+    const indexHtml = await readOutput('link/index.html', {
-    //   type: 'start',
+      stripServiceWorker: true,
-    // });
+      stripToBody: true,
-    // expect(indexHtml).to.equal("<p>Markdown in 'docs/page/index.md'</p>");
+    });
+    expect(indexHtml).to.equal(
+      [
+        '<p><a href="../../">home</a></p>',
+        '<p><a href="/my-sub-folder/">absolute home</a></p>',
+      ].join('\n'),
+    );
   });
 });

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>

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;

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"
   },

packages/mdjs-core/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.6.1
+
+### Patch Changes
+
+- Updated dependencies [a8c7173]
+  - plugins-manager@0.2.0
+
 ## 0.6.0
 
 ### Minor Changes

packages/mdjs-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdjs/core",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "publishConfig": {
     "access": "public"
   },
@@ -48,7 +48,7 @@
     "@types/unist": "^2.0.3",
     "es-module-lexer": "^0.3.26",
     "github-markdown-css": "^4.0.0",
-    "plugins-manager": "^0.1.0",
+    "plugins-manager": "^0.2.0",
     "rehype-autolink-headings": "^5.0.1",
     "rehype-prism-template": "^0.4.1",
     "rehype-raw": "^5.0.0",

packages/plugins-manager/CHANGELOG.md

@@ -1,6 +1,22 @@
 # plugins-manager
 
+## 0.2.0
+
+### Minor Changes
+
+- a8c7173: Changes to `metaConfigToWebDevServerConfig`:
+
+  - Renamed `wrapperFunction` to `rollupWrapperFunction`
+  - Adds `setupRollupPlugins` which means those plugins are treated as rollup plugins and they will be wrapped by `rollupWrapperFunction` (if provided)
+  - Plugins added via `setupPlugins` will no longer be wrapped
+  - If you provide `config.plugins` then it will return that directly ignoring `setupPlugins` and `setupRollupPlugins`
+
+  Changes to `metaConfigToRollupConfig`:
+
+  - If you provide `config.plugins` then it will return that directly ignoring `setupPlugins`
+
 ## 0.1.0
+
 ### Minor Changes
 
 - b9a6274: First initial release

packages/plugins-manager/package.json

@@ -1,6 +1,6 @@
 {
   "name": "plugins-manager",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "publishConfig": {
     "access": "public"
   },

packages/plugins-manager/src/metaConfigToRollupConfig.js

@@ -7,6 +7,10 @@ import { executeSetupFunctions } from 'plugins-manager';
  * @param {MetaPlugin[]} [metaPlugins]
  */
 export function metaConfigToRollupConfig(config, metaPlugins = []) {
+  if (config.plugins) {
+    delete config.setupPlugins;
+    return config;
+  }
   const _metaPlugins = executeSetupFunctions(config.setupPlugins, [...metaPlugins]);
 
   const plugins = _metaPlugins.map(pluginObj => {

packages/plugins-manager/src/metaConfigToWebDevServerConfig.js

@@ -1,28 +1,53 @@
-/** @typedef {import('../types/main').MetaPlugin} MetaPlugin */
+/** @typedef {import('../types/main').MetaPluginWrapable} MetaPluginWrapable */
 
 import { executeSetupFunctions } from 'plugins-manager';
 
 /**
  * @param {any} config
- * @param {MetaPlugin[]} metaPlugins
+ * @param {MetaPluginWrapable[]} metaPlugins
  * @param {object} [options]
- * @param {function | null} [options.wrapperFunction]
+ * @param {function | null} [options.rollupWrapperFunction]
  */
-export function metaConfigToWebDevServerConfig(config, metaPlugins, { wrapperFunction = null }) {
+export function metaConfigToWebDevServerConfig(
-  const _metaPlugins = executeSetupFunctions(config.setupPlugins, [...metaPlugins]);
+  config,
+  metaPlugins,
+  { rollupWrapperFunction = null } = {},
+) {
+  if (config.plugins) {
+    delete config.setupPlugins;
+    delete config.setupRollupPlugins;
+    return config;
+  }
+
+  const metaPluginsNoWrap = metaPlugins.map(pluginObj => {
+    pluginObj.__noWrap = true;
+    return pluginObj;
+  });
+
+  const rollupPlugins = /** @type {MetaPluginWrapable[]} */ (executeSetupFunctions(
+    config.setupRollupPlugins,
+    [...metaPluginsNoWrap],
+  ));
+
+  const wrappedRollupPlugins = rollupPlugins.map(pluginObj => {
+    if (typeof rollupWrapperFunction === 'function' && pluginObj.__noWrap !== true) {
+      pluginObj.plugin = rollupWrapperFunction(pluginObj.plugin);
+    }
+    return pluginObj;
+  });
+
+  const _metaPlugins = executeSetupFunctions(config.setupPlugins, [...wrappedRollupPlugins]);
 
   const plugins = _metaPlugins.map(pluginObj => {
-    const usePlugin =
-      typeof wrapperFunction === 'function' ? wrapperFunction(pluginObj.plugin) : pluginObj.plugin;
-
     if (pluginObj.options) {
-      return usePlugin(pluginObj.options);
+      return pluginObj.plugin(pluginObj.options);
     } else {
-      return usePlugin();
+      return pluginObj.plugin();
     }
   });
   config.plugins = plugins;
 
   delete config.setupPlugins;
+  delete config.setupRollupPlugins;
   return config;
 }

packages/plugins-manager/test-node/metaConfigToRollupConfig.test.js

@@ -28,4 +28,16 @@ describe('metaConfigToRollupConfig', () => {
     expect(config.plugins).to.deep.equal(['firstPlugin', '-- insertPlugin --']);
     expect(config.setupPlugins).to.be.undefined;
   });
+
+  it('prefers a user set config.plugins', async () => {
+    const config = metaConfigToRollupConfig(
+      {
+        setupPlugins: [addPlugin({ name: 'insert', plugin: insertPlugin })],
+        plugins: ['user-set'],
+      },
+      threeExistingPlugin,
+    );
+    expect(config.plugins).to.deep.equal(['user-set']);
+    expect(config.setupPlugins).to.be.undefined;
+  });
 });

packages/plugins-manager/test-node/metaConfigToWebDevServerConfig.test.js

@@ -1,26 +1,56 @@
 import chai from 'chai';
 
-import { metaConfigToWebDevServerConfig } from 'plugins-manager';
+import { metaConfigToWebDevServerConfig, addPlugin } from 'plugins-manager';
 
 const { expect } = chai;
 
 describe('metaConfigToWebDevServerConfig', () => {
-  const threeExistingPlugin = [
+  const twoExistingPlugin = [
     { name: 'first', plugin: () => 'firstPlugin' },
     { name: 'second', plugin: () => 'secondPlugin' },
-    { name: 'third', plugin: () => 'thirdPlugin' },
   ];
 
-  it('accepts a wrapper function for plugins', async () => {
+  it('accepts a rollupWrapperFunction for setupRollupPlugins', async () => {
-    function wrapperFunction(srcFn) {
+    function rollupWrapperFunction(srcFn) {
       return () => `*wrapped* ${srcFn()}`;
     }
 
-    const config = metaConfigToWebDevServerConfig({}, threeExistingPlugin, { wrapperFunction });
+    const config = metaConfigToWebDevServerConfig(
+      {
+        setupRollupPlugins: [
+          addPlugin({ name: 'third', plugin: () => 'thirdPlugin' }),
+          addPlugin({ name: 'fourth', plugin: () => 'fourthPlugin' }),
+        ],
+        setupPlugins: [
+          addPlugin({ name: 'fifth', plugin: () => 'fifthPlugin' }),
+          addPlugin({ name: 'sixth', plugin: () => 'sixthPlugin' }),
+        ],
+      },
+      twoExistingPlugin,
+      { rollupWrapperFunction },
+    );
+
     expect(config.plugins).to.deep.equal([
-      '*wrapped* firstPlugin',
+      'firstPlugin',
-      '*wrapped* secondPlugin',
+      'secondPlugin',
       '*wrapped* thirdPlugin',
+      '*wrapped* fourthPlugin',
+      'fifthPlugin',
+      'sixthPlugin',
     ]);
   });
+
+  it('prefers a user set config.plugins', async () => {
+    const config = metaConfigToWebDevServerConfig(
+      {
+        setupPlugins: [addPlugin({ name: 'first', plugin: () => 'firstPlugin' })],
+        setupRollupPlugins: [addPlugin({ name: 'second', plugin: () => 'secondPlugin' })],
+        plugins: ['user-set'],
+      },
+      twoExistingPlugin,
+    );
+    expect(config.plugins).to.deep.equal(['user-set']);
+    expect(config.setupPlugins).to.be.undefined;
+    expect(config.setupRollupPlugins).to.be.undefined;
+  });
 });

packages/plugins-manager/types/main.d.ts

@@ -3,3 +3,7 @@ export interface MetaPlugin {
   plugin: any;
   options?: any;
 }
+
+export interface MetaPluginWrapable extends MetaPlugin {
+  __noWrap?: boolean;
+}

packages/search/CHANGELOG.md

@@ -1,6 +1,14 @@
 # @rocket/search
 
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies [a8c7173]
+  - plugins-manager@0.2.0
+
 ## 0.1.0
+
 ### Minor Changes
 
 - 1971f5d: Initial Release

packages/search/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocket/search",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "publishConfig": {
     "access": "public"
   },
@@ -43,7 +43,7 @@
     "@lion/combobox": "^0.1.16",
     "@open-wc/scoped-elements": "^1.3.2",
     "minisearch": "^3.0.2",
-    "plugins-manager": "^0.1.0",
+    "plugins-manager": "^0.2.0",
     "sax-wasm": "^2.0.0"
   }
 }