wip: improve node api

* Add number of files checked
* Add number of links checked

docs/blog/introducing-check-html-links.11tydata.cjs

@@ -0,0 +1,12 @@
+const { createSocialImage } = require('@rocket/cli');
+
+module.exports = async function () {
+  const socialMediaImage = await createSocialImage({
+    title: 'Introducing',
+    subTitle: 'check-html-links',
+    footer: 'Rocket Blog',
+  });
+  return {
+    socialMediaImage,
+  };
+};

docs/blog/introducing-check-html-links.md

@@ -0,0 +1,206 @@
+---
+title: Introducing check html links - no more bad links
+published: true
+description: A fast link checker for static html
+tags: [html, javascript, webdev, node]
+cover_image: https://dev-to-uploads.s3.amazonaws.com/i/an9z6f4hdll2jlne43u3.jpg
+---
+
+**TL;DR : I created a standalone tool that can help you fix all the broken links in your websites/documentation. You can check it out [on npm as check-html-links](https://www.npmjs.com/package/check-html-links)**
+
+In my developer career, I have put live multiple websites and honestly often within a few days, there was always this one issue raised. "This link on xxx is broken". 🤦‍♂️
+
+Often these things happen as somewhere a page got moved or renamed and not every location got updated.
+It's really hard to catch especially if you have a dynamic page like with WordPress or an SPA. And for users, there is nothing worse than landing on your documentation only to find a 404 staring back at them.
+
+Luckily, with the rise of SSG (Static Site Generators), this problem becomes easier to tackle and can be solved in large part. The reason for that is that with all HTML rendered upfront as static files we can read all of them and check every link.
+
+## Evaluation and the decision for a new tool
+
+Of course, I am not the first one to come up with that idea and there are multiple tools available on the market already.
+However, when checking existing solutions I found out that most of them didn't satisfy me in at least on way 😅. Things I noticed: slow to execute, deprecated, large dependency tree, confusing output for the user, ...
+
+Reviewing these tools I decided to create my own, with the following requirements :
+
+- Blazing fast
+- User-focused output
+- Few dependencies, to keep it lean
+- Preferably in the NodeJS ecosystem
+
+## Focusing on Useful Output
+
+Most tools evaluated check files individually and report on their findings individually. That means if you have a broken link in your header or footer, you will get one line (or even multiple lines) of an error message(s) for EVERY page.
+
+I tested this on the [11ty-website](https://github.com/11ty/11ty-website) and there are currently 516 broken links in 501 files. However, **the source of those 516 broken links is just 13 missing pages/resources**.
+
+In my implementation, I decided to switch from an "Error in File Focused" method to a "Missing File Focused". Let's see this with examples
+
+### Error in File Focused
+
+This is what a lot of current existing solutions implement. Here is part of the output that is being produced:
+
+```
+[...]
+authors/ryzokuken/index.html
+  target does not exist --- authors/ryzokuken/index.html --> /speedlify/
+authors/alex_kaul/index.html
+  target does not exist --- authors/alex_kaul/index.html --> /speedlify/
+docs/config/index.html
+  target does not exist --- docs/config/index.html --> /speedlify/
+  hash does not exist --- docs/config/index.html --> /docs/copy/#disabling-passthrough-file-copy
+authors/cramforce/index.html
+  target does not exist --- authors/cramforce/index.html --> /speedlify/
+authors/accudio/index.html
+  target does not exist --- authors/accudio/index.html --> /speedlify/
+[...]
+```
+
+We get ~2000 lines of errors for `/speedlify/` as it's not found ~500 times. In the middle of those errors, we also see some other broken links.
+Because the reporting is focusing first on the files, and then on the actual error **it is difficult to know where most errors originate from**.
+
+### Missing File Focused
+
+Let us turn that around and focus on missing references indeed. Here is the output for the same input website :
+
+```
+[...]
+  1. missing reference target _site/speedlify/index.html
+    from _site/404.html:1942:13 via href="/speedlify/"
+    from _site/authors/_amorgunov/index.html:2031:13 via href="/speedlify/"
+    from _site/authors/_coolcut/index.html:2031:13 via href="/speedlify/"
+    ... 495 more references to this target
+
+  2. missing id="disabling-passthrough-file-copy" in _site/docs/copy/index.html
+    from _site/docs/config/index.html:2527:267 via href="/docs/copy/#disabling-passthrough-file-copy"
+
+  3. missing reference target _site/authors/dkruythoff/github.com/dkruythoff/darius-codes
+    from _site/authors/dkruythoff/index.html:2102:234 via href="github.com/dkruythoff/darius-codes"
+[...]
+```
+
+We get one 5 line error for `/speedlify/` and it tells us it's missing 495 times + 3 examples usages.
+Afterward, we find very clearly more missing references and where they occurred.
+
+### A clear winner
+
+Comparing those two outputs makes it pretty clear to me that `Missing File Focused` will make more sense if there is a chance that some links will be broken everywhere. My implementation focuses on missing links in its output. This is crucial because it allows developers to know where to focus their efforts first to get the biggest wins.
+
+## Focusing on Speed
+
+Speed is always nice to have but in this case, it's probably vital. I need this to be fast so that I can run it potentially on every save. Speed is also very important in case the tool runs in a CI for example. For projects with extensive documentation, we don't want to hog the CI only to check for documentation.
+
+Luckily HTML is an awesome language to analyze as it's declarative, which means you can read and analyze it at the same time. This may even mean that the HTML is already processed by the time the file is done reading.
+
+With this knowledge I was hopeful - but reality didn't deliver 😅. The only tool that could keep up with the speed I needed was implemented in [Go](https://golang.org/).
+
+It seems that most tools use sophisticated parsers meant to create full syntax trees of your HTML.
+In reality for link checking all you need to know are the _id_ and the _href_ attributes.
+
+I have been using [sax-wasm](https://github.com/justinwilaby/sax-wasm) in a few situations before and I knew it supported streaming. I knew that way it could be FAST 🤞!
+
+How fast are we talking about though?
+
+As a rule of thumb, I decided that the analysis should be finished within 1s for a small site (up to 200 pages).
+The main reason is already listed above: To not disturb during writing/development as it will run on every save.
+For medium sites (200 - 1000 pages), it's reasonable if it takes a little longer - let's aim for less than 5 seconds. This will probably be a breaking point where you execute it only on-demand and in the CI instead of executing it on every save.
+
+Results are gatherd on January 26, 2021:
+
+| Website     | Pages | Duration |
+| ----------- | ----- | -------- |
+| open-wc.org | 90    | ~0.4s    |
+| 11ty.dev    | 501   | ~2.5s    |
+| web.dev     | 830   | ~3.7s    |
+| eslint.org  | 3475  | ~12.4s   |
+
+## Being part of the NodeJS ecosystem
+
+My daily workflow is hugely dominated by JavaScript, so it was only natural to want to stay in the same environment if I could reach my earlier requirements with it.
+On top of this, the end goal is to integrate it within a bigger WIP system called [Rocket](https://github.com/modernweb-dev/rocket) which is node-based so therefore it will need to at least support NodeJS. Having it standalone (usable via `npx`) also makes it more versatile and easier to maintain/test.
+
+## Focusing on a small Dependency Tree
+
+The JavaScript and NodeJs ecosystem is very active and constantly shifting. Lots of changes/improvements happen all the time. It's often hard to keep up. Therefore having a small dependency tree is something to always thrive for because it will reduce the maintenance burden down the line. And as an added benefit, it makes it smaller and easily embeddable as less stuff has to go down the wire. Lean is king 👑.
+
+## Solution
+
+As already mentioned I went on and implement a link checker myself 😅. So far it fits all my requirements so I call it a success 🎉! You can find it [on npm](https://www.npmjs.com/package/check-html-links).
+
+I called it `check-html-links` and its slogan is "no more broken links or assets".
+
+The features so far are:
+
+- extracts every attribute value of id, href, src, srset
+- use a wasm parser (sax-wasm)
+- streams the html for performance
+- check if file or id within file exist
+- focus on missing references/sources
+
+## Usage
+
+It does check your final html output so you need to execute it after your Static Site Generator.
+
+```
+npx check-html-links _site
+```
+
+## Usage Github Action
+
+[Julien](https://twitter.com/jlengrand) created a Github action available for the tool, so you can easily plug it in your existing CI. You can find it [on the GitHub Marketplace](https://github.com/marketplace/actions/check-html-links-action).
+
+Here is a complete example workflow that will check the result of the folder `_site` in the root of your repository on each push:
+
+```yml
+on: [push]
+
+jobs:
+  check_html_links_job:
+    runs-on: ubuntu-latest
+    name: A job to test check-html-links-action
+    steps:
+      - uses: actions/checkout@v2
+      - name: check-html-links-action step
+        id: check-links
+        uses: modernweb-dev/check-html-links-action@v1
+        with:
+          doc-folder: '_site_'
+```
+
+## Comparison
+
+Checking the output of [11ty-website](https://github.com/11ty/11ty-website) with 13 missing reference targets (used by 516 links) while checking 501 files. (on January 17, 2021)
+
+| Tool             | Lines printed | Duration | Lang | Dependency Tree |
+| ---------------- | ------------- | -------- | ---- | --------------- |
+| check-html-links | 38            | ~2.5s    | node | 19              |
+| link-checker     | 3000+         | ~11s     | node | 106             |
+| hyperlink        | 68            | 4m 20s   | node | 481             |
+| htmltest         | 1000+         | ~0.7s    | GO   | -               |
+
+## Future
+
+The basic functionality is finished and it's reasonabley fast.
+
+Topic to work on:
+
+- Allow to ignore folders (potentially via a cli parameter)
+- Support for `<base href="/">`
+- Big Sites Speed improvements (potentially running multiple parsers in parallel for 1000+ pages)
+- Speed improvements by introducing a "permanent cache" for the parse result (if file did not change, parse result will not change - we still check all links)
+- Memory consumption check (see if there is room for improvements)
+- Improve node api
+- Check external links
+
+## Acknowledgements
+
+Thank you for following along on my journey on creating `check-html-links`. You can find the code on [Github](https://github.com/modernweb-dev/rocket/tree/main/packages/check-html-links).
+
+Follow us on [Twitter](https://twitter.com/modern_web_dev), or follow me on my personal [Twitter](https://twitter.com/dakmor).
+
+Thanks to [Julien](https://twitter.com/jlengrand) for feedback and helping turn my scribbles to a followable story.
+
+If you think my open source work is valuable then I would like you to check out my personal [Github Sponsor Page](https://github.com/sponsors/daKmoR). Or you can support our whole group via the [Modern Web Open Collective](https://opencollective.com/modern-web).
+
+---
+
+<span>Photo by <a href="https://unsplash.com/@mihaiteslariu0?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Teslariu Mihai</a> on <a href="https://unsplash.com/?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></span>

docs/blog/introducing-rocket/index.md

@@ -1,16 +0,0 @@
----
-title: Introducing rocket - effective static content with some javascript
-published: true
-description: Write Interactive Demos Using Markdown and JavaScript
-tags: [markdown, javascript, webcomponents, demos]
-cover_image: /blog/introducing-rocket/images/blog-header.jpg
-socialMediaImage: /blog/introducing-rocket/images/social-media-image.jpg
----
-
-Welcome to the next level of content creation.
-
-## Here comes the navigation
-
-Stuff
-
-## Another anchor

docs/docs/configuration/overview.md

@@ -35,6 +35,9 @@ export default {
   // add a plugin to eleventy (e.g. a filter packs)
   setupEleventyPlugins: [],
 
+  // add a computedConfig to eleventy (e.g. site wide default variables like socialMediaImage)
+  setupEleventyComputedConfig: [],
+
   // add a plugin to the cli (e.g. a new command like "rocket my-command")
   setupCliPlugins: [],
 };

docs/docs/configuration/setupEleventyComputedConfig.md

@@ -0,0 +1,41 @@
+# Configuration >> setupEleventyComputedConfig ||20
+
+If you want to add data that depends on other data then you can do it via [11ty's computed data](https://www.11ty.dev/docs/data-computed/).
+
+Rocket exposes it via `setupEleventyComputedConfig`.
+
+## Set your own data
+
+Let's say you want to add a `Welcome to the contact page` everyhwere. (a filter might be a better choise but it's a good example of the concept)
+
+👉 `rocket.config.mjs` (or your theme config file)
+
+```js
+import { addPlugin } from 'plugins-manager';
+
+/** @type {Partial<import("../../../types/main").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [
+    addPlugin({ name: 'greeting', plugin: data => `Welcome to the ${data.title} page.` }),
+  ],
+};
+
+export default config;
+```
+
+{% raw %}
+Now you can use everywhere {{ greeting }}.
+{% endraw %}
+And it will correctly replaced with a Welcome and the page title.
+
+## Default Available Configs
+
+```js
+[
+  { name: 'titleMeta', plugin: titleMetaPlugin },
+  { name: 'title', plugin: titlePlugin },
+  { name: 'eleventyNavigation', plugin: eleventyNavigationPlugin },
+  { name: 'section', plugin: sectionPlugin },
+  { name: 'socialMediaImage', plugin: socialMediaImagePlugin },
+];
+```

docs/guides/go-live/social-media.md

@@ -9,6 +9,8 @@ It will look like this but with your logo
 
 There are multiple ways you can modify it.
 
+Note: If your logo has an `<?xml>` tag it will throw an error as it will be inlined into this svg and nested xml tags are not allowed.
+
 ## Setting it via frontMatter
 
 You can create your own image and link it with something like this
@@ -25,20 +27,105 @@ Sometimes extracting the title + title of parent is not enough but you still wan
 
 You can create an `11tydata.cjs` file next to your page. If your page is `docs/guides/overview.md` then you create a `docs/guides/overview.11tydata.cjs`.
 
-In there you can use the default `createPageSocialImage` but provide your own values.
+In there you can use the default `createSocialImage` but provide your own values.
 
 ```js
-const { createPageSocialImage } = require('@rocket/cli');
+const { createSocialImage } = require('@rocket/cli');
 
 module.exports = async function () {
-  const socialMediaImage = await createPageSocialImage({
+  const socialMediaImage = await createSocialImage({
     title: 'Learning Rocket',
     subTitle: 'Have a website',
     subTitle2: 'in 5 Minutes',
     footer: 'Rocket Guides',
+    // you can also override the svg only for this page by providing
+    // createSocialImageSvg: async () => '<svg>...</svg>'
   });
   return {
     socialMediaImage,
   };
 };
 ```
+
+## Override the default image
+
+Often you want to have a unique style for your social media images.
+For that you can provide your own function which returns a string of an svg to render the image.
+
+👉 `rocket.config.mjs`
+
+```js
+import { adjustPluginOptions } from 'plugins-manager';
+
+/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [
+    adjustPluginOptions('socialMediaImage', {
+      createSocialImageSvg: async ({
+        title = '',
+        subTitle = '',
+        subTitle2 = '',
+        footer = '',
+        logo = '',
+      }) => {
+        let svgStr = `
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 630" style="fill: #ecedef;">
+            <defs/>
+            <rect width="100%" height="100%" fill="#38393e"/>
+            <g transform="matrix(0.45, 0, 0, 0.45, 300, 60)">${logo}</g>
+            <g style="
+              font-size: 70px;
+              text-anchor: middle;
+              font-family: 'Bitstream Vera Sans','Helvetica',sans-serif;
+              font-weight: 700;
+            ">
+              <text x="50%" y="470">
+                ${title}
+              </text>
+              <text x="50%" y="520" style="font-size: 30px;">
+                ${subTitle}
+              </text>
+            </g>
+            <text x="10" y="620" style="font-size: 30px; fill: gray;">
+              ${footer}
+            </text>
+          </svg>
+        `;
+        return svgStr;
+      },
+    }),
+  ],
+};
+
+export default config;
+```
+
+## Using an svg file as a src with nunjucks
+
+If you have multiple variations it may be easier to save them as svg files and using a template system
+
+WARNING: Untested example
+
+👉 `rocket.config.mjs`
+
+{% raw %}
+
+```js
+import { adjustPluginOptions } from 'plugins-manager';
+
+/** @type {Partial<import("@rocket/cli").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [
+    adjustPluginOptions('socialMediaImage', {
+      createSocialImageSvg: async (args = {}) => {
+        // inside of the svg you can use {{ title }}
+        const svgBuffer = await fs.promises.readFile('/path/to/your/svg/file');
+        const svg = logoBuffer.toString();
+        return nunjucks.renderString(svg, args);
+      },
+    }),
+  ],
+};
+
+{% endraw %}
+```

docs/guides/index.11tydata.cjs

@@ -1,7 +1,7 @@
-const { createPageSocialImage } = require('@rocket/cli');
+const { createSocialImage } = require('@rocket/cli');
 
 module.exports = async function () {
-  const socialMediaImage = await createPageSocialImage({
+  const socialMediaImage = await createSocialImage({
     title: 'Learning Rocket',
     subTitle: 'Have a website',
     subTitle2: 'in 5 Minutes',

docs/guides/presets/create-your-own.md

@@ -1,7 +1,106 @@
 # Presets >> Create your own || 90
 
-All loaded presets will be combined but you can override each file.
+A preset is setup function and a folder including `_assets`, `_data` and `_includes` (all optional).
 
-Take a look at `docs/_merged_includes` and override what you want to override by placing the same filename into `_includes`.
+To play around with a preset you can create a folder `fire-theme`.
 
-Also works for `_assets`, `_data` ...
+You then create the setup function for it with only one property called `path` which will allow Rocket to properly resolve it.
+
+## Create a Preset Config File
+
+👉 `fire-theme/fireTheme.js`
+
+```js
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export function fireTheme() {
+  return {
+    path: path.resolve(__dirname),
+  };
+}
+```
+
+Once you have that you can start filling in content you need.
+
+For example a we could override the full `layout.css` by adding a it like so
+
+👉 `fire-theme/layout.css`
+
+```css
+body {
+  background: hotpink;
+}
+```
+
+Once you have that you can add it to your Rocket Config.
+
+NOTE: The order of presets is important, as for example in this case we take everything from `rocketLaunch` but later override via `fireTheme`.
+
+👉 `rocket-config.js`
+
+```js
+import { rocketLaunch } from '@rocket/launch';
+import { fireTheme } from 'path/to/fire-theme/fireTheme.js';
+
+export default {
+  presets: [rocketLaunch(), fireTheme()],
+};
+```
+
+## Publish a preset
+
+If you would like to publish a preset to use it on multiple websites or share it with your friends you can do like so.
+
+1. Pick a name for the package => for this example we take `fire-theme`.
+2. Create a new folder `fire-theme`
+3. Create a folder `fire-theme/preset` copy `fireTheme.js` from [above](#create-a-preset-config-file) into `preset/fireTheme.js`
+4. Add a 👉 `package.json`
+
+   ```json
+   {
+     "name": "fire-theme",
+     "version": "0.3.0",
+     "description": "Fire Theme for Rocket",
+     "license": "MIT",
+     "type": "module",
+     "exports": {
+       ".": "./index.js",
+       "./preset/": "./preset/"
+     },
+     "files": ["*.js", "preset"],
+     "keywords": ["rocket", "preset"]
+   }
+   ```
+
+5. Add a 👉 `index.js`
+
+   ```js
+   export { fireTheme } from './preset/fireTheme.js';
+   ```
+
+6. Add a 👉 `README.md`
+
+   ````
+   # FireTheme
+
+   This is a theme/preset for [Rocket](https://rocket.modern-web.dev/).
+
+   ## Installation
+
+   ```
+   npm i -D fire-theme
+   ```
+
+   Add it to your 👉 `rocket.config.js`
+
+   ```js
+   import { fireTheme } from 'fire-theme';
+
+   export default {
+     presets: [fireTheme()],
+   };
+   ```
+   ````

docs/index.11tydata.cjs

@@ -1,7 +1,7 @@
-const { createPageSocialImage } = require('@rocket/cli');
+const { createSocialImage } = require('@rocket/cli');
 
 module.exports = async function () {
-  const socialMediaImage = await createPageSocialImage({
+  const socialMediaImage = await createSocialImage({
     title: 'Rocket',
     subTitle: 'Static sites with',
     subTitle2: 'a sprinkle of JavaScript.',

package.json

@@ -28,7 +28,7 @@
     "release": "changeset publish && yarn format",
     "rocket:build": "node packages/cli/src/cli.js build",
     "search": "node packages/cli/src/cli.js search",
-    "setup": "npm run setup:ts-configs",
+    "setup": "npm run setup:ts-configs && npm run build:packages",
     "setup:patches": "npx patch-package",
     "setup:ts-configs": "node scripts/generate-ts-configs.mjs",
     "start": "node packages/cli/src/cli.js start",

packages/check-html-links/CHANGELOG.md

@@ -1,6 +1,13 @@
 # check-html-links
 
+## 0.1.1
+
+### Patch Changes
+
+- eb74110: Add info about how many files and links will be checked
+
 ## 0.1.0
+
 ### Minor Changes
 
 - cd22231: Initial release

packages/check-html-links/README.md

@@ -16,7 +16,7 @@ npx check-html-links _site
 
 For docs please see our homepage [https://rocket.modern-web.dev/docs/tools/check-html-links/](https://rocket.modern-web.dev/docs/tools/check-html-links/).
 
-## Comparision
+## Comparison
 
 Checking the output of [11ty-website](https://github.com/11ty/11ty-website) with 13 missing reference targets (used by 516 links) while checking 501 files. (on January 17, 2021)
 

packages/check-html-links/index.js

@@ -1,2 +1,3 @@
 export { validateFolder } from './src/validateFolder.js';
 export { formatErrors } from './src/formatErrors.js';
+export { checkHtmlLinks } from './src/checkHtmlLinks.js';

packages/check-html-links/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-html-links",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "publishConfig": {
     "access": "public"
   },

packages/check-html-links/src/checkHtmlLinks.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+import chalk from 'chalk';
+import { validateFiles } from './validateFolder.js';
+import { formatErrors } from './formatErrors.js';
+import { listFiles } from './listFiles.js';
+
+export async function checkHtmlLinks({ rootDir = process.cwd() }) {
+  const performanceStart = process.hrtime();
+
+  console.log('👀 Checking if all internal links work...');
+  const files = await listFiles('**/*.html', rootDir);
+
+  const filesOutput =
+    files.length == 0
+      ? '🧐 No files to check. Did you select the correct folder?'
+      : `🔥 Found a total of ${chalk.green.bold(files.length)} files to check!`;
+  console.log(filesOutput);
+
+  const { errors, numberLinks } = await validateFiles(files, rootDir);
+
+  console.log(`🔗 Found a total of ${chalk.green.bold(numberLinks)} links to validate!\n`);
+
+  const performance = process.hrtime(performanceStart);
+  if (errors.length > 0) {
+    let referenceCount = 0;
+    for (const error of errors) {
+      referenceCount += error.usage.length;
+    }
+    const output = [
+      `❌ Found ${chalk.red.bold(
+        errors.length.toString(),
+      )} missing reference targets (used by ${referenceCount} links) while checking ${
+        files.length
+      } files:`,
+      ...formatErrors(errors)
+        .split('\n')
+        .map(line => `  ${line}`),
+      `Checking links duration: ${performance[0]}s ${performance[1] / 1000000}ms`,
+    ];
+    console.error(output.join('\n'));
+    process.exit(1);
+  } else {
+    console.log(
+      `✅ All internal links are valid. (executed in ${performance[0]}s ${
+        performance[1] / 1000000
+      }ms)`,
+    );
+  }
+}

packages/check-html-links/src/cli.js

@@ -1,45 +1,17 @@
 #!/usr/bin/env node
 
 import path from 'path';
-import chalk from 'chalk';
-import { validateFiles } from './validateFolder.js';
-import { formatErrors } from './formatErrors.js';
-import { listFiles } from './listFiles.js';
+import { checkHtmlLinks } from 'check-html-links';
 
-async function main() {
+async function cli() {
   const userRootDir = process.argv[2];
   const rootDir = userRootDir ? path.resolve(userRootDir) : process.cwd();
-  const performanceStart = process.hrtime();
 
-  console.log('👀 Checking if all internal links work...');
-  const files = await listFiles('**/*.html', rootDir);
-  const errors = await validateFiles(files, rootDir);
-  const performance = process.hrtime(performanceStart);
-  if (errors.length > 0) {
-    let referenceCount = 0;
-    for (const error of errors) {
-      referenceCount += error.usage.length;
-    }
-    const output = [
-      `❌ Found ${chalk.red.bold(
-        errors.length.toString(),
-      )} missing reference targets (used by ${referenceCount} links) while checking ${
-        files.length
-      } files:`,
-      ...formatErrors(errors)
-        .split('\n')
-        .map(line => `  ${line}`),
-      `Checking links duration: ${performance[0]}s ${performance[1] / 1000000}ms`,
-    ];
-    console.error(output.join('\n'));
-    process.exit(1);
-  } else {
-    console.log(
-      `✅ All internal links are valid. (executed in %ds %dms)`,
-      performance[0],
-      performance[1] / 1000000,
-    );
+  try {
+    await checkHtmlLinks({ rootDir });
+  } catch (error) {
+    console.log('Check Html Links CLI failed to execute', error);
   }
 }
 
-main();
+cli();

packages/check-html-links/src/validateFolder.js

@@ -267,13 +267,15 @@ export async function validateFiles(files, rootDir) {
   errors = [];
   checkLocalFiles = [];
   idCache = new Map();
+  let numberLinks = 0;
   for (const htmlFilePath of files) {
     const { links } = await extractReferences(htmlFilePath);
+    numberLinks += links.length;
     await resolveLinks(links, { htmlFilePath, rootDir });
   }
   await validateLocalFiles(checkLocalFiles);
 
-  return errors;
+  return { errors: errors, numberLinks: numberLinks };
 }
 
 /**
@@ -282,6 +284,6 @@ export async function validateFiles(files, rootDir) {
 export async function validateFolder(inRootDir) {
   const rootDir = path.resolve(inRootDir);
   const files = await listFiles('**/*.html', rootDir);
-  const errors = await validateFiles(files, rootDir);
+  const { errors } = await validateFiles(files, rootDir);
   return errors;
 }

packages/cli/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @rocket/cli
 
+## 0.4.1
+
+### Patch Changes
+
+- c92769a: Processing links and asset urls to generate the final html output is now utf8 safe
+- 562e91f: Make sure logos do not have "<?xml" in their code
+
+## 0.4.0
+
+### Minor Changes
+
+- 0eb507d: Adds the capability to configure the svg template for the social media images.
+- 0eb507d: Adds `setupEleventyComputedConfig` option to enable configuration of 11ty's `eleventyComputed`. The plugins-manager system is used for it.
+
+## 0.3.1
+
+### Patch Changes
+
+- a498a5d: Make sure links to `*index.md` files are not treated as folder index files like `index.md`
+
 ## 0.3.0
 
 ### Minor Changes

packages/cli/index.cjs

@@ -1,10 +1,10 @@
 const { setComputedConfig, getComputedConfig } = require('./src/public/computedConfig.cjs');
-const rocketEleventyComputed = require('./src/public/rocketEleventyComputed.cjs');
-const { createPageSocialImage } = require('./src/public/createPageSocialImage.cjs');
+const { generateEleventyComputed } = require('./src/public/generateEleventyComputed.cjs');
+const { createSocialImage } = require('./src/public/createSocialImage.cjs');
 
 module.exports = {
   setComputedConfig,
   getComputedConfig,
-  rocketEleventyComputed,
-  createPageSocialImage,
+  generateEleventyComputed,
+  createSocialImage,
 };

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rocket/cli",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "publishConfig": {
     "access": "public"
   },
@@ -62,11 +62,12 @@
     "@web/dev-server": "^0.1.4",
     "@web/dev-server-rollup": "^0.3.2",
     "@web/rollup-plugin-copy": "^0.2.0",
-    "check-html-links": "^0.1.0",
+    "check-html-links": "^0.1.1",
     "command-line-args": "^5.1.1",
     "command-line-usage": "^6.1.1",
     "fs-extra": "^9.0.1",
-    "plugins-manager": "^0.2.0"
+    "plugins-manager": "^0.2.0",
+    "utf8": "^3.0.0"
   },
   "types": "dist-types/index.d.ts"
 }

packages/cli/preset/_data/eleventyComputed.cjs

@@ -1,5 +1,5 @@
-const { rocketEleventyComputed } = require('@rocket/cli');
+const { generateEleventyComputed } = require('@rocket/cli');
 
 module.exports = {
-  ...rocketEleventyComputed,
+  ...generateEleventyComputed(),
 };

packages/cli/src/RocketCli.js

@@ -199,7 +199,7 @@ export class RocketCli {
     setComputedConfig({});
     if (this.eleventy) {
       this.eleventy.finish();
-      // this.eleventy.stopWatch();
+      // await this.eleventy.stopWatch();
     }
     this.stop();
   }

packages/cli/src/eleventy-plugins/processLocalReferences.cjs

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const utf8 = require('utf8');
 const { SaxEventType, SAXParser } = require('sax-wasm');
 
 const saxPath = require.resolve('sax-wasm/lib/sax-wasm.wasm');
@@ -39,22 +40,25 @@ const templateEndings = [
   '.pug',
 ];
 
-function endsWithAny(string, suffixes) {
-  for (let suffix of suffixes) {
-    if (string.endsWith(suffix)) {
+function isTemplateFile(href) {
+  for (const templateEnding of templateEndings) {
+    if (href.endsWith(templateEnding)) {
       return true;
     }
   }
   return false;
 }
 
-function isTemplateFile(href) {
-  return endsWithAny(href, templateEndings);
-}
-
 function isIndexTemplateFile(href) {
+  const hrefParsed = path.parse(href);
   const indexTemplateEndings = templateEndings.map(ending => `index${ending}`);
-  return endsWithAny(href, indexTemplateEndings);
+
+  for (const indexTemplateEnding of indexTemplateEndings) {
+    if (hrefParsed.base === indexTemplateEnding) {
+      return true;
+    }
+  }
+  return false;
 }
 
 /**
@@ -91,12 +95,46 @@ function extractReferences(html, inputPath) {
   return { hrefs, assets };
 }
 
+/**
+ * @param {string} inValue
+ */
+function getValueAndAnchor(inValue) {
+  let value = inValue.replace(/&#/g, '--__check-html-links__--');
+  let anchor = '';
+  let suffix = '';
+
+  if (value.includes('#')) {
+    [value, anchor] = value.split('#');
+    suffix = `#${anchor}`;
+  }
+  if (value.includes('?')) {
+    value = value.split('?')[0];
+  }
+  if (anchor.includes(':~:')) {
+    anchor = anchor.split(':~:')[0];
+  }
+  if (value.includes(':~:')) {
+    value = value.split(':~:')[0];
+  }
+
+  value = value.replace(/--__check-html-links__--/g, '&#');
+  anchor = anchor.replace(/--__check-html-links__--/g, '&#');
+  suffix = suffix.replace(/--__check-html-links__--/g, '&#');
+  value = value.trim();
+  anchor = anchor.trim();
+
+  return {
+    value,
+    anchor,
+    suffix,
+  };
+}
+
 function calculateNewHrefs(hrefs, inputPath) {
   const newHrefs = [];
   for (const hrefObj of hrefs) {
     const newHrefObj = { ...hrefObj };
-    const [href, anchor] = newHrefObj.value.split('#');
-    const suffix = anchor ? `#${anchor}` : '';
+    const { value: href, suffix } = getValueAndAnchor(hrefObj.value);
 
     if (isRelativeLink(href) && isTemplateFile(href)) {
       const hrefParsed = path.parse(href);
@@ -167,15 +205,15 @@ function applyChanges(_changes, _content) {
   return content.replace(/XXXRocketProcessLocalReferencesXXX/g, '\n');
 }
 
-async function processLocalReferences(content) {
+async function processLocalReferences(_content) {
+  const content = utf8.encode(_content);
   const inputPath = this.inputPath;
   const { hrefs, assets } = extractReferences(content, inputPath);
   const newHrefs = calculateNewHrefs(hrefs, inputPath);
   const newAssets = calculateNewAssets(assets, inputPath);
 
   const newContent = applyChanges([...newHrefs, ...newAssets], content);
-
-  return newContent;
+  return utf8.decode(newContent);
 }
 
 module.exports = {

packages/cli/src/normalizeConfig.js

@@ -31,6 +31,7 @@ export async function normalizeConfig(inConfig) {
     setupDevPlugins: [],
     setupBuildPlugins: [],
     setupEleventyPlugins: [],
+    setupEleventyComputedConfig: [],
     setupCliPlugins: [],
     eleventy: () => {},
     command: 'help',
@@ -106,6 +107,12 @@ export async function normalizeConfig(inConfig) {
         ...preset.setupEleventyPlugins,
       ];
     }
+    if (preset.setupEleventyComputedConfig) {
+      config.setupEleventyComputedConfig = [
+        ...config.setupEleventyComputedConfig,
+        ...preset.setupEleventyComputedConfig,
+      ];
+    }
     if (preset.setupCliPlugins) {
       config.setupCliPlugins = [...config.setupCliPlugins, ...preset.setupCliPlugins];
     }

packages/cli/src/public/createPageSocialImage.cjs

@@ -1,73 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-const Image = require('@11ty/eleventy-img');
-const { getComputedConfig } = require('./computedConfig.cjs');
-
-async function createPageSocialImage({ title = '', subTitle = '', subTitle2 = '', footer = '' }) {
-  const rocketConfig = getComputedConfig();
-  const outputDir = path.join(rocketConfig.outputDevDir, '_merged_assets', '11ty-img');
-
-  const logoPath = path.join(rocketConfig._inputDirCwdRelative, '_merged_assets', 'logo.svg');
-
-  const logoBuffer = await fs.promises.readFile(logoPath);
-  const logo = logoBuffer.toString();
-
-  let svgStr = `
-    <svg xmlns="http://www.w3.org/2000/svg" fill="#4a4a4a" font-family="sans-serif" font-size="80" style="background-color:#fff" viewBox="0 0 1200 630">
-      <defs></defs>
-      <rect width="100%" height="100%" fill="#fff" />
-      <circle cx="1000" cy="230" r="530" fill="#ebebeb"></circle>
-  `;
-
-  if (logo) {
-    svgStr += `<g transform="matrix(0.7, 0, 0, 0.7, 500, 100)">${logo}</g>`;
-  }
-
-  if (title) {
-    svgStr += `
-      <text x="70" y="200" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700">
-        ${title}
-      </text>
-    `;
-  }
-
-  if (subTitle) {
-    svgStr += `
-      <text x="70" y="320" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="60">
-        ${subTitle}
-      </text>
-    `;
-  }
-
-  if (subTitle2) {
-    svgStr += `
-      <text x="70" y="420" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="60">
-        ${subTitle2}
-      </text>
-    `;
-  }
-
-  if (footer) {
-    svgStr += `
-      <text x="70" y="560" fill="gray" font-size="40">
-        ${footer}
-      </text>
-    `;
-  }
-
-  svgStr += '</svg>';
-
-  let stats = await Image(Buffer.from(svgStr), {
-    widths: [1200], // Facebook Opengraph image is 1200 x 630
-    formats: ['png'],
-    outputDir,
-    urlPath: '/_merged_assets/11ty-img/',
-    sourceUrl: `${title}${subTitle}${footer}${logo}`, // This is only used to generate the output filename hash
-  });
-
-  return stats['png'][0].url;
-}
-
-module.exports = {
-  createPageSocialImage,
-};

packages/cli/src/public/createSocialImage.cjs

@@ -0,0 +1,45 @@
+const path = require('path');
+const fs = require('fs');
+const Image = require('@11ty/eleventy-img');
+const { getComputedConfig } = require('./computedConfig.cjs');
+const { createSocialImageSvg: defaultcreateSocialImageSvg } = require('./createSocialImageSvg.cjs');
+
+async function createSocialImage(args) {
+  const {
+    title = '',
+    subTitle = '',
+    footer = '',
+    createSocialImageSvg = defaultcreateSocialImageSvg,
+  } = args;
+  const cleanedUpArgs = { ...args };
+  delete cleanedUpArgs.createSocialImageSvg;
+
+  const rocketConfig = getComputedConfig();
+  const outputDir = path.join(rocketConfig.outputDevDir, '_merged_assets', '11ty-img');
+
+  const logoPath = path.join(rocketConfig._inputDirCwdRelative, '_merged_assets', 'logo.svg');
+
+  const logoBuffer = await fs.promises.readFile(logoPath);
+  const logo = logoBuffer.toString();
+
+  if (logo.includes('<?xml')) {
+    throw new Error('You should not have an "<?xml" tag in your logo.svg');
+  }
+
+  const svgStr = await createSocialImageSvg({ logo, ...args });
+
+  // TODO: cache images for 24h and not only for the given run (using @11ty/eleventy-cache-assets)
+  let stats = await Image(Buffer.from(svgStr), {
+    widths: [1200], // Facebook Opengraph image is 1200 x 630
+    formats: ['png'],
+    outputDir,
+    urlPath: '/_merged_assets/11ty-img/',
+    sourceUrl: `${title}${subTitle}${footer}${logo}`, // This is only used to generate the output filename hash
+  });
+
+  return stats['png'][0].url;
+}
+
+module.exports = {
+  createSocialImage,
+};

packages/cli/src/public/createSocialImageSvg.cjs

@@ -0,0 +1,33 @@
+async function createSocialImageSvg({
+  title = '',
+  subTitle = '',
+  subTitle2 = '',
+  footer = '',
+  logo = '',
+}) {
+  let svgStr = `
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 630">
+      <defs></defs>
+      <rect width="100%" height="100%" fill="#fff" />
+      <circle cx="1000" cy="230" r="530" fill="#ebebeb"></circle>
+      <g transform="matrix(0.6, 0, 0, 0.6, 580, 100)">${logo}</g>
+      <text x="70" y="200" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="80">
+        ${title}
+      </text>
+      <text x="70" y="320" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="60">
+        ${subTitle}
+      </text>
+      <text x="70" y="420" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="60">
+        ${subTitle2}
+      </text>
+      <text x="70" y="560" fill="gray" font-size="40">
+        ${footer}
+      </text>
+    </svg>
+  `;
+  return svgStr;
+}
+
+module.exports = {
+  createSocialImageSvg,
+};

packages/cli/src/public/generateEleventyComputed.cjs

@@ -0,0 +1,116 @@
+const fs = require('fs');
+const { processContentWithTitle } = require('@rocket/core/title');
+const { createSocialImage: defaultcreateSocialImage } = require('./createSocialImage.cjs');
+const { getComputedConfig } = require('./computedConfig.cjs');
+const { executeSetupFunctions } = require('plugins-manager');
+
+function titleMetaPlugin() {
+  return async data => {
+    if (data.titleMeta) {
+      return data.titleMeta;
+    }
+    let text = await fs.promises.readFile(data.page.inputPath);
+    text = text.toString();
+    const titleMetaFromContent = processContentWithTitle(text, 'md');
+    if (titleMetaFromContent) {
+      return titleMetaFromContent;
+    }
+    return {};
+  };
+}
+
+function titlePlugin() {
+  return async data => {
+    if (data.title) {
+      return data.title;
+    }
+    return data.titleMeta?.title;
+  };
+}
+
+function eleventyNavigationPlugin() {
+  return async data => {
+    if (data.eleventyNavigation) {
+      return data.eleventyNavigation;
+    }
+    return data.titleMeta?.eleventyNavigation;
+  };
+}
+
+function sectionPlugin() {
+  return async data => {
+    if (data.section) {
+      return data.section;
+    }
+
+    if (data.page.filePathStem) {
+      // filePathStem: '/sub/subsub/index'
+      // filePathStem: '/index',
+      const parts = data.page.filePathStem.split('/');
+      if (parts.length > 2) {
+        return parts[1];
+      }
+    }
+  };
+}
+
+function socialMediaImagePlugin(args = {}) {
+  const { createSocialImage = defaultcreateSocialImage } = args;
+
+  const cleanedUpArgs = { ...args };
+  delete cleanedUpArgs.createSocialImage;
+
+  return async data => {
+    if (data.socialMediaImage) {
+      return data.socialMediaImage;
+    }
+    if (!data.title) {
+      return;
+    }
+
+    const title = data.titleMeta.parts ? data.titleMeta.parts[0] : '';
+    const subTitle =
+      data.titleMeta.parts && data.titleMeta.parts[1] ? `in ${data.titleMeta.parts[1]}` : '';
+    const section = data.section ? ' ' + data.section[0].toUpperCase() + data.section.slice(1) : '';
+    const footer = `${data.site.name}${section}`;
+
+    const imgUrl = await createSocialImage({
+      title,
+      subTitle,
+      footer,
+      section,
+      ...cleanedUpArgs,
+    });
+    return imgUrl;
+  };
+}
+
+function generateEleventyComputed() {
+  const rocketConfig = getComputedConfig();
+
+  let metaPlugins = [
+    { name: 'titleMeta', plugin: titleMetaPlugin },
+    { name: 'title', plugin: titlePlugin },
+    { name: 'eleventyNavigation', plugin: eleventyNavigationPlugin },
+    { name: 'section', plugin: sectionPlugin },
+    { name: 'socialMediaImage', plugin: socialMediaImagePlugin },
+  ];
+
+  const finalMetaPlugins = executeSetupFunctions(
+    rocketConfig.setupEleventyComputedConfig,
+    metaPlugins,
+  );
+
+  const eleventyComputed = {};
+  for (const pluginObj of finalMetaPlugins) {
+    if (pluginObj.options) {
+      eleventyComputed[pluginObj.name] = pluginObj.plugin(pluginObj.options);
+    } else {
+      eleventyComputed[pluginObj.name] = pluginObj.plugin();
+    }
+  }
+
+  return eleventyComputed;
+}
+
+module.exports = { generateEleventyComputed };

packages/cli/src/public/rocketEleventyComputed.cjs

@@ -1,63 +0,0 @@
-const fs = require('fs');
-const { processContentWithTitle } = require('@rocket/core/title');
-const { createPageSocialImage } = require('./createPageSocialImage.cjs');
-
-module.exports = {
-  titleMeta: async data => {
-    if (data.titleMeta) {
-      return data.titleMeta;
-    }
-    let text = await fs.promises.readFile(data.page.inputPath);
-    text = text.toString();
-    const titleMetaFromContent = processContentWithTitle(text, 'md');
-    if (titleMetaFromContent) {
-      return titleMetaFromContent;
-    }
-    return {};
-  },
-  title: async data => {
-    if (data.title) {
-      return data.title;
-    }
-    return data.titleMeta?.title;
-  },
-  eleventyNavigation: async data => {
-    if (data.eleventyNavigation) {
-      return data.eleventyNavigation;
-    }
-    return data.titleMeta?.eleventyNavigation;
-  },
-  section: async data => {
-    if (data.section) {
-      return data.section;
-    }
-
-    if (data.page.filePathStem) {
-      // filePathStem: '/sub/subsub/index'
-      // filePathStem: '/index',
-      const parts = data.page.filePathStem.split('/');
-      if (parts.length > 2) {
-        return parts[1];
-      }
-    }
-  },
-  socialMediaImage: async data => {
-    if (data.socialMediaImage) {
-      return data.socialMediaImage;
-    }
-    if (!data.title) {
-      return;
-    }
-
-    const section = data.section ? ' ' + data.section[0].toUpperCase() + data.section.slice(1) : '';
-    const footer = `${data.site.name}${section}`;
-
-    const imgUrl = await createPageSocialImage({
-      title: data.titleMeta.parts ? data.titleMeta.parts[0] : '',
-      subTitle:
-        data.titleMeta.parts && data.titleMeta.parts[1] ? `in ${data.titleMeta.parts[1]}` : '',
-      footer,
-    });
-    return imgUrl;
-  },
-};

packages/cli/src/shared/.eleventy.cjs

@@ -8,6 +8,7 @@ const rocketCollections = require('../eleventy-plugins/rocketCollections.cjs');
 
 module.exports = function (eleventyConfig) {
   const config = getComputedConfig();
+
   const { pathPrefix, _inputDirCwdRelative, outputDevDir } = config;
 
   let metaPlugins = [
@@ -46,12 +47,16 @@ module.exports = function (eleventyConfig) {
     }
   }
 
-  for (const pluginObj of metaPlugins) {
-    if (pluginObj.options) {
-      eleventyConfig.addPlugin(pluginObj.plugin, pluginObj.options);
-    } else {
-      eleventyConfig.addPlugin(pluginObj.plugin);
+  try {
+    for (const pluginObj of metaPlugins) {
+      if (pluginObj.options) {
+        eleventyConfig.addPlugin(pluginObj.plugin, pluginObj.options);
+      } else {
+        eleventyConfig.addPlugin(pluginObj.plugin);
+      }
     }
+  } catch (err) {
+    console.log('An eleventy plugin had an error', err);
   }
 
   if (config.eleventy) {

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

@@ -0,0 +1,182 @@
+import chai from 'chai';
+import chalk from 'chalk';
+import { executeStart, readOutput, readStartOutput } from './helpers.js';
+
+const { expect } = chai;
+
+describe('RocketCli computedConfig', () => {
+  let cli;
+
+  before(() => {
+    // ignore colors in tests as most CIs won't support it
+    chalk.level = 0;
+  });
+
+  afterEach(async () => {
+    if (cli?.cleanup) {
+      await cli.cleanup();
+    }
+  });
+
+  it('will extract a title from markdown and set first folder as section', async () => {
+    cli = await executeStart('computed-config-fixtures/headlines/rocket.config.js');
+
+    const indexHtml = await readOutput(cli, 'index.html', {
+      type: 'start',
+    });
+    const [indexTitle, indexSection] = indexHtml.split('\n');
+    expect(indexTitle).to.equal('Root');
+    expect(indexSection).to.be.undefined;
+
+    const subHtml = await readOutput(cli, 'sub/index.html', {
+      type: 'start',
+    });
+    const [subTitle, subSection] = subHtml.split('\n');
+    expect(subTitle).to.equal('Root: Sub');
+    expect(subSection).to.equal('sub');
+
+    const subSubHtml = await readOutput(cli, 'sub/subsub/index.html', {
+      type: 'start',
+    });
+    const [subSubTitle, subSubSection] = subSubHtml.split('\n');
+    expect(subSubTitle).to.equal('Sub: SubSub');
+    expect(subSubSection).to.equal('sub');
+
+    const sub2Html = await readOutput(cli, 'sub2/index.html', {
+      type: 'start',
+    });
+    const [sub2Title, sub2Section] = sub2Html.split('\n');
+    expect(sub2Title).to.equal('Root: Sub2');
+    expect(sub2Section).to.equal('sub2');
+
+    const withDataHtml = await readOutput(cli, 'with-data/index.html', {
+      type: 'start',
+    });
+    const [withDataTitle, withDataSection] = withDataHtml.split('\n');
+    expect(withDataTitle).to.equal('Set via data');
+    expect(withDataSection).be.undefined;
+  });
+
+  it('will create a social media image for every page', async () => {
+    cli = await executeStart('computed-config-fixtures/social-images/rocket.config.js');
+
+    const indexHtml = await readStartOutput(cli, 'index.html');
+    expect(indexHtml).to.equal('/_merged_assets/11ty-img/c4c29ec7-1200.png');
+
+    const guidesHtml = await readStartOutput(cli, 'guides/index.html');
+    expect(guidesHtml).to.equal('/_merged_assets/11ty-img/5e6f6f8c-1200.png');
+
+    const gettingStartedHtml = await readStartOutput(
+      cli,
+      'guides/first-pages/getting-started/index.html',
+    );
+    expect(gettingStartedHtml).to.equal('/_merged_assets/11ty-img/d989ab1a-1200.png');
+  });
+
+  it('can override the svg function globally to adjust all social media image', async () => {
+    cli = await executeStart('computed-config-fixtures/social-images-override/rocket.config.js');
+
+    const indexHtml = await readStartOutput(cli, 'index.html');
+    expect(indexHtml).to.equal('/_merged_assets/11ty-img/d76265ed-1200.png');
+
+    const guidesHtml = await readStartOutput(cli, 'guides/index.html');
+    expect(guidesHtml).to.equal('/_merged_assets/11ty-img/d76265ed-1200.png');
+
+    const gettingStartedHtml = await readStartOutput(
+      cli,
+      'guides/first-pages/getting-started/index.html',
+    );
+    expect(gettingStartedHtml).to.equal('/_merged_assets/11ty-img/d76265ed-1200.png');
+  });
+
+  it('will add "../" for links and image urls only within named template files', async () => {
+    cli = await executeStart('computed-config-fixtures/image-link/rocket.config.js');
+
+    const namedMdContent = [
+      '<p><a href="../">Root</a>',
+      '<a href="../one-level/raw/">Raw</a>',
+      '<img src="../images/my-img.svg" alt="my-img">',
+      '<img src="/images/my-img.svg" alt="absolute-img"></p>',
+    ];
+
+    const namedHtmlContent = [
+      '<div id="with-anchor">',
+      '  <a href="../">Root</a>',
+      '  <a href="../one-level/raw/">Raw</a>',
+      '  <img src="../images/my-img.svg" alt="my-img">',
+      '  <img src="/images/my-img.svg" alt="absolute-img">',
+      '  <picture>',
+      '    <source media="(min-width:465px)" srcset="../images/picture-min-465.jpg">',
+      '    <img src="../images/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
+      '  </picture>',
+      '</div>',
+    ];
+
+    const templateHtml = await readStartOutput(cli, 'template/index.html');
+    expect(templateHtml, 'template/index.html does not match').to.equal(
+      namedHtmlContent.join('\n'),
+    );
+
+    const guidesHtml = await readStartOutput(cli, 'guides/index.html');
+    expect(guidesHtml, 'guides/index.html does not match').to.equal(
+      [...namedMdContent, ...namedHtmlContent].join('\n'),
+    );
+
+    const noAdjustHtml = await readStartOutput(cli, 'no-adjust/index.html');
+    expect(noAdjustHtml, 'no-adjust/index.html does not match').to.equal(
+      '<p>Nothing to adjust in here</p>',
+    );
+
+    const rawHtml = await readStartOutput(cli, 'one-level/raw/index.html');
+    expect(rawHtml, 'raw/index.html does not match').to.equal(
+      [
+        '<div>',
+        '  <a href="../../">Root</a>',
+        '  <a href="../../guides/#with-anchor">Guides</a>',
+        '  <img src="../../images/my-img.svg" alt="my-img">',
+        '  <img src="/images/my-img.svg" alt="absolute-img">',
+        '  <picture>',
+        '    <source media="(min-width:465px)" srcset="/images/picture-min-465.jpg">',
+        '    <img src="../../images/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
+        '  </picture>',
+        '</div>',
+      ].join('\n'),
+    );
+
+    // for index files no '../' will be added
+    const indexHtml = await readStartOutput(cli, 'index.html');
+    expect(indexHtml, 'index.html does not match').to.equal(
+      [
+        '<p><a href="./">Root</a>',
+        '<a href="guides/#with-anchor">Guides</a>',
+        '<a href="./one-level/raw/">Raw</a>',
+        '<a href="template/">Template</a>',
+        '<a href="./rules/tabindex/">EndingIndex</a>',
+        '<img src="./images/my-img.svg" alt="my-img">',
+        '<img src="/images/my-img.svg" alt="absolute-img"></p>',
+        '<div>',
+        '  <a href="./">Root</a>',
+        '  👇<a href="guides/#with-anchor">Guides</a>',
+        '  👉 <a href="./one-level/raw/">Raw</a>',
+        '  <a href="template/">Template</a>',
+        '  <a href="./rules/tabindex/">EndingIndex</a>',
+        '  <img src="./images/my-img.svg" alt="my-img">',
+        '  <img src="/images/my-img.svg" alt="absolute-img">',
+        '  <picture>',
+        '    <source media="(min-width:465px)" srcset="./images/picture-min-465.jpg">',
+        '    <img src="./images/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
+        '  </picture>',
+        '</div>',
+      ].join('\n'),
+    );
+  });
+
+  it('can be configured via setupEleventyComputedConfig', async () => {
+    cli = await executeStart('computed-config-fixtures/setup/addPlugin.rocket.config.js');
+
+    const indexHtml = await readOutput(cli, 'index.html', {
+      type: 'start',
+    });
+    expect(indexHtml).to.equal('test-value');
+  });
+});

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

@@ -61,11 +61,6 @@ describe('RocketCli e2e', () => {
     return text;
   }
 
-  function readStartOutput(fileName, options = {}) {
-    options.type = 'start';
-    return readOutput(fileName, options);
-  }
-
   async function execute() {
     await cli.setup();
     cli.config.outputDevDir = path.join(__dirname, 'e2e-fixtures', '__output-dev');
@@ -76,17 +71,6 @@ describe('RocketCli e2e', () => {
     await cli.run();
   }
 
-  async function executeStart(pathToConfig) {
-    cli = new RocketCli({
-      argv: [
-        'start',
-        '--config-file',
-        path.join(__dirname, pathToConfig.split('/').join(path.sep)),
-      ],
-    });
-    await execute();
-  }
-
   async function executeLint(pathToConfig) {
     cli = new RocketCli({
       argv: ['lint', '--config-file', path.join(__dirname, pathToConfig.split('/').join(path.sep))],
@@ -286,153 +270,6 @@ describe('RocketCli e2e', () => {
     );
   });
 
-  it('will extract a title from markdown and set first folder as section', async () => {
-    cli = new RocketCli({
-      argv: [
-        'start',
-        '--config-file',
-        path.join(__dirname, 'e2e-fixtures', 'headlines', 'rocket.config.js'),
-      ],
-    });
-    await execute();
-
-    const indexHtml = await readOutput('index.html', {
-      type: 'start',
-    });
-    const [indexTitle, indexSection] = indexHtml.split('\n');
-    expect(indexTitle).to.equal('Root');
-    expect(indexSection).to.be.undefined;
-
-    const subHtml = await readOutput('sub/index.html', {
-      type: 'start',
-    });
-    const [subTitle, subSection] = subHtml.split('\n');
-    expect(subTitle).to.equal('Root: Sub');
-    expect(subSection).to.equal('sub');
-
-    const subSubHtml = await readOutput('sub/subsub/index.html', {
-      type: 'start',
-    });
-    const [subSubTitle, subSubSection] = subSubHtml.split('\n');
-    expect(subSubTitle).to.equal('Sub: SubSub');
-    expect(subSubSection).to.equal('sub');
-
-    const sub2Html = await readOutput('sub2/index.html', {
-      type: 'start',
-    });
-    const [sub2Title, sub2Section] = sub2Html.split('\n');
-    expect(sub2Title).to.equal('Root: Sub2');
-    expect(sub2Section).to.equal('sub2');
-
-    const withDataHtml = await readOutput('with-data/index.html', {
-      type: 'start',
-    });
-    const [withDataTitle, withDataSection] = withDataHtml.split('\n');
-    expect(withDataTitle).to.equal('Set via data');
-    expect(withDataSection).be.undefined;
-  });
-
-  it('will create a social media image for every page', async () => {
-    cli = new RocketCli({
-      argv: [
-        'start',
-        '--config-file',
-        path.join(__dirname, 'e2e-fixtures', 'social-images', 'rocket.config.js'),
-      ],
-    });
-    await execute();
-
-    const indexHtml = await readOutput('index.html', {
-      type: 'start',
-    });
-    expect(indexHtml).to.equal('/_merged_assets/11ty-img/c0a892f2-1200.png');
-
-    const guidesHtml = await readOutput('guides/first-pages/getting-started/index.html', {
-      type: 'start',
-    });
-    expect(guidesHtml).to.equal('/_merged_assets/11ty-img/58b7e437-1200.png');
-  });
-
-  it.only('will add "../" for links and image urls only within named template files', async () => {
-    await executeStart('e2e-fixtures/image-link/rocket.config.js');
-
-    const namedMdContent = [
-      '<p><a href="../">Root</a>',
-      '<a href="../one-level/raw/">Raw</a>',
-      '<img src="../images/my-img.svg" alt="my-img">',
-      '<img src="/images/my-img.svg" alt="absolute-img"></p>',
-    ];
-
-    const namedHtmlContent = [
-      '<div id="with-anchor">',
-      '  <a href="../">Root</a>',
-      '  <a href="../one-level/raw/">Raw</a>',
-      '  <img src="../images/my-img.svg" alt="my-img">',
-      '  <img src="/images/my-img.svg" alt="absolute-img">',
-      '  <picture>',
-      '    <source media="(min-width:465px)" srcset="../images/picture-min-465.jpg">',
-      '    <img src="../images/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
-      '  </picture>',
-      '</div>',
-    ];
-
-    const templateHtml = await readStartOutput('template/index.html');
-    expect(templateHtml, 'template/index.html does not match').to.equal(
-      namedHtmlContent.join('\n'),
-    );
-
-    const guidesHtml = await readStartOutput('guides/index.html');
-    expect(guidesHtml, 'guides/index.html does not match').to.equal(
-      [...namedMdContent, ...namedHtmlContent].join('\n'),
-    );
-
-    const noAdjustHtml = await readStartOutput('no-adjust/index.html');
-    expect(noAdjustHtml, 'no-adjust/index.html does not match').to.equal(
-      '<p>Nothing to adjust in here</p>',
-    );
-
-    const rawHtml = await readStartOutput('one-level/raw/index.html');
-    expect(rawHtml, 'raw/index.html does not match').to.equal(
-      [
-        '<div>',
-        '  <a href="../../">Root</a>',
-        '  <a href="../../guides/#with-anchor">Guides</a>',
-        '  <img src="../../images/my-img.svg" alt="my-img">',
-        '  <img src="/images/my-img.svg" alt="absolute-img">',
-        '  <picture>',
-        '    <source media="(min-width:465px)" srcset="/images/picture-min-465.jpg">',
-        '    <img src="../../images/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
-        '  </picture>',
-        '</div>',
-      ].join('\n'),
-    );
-
-    // for index files no '../' will be added
-    const indexHtml = await readStartOutput('index.html');
-    expect(indexHtml, 'index.html does not match').to.equal(
-      [
-        '<p><a href="./">Root</a>',
-        '<a href="guides/#with-anchor">Guides</a>',
-        '<a href="./one-level/raw/">Raw</a>',
-        '<a href="template/">Template</a>',
-        '<img src="./images/my-img.svg" alt="my-img">',
-        '<img src="/images/my-img.svg" alt="absolute-img"></p>',
-        '<div>',
-        '  <a href="./">Root</a>',
-        '  <a href="guides/#with-anchor">Guides</a>',
-        '  <a href="./one-level/raw/">Raw</a>',
-        '  <a href="template/">Template</a>',
-        '  <img src="./images/my-img.svg" alt="my-img">',
-        '  <img src="/images/my-img.svg" alt="absolute-img">',
-        '  <picture>',
-        '    <source media="(min-width:465px)" srcset="./images/picture-min-465.jpg">',
-        '    <img src="./images/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
-        '  </picture>',
-        '</div>',
-      ].join('\n'),
-    );
-  });
-
   it('smoke test for link checking', async () => {
     await expectThrowsAsync(() => executeLint('e2e-fixtures/lint-links/rocket.config.js'), {
       errorMatch: /Found 1 missing reference targets/,

packages/cli/test-node/computed-config-fixtures/image-link/docs/index.md

@@ -2,14 +2,16 @@
 [Guides](./guides.md#with-anchor)
 [Raw](./one-level/raw.html)
 [Template](./template.njk)
+[EndingIndex](./rules/tabindex.md)
 ![my-img](./images/my-img.svg)
 ![absolute-img](/images/my-img.svg)
 
 <div>
   <a href="./">Root</a>
-  <a href="./guides.md#with-anchor">Guides</a>
-  <a href="./one-level/raw.html">Raw</a>
+  👇<a href="./guides.md#with-anchor">Guides</a>
+  👉 <a href="./one-level/raw.html">Raw</a>
   <a href="./template.njk">Template</a>
+  <a href="./rules/tabindex.md">EndingIndex</a>
   <img src="./images/my-img.svg" alt="my-img">
   <img src="/images/my-img.svg" alt="absolute-img">
   <picture>

packages/cli/test-node/computed-config-fixtures/setup/addPlugin.rocket.config.js

@@ -0,0 +1,8 @@
+import { addPlugin } from 'plugins-manager';
+
+/** @type {Partial<import("../../../types/main").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [addPlugin({ name: 'test', plugin: () => 'test-value' })],
+};
+
+export default config;

packages/cli/test-node/computed-config-fixtures/setup/docs/_includes/layout.njk

@@ -0,0 +1 @@
+{{ test }}

packages/cli/test-node/computed-config-fixtures/social-images-override/docs/.eleventyignore

@@ -0,0 +1 @@
+**/*.njk

packages/cli/test-node/computed-config-fixtures/social-images-override/docs/guides/index.md

@@ -0,0 +1 @@
+# Guides

packages/cli/test-node/computed-config-fixtures/social-images-override/rocket.config.js

@@ -0,0 +1,22 @@
+import { adjustPluginOptions } from 'plugins-manager';
+
+/** @type {Partial<import("../../../types/main").RocketCliOptions>} */
+const config = {
+  setupEleventyComputedConfig: [
+    adjustPluginOptions('socialMediaImage', {
+      createSocialImageSvg: async () => {
+        return `
+          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 630">
+            <defs></defs>
+            <rect width="100%" height="100%" fill="#fff" />
+            <text x="70" y="200" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="80">
+              Hard Coded Title
+            </text>
+          </svg>
+        `;
+      },
+    }),
+  ],
+};
+
+export default config;

packages/cli/test-node/computed-config-fixtures/social-images/docs/.eleventyignore

@@ -0,0 +1 @@
+**/*.njk

packages/cli/test-node/computed-config-fixtures/social-images/docs/_includes/layout.njk

@@ -0,0 +1 @@
+{{ socialMediaImage }}

packages/cli/test-node/computed-config-fixtures/social-images/docs/guides/first-pages/getting-started.md

@@ -0,0 +1 @@
+# First Pages >> Getting Started

packages/cli/test-node/computed-config-fixtures/social-images/docs/guides/index.11tydata.cjs

@@ -0,0 +1,12 @@
+const { createSocialImage } = require('@rocket/cli');
+
+module.exports = async function () {
+  const socialMediaImage = await createSocialImage({
+    title: 'Rocket Guides',
+    subTitle: 'Lerning how to',
+    subTitle2: 'build a rocket site.',
+  });
+  return {
+    socialMediaImage,
+  };
+};

packages/cli/test-node/computed-config-fixtures/social-images/docs/guides/index.md

@@ -0,0 +1 @@
+# Guides

packages/cli/test-node/computed-config-fixtures/social-images/docs/index.11tydata.cjs

@@ -0,0 +1,43 @@
+const { createSocialImage } = require('@rocket/cli');
+
+module.exports = async function () {
+  const socialMediaImage = await createSocialImage({
+    title: 'Rocket',
+    subTitle: 'Static sites with a',
+    subTitle2: 'sprinkle of JavaScript.',
+    footer: 'A Modern Web Product',
+    createSocialImageSvg: async ({
+      title = '',
+      subTitle = '',
+      subTitle2 = '',
+      footer = '',
+      logo = '',
+    }) => {
+      let svgStr = `
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1200 630">
+          <defs></defs>
+          <rect width="100%" height="100%" fill="#ddd" />
+          <circle cx="1000" cy="230" r="530" fill="#efefef"></circle>
+          <rect width="100%" height="100%" style="fill:none; stroke-width:20; stroke:red;" />
+          <g transform="matrix(0.6, 0, 0, 0.6, 580, 100)">${logo}</g>
+          <text x="70" y="200" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="80">
+            ${title}
+          </text>
+          <text x="70" y="320" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="60">
+            ${subTitle}
+          </text>
+          <text x="70" y="420" font-family="'Bitstream Vera Sans','Helvetica',sans-serif" font-weight="700" font-size="60">
+            ${subTitle2}
+          </text>
+          <text x="70" y="560" fill="gray" font-size="40">
+            ${footer}
+          </text>
+        </svg>
+      `;
+      return svgStr;
+    },
+  });
+  return {
+    socialMediaImage,
+  };
+};

packages/cli/test-node/computed-config-fixtures/social-images/docs/index.md

@@ -0,0 +1 @@
+# Rocket

packages/cli/test-node/e2e-fixtures/social-images/docs/index.11tydata.cjs

@@ -1,12 +0,0 @@
-const { createPageSocialImage } = require('@rocket/cli');
-
-module.exports = async function () {
-  const socialMediaImage = await createPageSocialImage({
-    title: 'Rocket',
-    subTitle: 'Static sites with',
-    subTitle2: 'a sprinkle of JavaScript.',
-  });
-  return {
-    socialMediaImage,
-  };
-};

packages/cli/test-node/helpers.js

@@ -0,0 +1,91 @@
+import chai from 'chai';
+import { RocketCli } from '../src/RocketCli.js';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs-extra';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const { expect } = chai;
+
+/**
+ * @param {function} method
+ * @param {string} errorMessage
+ */
+export async function expectThrowsAsync(method, { errorMatch, errorMessage } = {}) {
+  let error = null;
+  try {
+    await method();
+  } catch (err) {
+    error = err;
+  }
+  expect(error).to.be.an('Error', 'No error was thrown');
+  if (errorMatch) {
+    expect(error.message).to.match(errorMatch);
+  }
+  if (errorMessage) {
+    expect(error.message).to.equal(errorMessage);
+  }
+}
+
+export async function readOutput(
+  cli,
+  fileName,
+  {
+    stripServiceWorker = false,
+    stripToBody = false,
+    stripStartEndWhitespace = true,
+    type = 'build',
+  } = {},
+) {
+  const outputDir = type === 'build' ? cli.config.outputDir : cli.config.outputDevDir;
+  let text = await fs.promises.readFile(path.join(outputDir, fileName));
+  text = text.toString();
+  if (stripToBody) {
+    const bodyOpenTagEnd = text.indexOf('>', text.indexOf('<body') + 1) + 1;
+    const bodyCloseTagStart = text.indexOf('</body>');
+    text = text.substring(bodyOpenTagEnd, bodyCloseTagStart);
+  }
+  if (stripServiceWorker) {
+    const scriptOpenTagEnd = text.indexOf('<script inject-service-worker');
+    const scriptCloseTagStart = text.indexOf('</script>', scriptOpenTagEnd) + 9;
+    text = text.substring(0, scriptOpenTagEnd) + text.substring(scriptCloseTagStart);
+  }
+  if (stripStartEndWhitespace) {
+    text = text.trim();
+  }
+  return text;
+}
+
+export async function readStartOutput(cli, fileName, options = {}) {
+  options.type = 'start';
+  return readOutput(cli, fileName, options);
+}
+
+export async function execute(cli, configFileDir) {
+  await cli.setup();
+  cli.config.outputDevDir = path.join(configFileDir, '__output-dev');
+  cli.config.devServer.open = false;
+  cli.config.watch = false;
+  cli.config.outputDir = path.join(configFileDir, '__output');
+  await cli.run();
+  return cli;
+}
+
+export async function executeStart(pathToConfig) {
+  const configFile = path.join(__dirname, pathToConfig.split('/').join(path.sep));
+  const cli = new RocketCli({
+    argv: ['start', '--config-file', configFile],
+  });
+  await execute(cli, path.dirname(configFile));
+  return cli;
+}
+
+export async function executeLint(pathToConfig) {
+  const configFile = path.join(__dirname, pathToConfig.split('/').join(path.sep));
+  const cli = new RocketCli({
+    argv: ['lint', '--config-file', configFile],
+  });
+  await execute(cli, path.dirname(configFile));
+  return cli;
+}

packages/cli/test-node/normalizeConfig.test.js

@@ -37,6 +37,7 @@ describe('normalizeConfig', () => {
       setupDevAndBuildPlugins: [],
       setupDevPlugins: [],
       setupEleventyPlugins: [],
+      setupEleventyComputedConfig: [],
       setupCliPlugins: [],
       presets: [],
       plugins: [
@@ -71,6 +72,7 @@ describe('normalizeConfig', () => {
       setupDevPlugins: [],
       setupEleventyPlugins: [],
       setupCliPlugins: [],
+      setupEleventyComputedConfig: [],
       presets: [],
       plugins: [
         { commands: ['start'] },
@@ -101,6 +103,7 @@ describe('normalizeConfig', () => {
       setupDevPlugins: [],
       setupEleventyPlugins: [],
       setupCliPlugins: [],
+      setupEleventyComputedConfig: [],
       presets: [],
       plugins: [
         { commands: ['start'] },
@@ -134,6 +137,7 @@ describe('normalizeConfig', () => {
       setupDevPlugins: [],
       setupEleventyPlugins: [],
       setupCliPlugins: [],
+      setupEleventyComputedConfig: [],
       presets: [],
       plugins: [
         { commands: ['start'] },

packages/cli/types/main.d.ts

@@ -10,6 +10,7 @@ export interface RocketPreset {
   setupDevPlugins: function[];
   setupCliPlugins: function[];
   setupEleventyPlugins: function[];
+  setupEleventyComputedConfig: function[];
 }
 
 export interface RocketCliOptions {
@@ -28,6 +29,7 @@ export interface RocketCliOptions {
   setupDevPlugins: function[];
   setupCliPlugins: function[];
   setupEleventyPlugins: function[];
+  setupEleventyComputedConfig: function[];
 
   // advanced
   devServer: DevServerConfig;

yarn.lock

@@ -8664,6 +8664,11 @@ uri-js@^4.2.2:
   dependencies:
     punycode "^2.1.0"
 
+utf8@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/utf8/-/utf8-3.0.0.tgz#f052eed1364d696e769ef058b183df88c87f69d1"
+  integrity sha512-E8VjFIQ/TyQgp+TZfS6l8yp/xWppSAHzidGiRrqe4bK4XP9pTRyKFgGJpO3SN7zdX4DeomTrwaseCHovfpFcqQ==
+
 util-deprecate@^1.0.1, util-deprecate@~1.0.1:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf"