Compare commits
13 Commits
@rocket/cl
...
@rocket/cl
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ffd06fcee9 | ||
|
|
0eb507d7ef | ||
|
|
45cd7206f1 | ||
|
|
eb74110dd8 | ||
|
|
517c7780ab | ||
|
|
e4852db673 | ||
|
|
c6c564ede2 | ||
|
|
a498a5da44 | ||
|
|
eb6a23dc6a | ||
|
|
23027bb684 | ||
|
|
cd22231806 | ||
|
|
b1f61c7759 | ||
|
|
741f695106 |
@@ -35,6 +35,9 @@ export default {
|
|||||||
// add a plugin to eleventy (e.g. a filter packs)
|
// add a plugin to eleventy (e.g. a filter packs)
|
||||||
setupEleventyPlugins: [],
|
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")
|
// add a plugin to the cli (e.g. a new command like "rocket my-command")
|
||||||
setupCliPlugins: [],
|
setupCliPlugins: [],
|
||||||
};
|
};
|
||||||
|
|||||||
41
docs/docs/configuration/setupEleventyComputedConfig.md
Normal file
@@ -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 },
|
||||||
|
];
|
||||||
|
```
|
||||||
@@ -22,7 +22,7 @@ module.exports = function (eleventyConfig) {
|
|||||||
|
|
||||||
By providing a `setupUnifiedPlugins` function as an option to `eleventy-plugin-mdjs` you can set options for all unified/remark plugins.
|
By providing a `setupUnifiedPlugins` function as an option to `eleventy-plugin-mdjs` you can set options for all unified/remark plugins.
|
||||||
|
|
||||||
We do use [plugins-manager](../plugins-manager/overview.md).
|
We do use [plugins-manager](../tools/plugins-manager.md).
|
||||||
|
|
||||||
This example adds a CSS class to the `htmlHeading` plugin so heading links can be selected in CSS.
|
This example adds a CSS class to the `htmlHeading` plugin so heading links can be selected in CSS.
|
||||||
|
|
||||||
|
|||||||
38
docs/docs/tools/check-html-links.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# Tools >> Check Html Links ||30
|
||||||
|
|
||||||
|
A fast checker for broken links/references in html.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Checks all html files for broken local links/references (in href, src, srcset)
|
||||||
|
- Focuses on the broken reference targets and groups references to it
|
||||||
|
- Fast (can process 500-1000 documents in ~2-3 seconds)
|
||||||
|
- Has only 3 dependencies (and 19 in the full tree)
|
||||||
|
- Uses [sax-wasm](https://github.com/justinwilaby/sax-wasm) for parsing streamed html
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```
|
||||||
|
npm i -D check-html-links
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
npx check-html-links _site
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example Output
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Comparision
|
||||||
|
|
||||||
|
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 | Times | 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 | - |
|
||||||
BIN
docs/docs/tools/images/check-html-links-screenshot.png
Normal file
|
After Width: | Height: | Size: 214 KiB |
@@ -1,4 +1,4 @@
|
|||||||
# Tools >> Rollup Config
|
# Tools >> Rollup Config ||20
|
||||||
|
|
||||||
Rollup configuration to help you get started building modern web applications.
|
Rollup configuration to help you get started building modern web applications.
|
||||||
You write modern javascript using the latest browser-features, rollup will optimize your code for production and ensure it runs on all supported browsers.
|
You write modern javascript using the latest browser-features, rollup will optimize your code for production and ensure it runs on all supported browsers.
|
||||||
@@ -52,7 +52,7 @@ You write modern javascript using the latest browser-features, rollup will optim
|
|||||||
|
|
||||||
Our config sets you up with good defaults for most projects. Additionally you can add more plugins and adjust predefined plugins or even remove them if needed.
|
Our config sets you up with good defaults for most projects. Additionally you can add more plugins and adjust predefined plugins or even remove them if needed.
|
||||||
|
|
||||||
We use the [plugins-manager](../plugins-manager/overview.md) for it.
|
We use the [plugins-manager](./plugins-manager.md) for it.
|
||||||
|
|
||||||
### Customizing the babel config
|
### Customizing the babel config
|
||||||
|
|
||||||
@@ -83,7 +83,7 @@ SPA and MPA plugins:
|
|||||||
- [polyfills-loader](https://modern-web.dev/docs/building/rollup-plugin-polyfills-loader/)
|
- [polyfills-loader](https://modern-web.dev/docs/building/rollup-plugin-polyfills-loader/)
|
||||||
- [workbox](https://www.npmjs.com/package/rollup-plugin-workbox)
|
- [workbox](https://www.npmjs.com/package/rollup-plugin-workbox)
|
||||||
|
|
||||||
You can customize options for these plugins by using [adjustPluginOptions](../plugins-manager/overview.md#adjusting-plugin-options).
|
You can customize options for these plugins by using [adjustPluginOptions](./plugins-manager.md#adjusting-plugin-options).
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import { createSpaConfig } from '@rocket/building-rollup';
|
import { createSpaConfig } from '@rocket/building-rollup';
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ It will look like this but with your logo
|
|||||||
|
|
||||||
There are multiple ways you can modify it.
|
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
|
## Setting it via frontMatter
|
||||||
|
|
||||||
You can create your own image and link it with something like this
|
You can create your own image and link it with something like this
|
||||||
@@ -25,20 +27,103 @@ 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`.
|
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
|
```js
|
||||||
const { createPageSocialImage } = require('@rocket/cli');
|
const { createSocialImage } = require('@rocket/cli');
|
||||||
|
|
||||||
module.exports = async function () {
|
module.exports = async function () {
|
||||||
const socialMediaImage = await createPageSocialImage({
|
const socialMediaImage = await createSocialImage({
|
||||||
title: 'Learning Rocket',
|
title: 'Learning Rocket',
|
||||||
subTitle: 'Have a website',
|
subTitle: 'Have a website',
|
||||||
subTitle2: 'in 5 Minutes',
|
subTitle2: 'in 5 Minutes',
|
||||||
footer: 'Rocket Guides',
|
footer: 'Rocket Guides',
|
||||||
|
// you can also override the svg only for this page by providing
|
||||||
|
// createSocialImageSvg: async () => '<svg>...</svg>'
|
||||||
});
|
});
|
||||||
return {
|
return {
|
||||||
socialMediaImage,
|
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">
|
||||||
|
<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;
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
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 %}
|
||||||
|
```
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
const { createPageSocialImage } = require('@rocket/cli');
|
const { createSocialImage } = require('@rocket/cli');
|
||||||
|
|
||||||
module.exports = async function () {
|
module.exports = async function () {
|
||||||
const socialMediaImage = await createPageSocialImage({
|
const socialMediaImage = await createSocialImage({
|
||||||
title: 'Learning Rocket',
|
title: 'Learning Rocket',
|
||||||
subTitle: 'Have a website',
|
subTitle: 'Have a website',
|
||||||
subTitle2: 'in 5 Minutes',
|
subTitle2: 'in 5 Minutes',
|
||||||
|
|||||||
@@ -1,7 +1,106 @@
|
|||||||
# Presets >> Create your own || 90
|
# 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()],
|
||||||
|
};
|
||||||
|
```
|
||||||
|
````
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
const { createPageSocialImage } = require('@rocket/cli');
|
const { createSocialImage } = require('@rocket/cli');
|
||||||
|
|
||||||
module.exports = async function () {
|
module.exports = async function () {
|
||||||
const socialMediaImage = await createPageSocialImage({
|
const socialMediaImage = await createSocialImage({
|
||||||
title: 'Rocket',
|
title: 'Rocket',
|
||||||
subTitle: 'Static sites with',
|
subTitle: 'Static sites with',
|
||||||
subTitle2: 'a sprinkle of JavaScript.',
|
subTitle2: 'a sprinkle of JavaScript.',
|
||||||
|
|||||||
@@ -21,6 +21,7 @@
|
|||||||
"lint": "run-p lint:*",
|
"lint": "run-p lint:*",
|
||||||
"lint:eslint": "eslint --ext .ts,.js,.mjs,.cjs .",
|
"lint:eslint": "eslint --ext .ts,.js,.mjs,.cjs .",
|
||||||
"lint:prettier": "node node_modules/prettier/bin-prettier.js \"**/*.{ts,js,mjs,cjs,md}\" --check --ignore-path .eslintignore",
|
"lint:prettier": "node node_modules/prettier/bin-prettier.js \"**/*.{ts,js,mjs,cjs,md}\" --check --ignore-path .eslintignore",
|
||||||
|
"lint:rocket": "rocket lint",
|
||||||
"lint:types": "npm run types",
|
"lint:types": "npm run types",
|
||||||
"lint:versions": "node scripts/lint-versions.js",
|
"lint:versions": "node scripts/lint-versions.js",
|
||||||
"postinstall": "npm run setup",
|
"postinstall": "npm run setup",
|
||||||
|
|||||||
13
packages/check-html-links/CHANGELOG.md
Normal file
@@ -0,0 +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
|
||||||
28
packages/check-html-links/README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Check Html Links
|
||||||
|
|
||||||
|
A fast checker for broken links/references in html.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```
|
||||||
|
npm i -D check-html-links
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
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/).
|
||||||
|
|
||||||
|
## 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 | Times | 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 | - |
|
||||||
2
packages/check-html-links/index.js
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
export { validateFolder } from './src/validateFolder.js';
|
||||||
|
export { formatErrors } from './src/formatErrors.js';
|
||||||
43
packages/check-html-links/package.json
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
{
|
||||||
|
"name": "check-html-links",
|
||||||
|
"version": "0.1.1",
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
|
},
|
||||||
|
"description": "A fast low dependency checker of html links/references",
|
||||||
|
"license": "MIT",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/modernweb-dev/rocket.git",
|
||||||
|
"directory": "packages/check-html-links"
|
||||||
|
},
|
||||||
|
"author": "Modern Web <hello@modern-web.dev> (https://modern-web.dev/)",
|
||||||
|
"homepage": "https://rocket.modern-web.dev/docs/tools/check-html-links/",
|
||||||
|
"bin": {
|
||||||
|
"check-html-links": "src/cli.js"
|
||||||
|
},
|
||||||
|
"type": "module",
|
||||||
|
"exports": {
|
||||||
|
".": "./index.js"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"test": "mocha --timeout 5000 test-node/**/*.test.{js,cjs} test-node/*.test.{js,cjs}",
|
||||||
|
"test:watch": "onchange 'src/**/*.{js,cjs}' 'test-node/**/*.{js,cjs}' -- npm test",
|
||||||
|
"types:copy": "copyfiles \"./types/**/*.d.ts\" dist-types/"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"*.js",
|
||||||
|
"dist",
|
||||||
|
"dist-types",
|
||||||
|
"src"
|
||||||
|
],
|
||||||
|
"dependencies": {
|
||||||
|
"chalk": "^4.0.0",
|
||||||
|
"glob": "^7.0.0",
|
||||||
|
"sax-wasm": "^2.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/glob": "^7.0.0"
|
||||||
|
},
|
||||||
|
"types": "dist-types/index.d.ts"
|
||||||
|
}
|
||||||
55
packages/check-html-links/src/cli.js
Executable file
@@ -0,0 +1,55 @@
|
|||||||
|
#!/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';
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
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 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 %ds %dms)`,
|
||||||
|
performance[0],
|
||||||
|
performance[1] / 1000000,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
main();
|
||||||
46
packages/check-html-links/src/formatErrors.js
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
import path from 'path';
|
||||||
|
import chalk from 'chalk';
|
||||||
|
|
||||||
|
/** @typedef {import('../types/main').Error} Error */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Error[]} errors
|
||||||
|
* @param {*} relativeFrom
|
||||||
|
*/
|
||||||
|
export function formatErrors(errors, relativeFrom = process.cwd()) {
|
||||||
|
let output = [];
|
||||||
|
let number = 0;
|
||||||
|
for (const error of errors) {
|
||||||
|
number += 1;
|
||||||
|
const filePath = path.relative(relativeFrom, error.filePath);
|
||||||
|
if (error.onlyAnchorMissing === true) {
|
||||||
|
output.push(
|
||||||
|
`${number}. missing ${chalk.red.bold(
|
||||||
|
`id="${error.usage[0].anchor}"`,
|
||||||
|
)} in ${chalk.cyanBright(filePath)}`,
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
const firstAttribute = error.usage[0].attribute;
|
||||||
|
const title =
|
||||||
|
firstAttribute === 'src' || firstAttribute === 'srcset' ? 'file' : 'reference target';
|
||||||
|
|
||||||
|
output.push(`${number}. missing ${title} ${chalk.red.bold(filePath)}`);
|
||||||
|
}
|
||||||
|
const usageLength = error.usage.length;
|
||||||
|
|
||||||
|
for (let i = 0; i < 3 && i < usageLength; i += 1) {
|
||||||
|
const usage = error.usage[i];
|
||||||
|
const usagePath = path.relative(relativeFrom, usage.file);
|
||||||
|
const clickAbleLink = chalk.cyanBright(`${usagePath}:${usage.line + 1}:${usage.character}`);
|
||||||
|
const attributeStart = chalk.gray(`${usage.attribute}="`);
|
||||||
|
const attributeEnd = chalk.gray('"');
|
||||||
|
output.push(` from ${clickAbleLink} via ${attributeStart}${usage.value}${attributeEnd}`);
|
||||||
|
}
|
||||||
|
if (usageLength > 3) {
|
||||||
|
const more = chalk.red((usageLength - 3).toString());
|
||||||
|
output.push(` ... ${more} more references to this target`);
|
||||||
|
}
|
||||||
|
output.push('');
|
||||||
|
}
|
||||||
|
return output.join('\n');
|
||||||
|
}
|
||||||
35
packages/check-html-links/src/listFiles.js
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import fs from 'fs';
|
||||||
|
import path from 'path';
|
||||||
|
|
||||||
|
import glob from 'glob';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lists all files using the specified glob, starting from the given root directory.
|
||||||
|
*
|
||||||
|
* Will return all matching file paths fully resolved.
|
||||||
|
*
|
||||||
|
* @param {string} fromGlob
|
||||||
|
* @param {string} rootDir
|
||||||
|
*/
|
||||||
|
export function listFiles(fromGlob, rootDir) {
|
||||||
|
return new Promise(resolve => {
|
||||||
|
glob(
|
||||||
|
fromGlob,
|
||||||
|
{ cwd: rootDir },
|
||||||
|
/**
|
||||||
|
* @param {Error | null} er
|
||||||
|
* @param {string[]} files
|
||||||
|
*/
|
||||||
|
(er, files) => {
|
||||||
|
// remember, each filepath returned is relative to rootDir
|
||||||
|
resolve(
|
||||||
|
files
|
||||||
|
// fully resolve the filename relative to rootDir
|
||||||
|
.map(filePath => path.resolve(rootDir, filePath))
|
||||||
|
// filter out directories
|
||||||
|
.filter(filePath => !fs.lstatSync(filePath).isDirectory()),
|
||||||
|
);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
289
packages/check-html-links/src/validateFolder.js
Normal file
@@ -0,0 +1,289 @@
|
|||||||
|
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
||||||
|
import fs from 'fs';
|
||||||
|
import saxWasm from 'sax-wasm';
|
||||||
|
import { createRequire } from 'module';
|
||||||
|
|
||||||
|
import { listFiles } from './listFiles.js';
|
||||||
|
import path from 'path';
|
||||||
|
|
||||||
|
/** @typedef {import('../types/main').Link} Link */
|
||||||
|
/** @typedef {import('../types/main').LocalFile} LocalFile */
|
||||||
|
/** @typedef {import('../types/main').Usage} Usage */
|
||||||
|
/** @typedef {import('../types/main').Error} Error */
|
||||||
|
/** @typedef {import('sax-wasm').Attribute} Attribute */
|
||||||
|
|
||||||
|
const require = createRequire(import.meta.url);
|
||||||
|
const { SaxEventType, SAXParser } = saxWasm;
|
||||||
|
|
||||||
|
const saxPath = require.resolve('sax-wasm/lib/sax-wasm.wasm');
|
||||||
|
const saxWasmBuffer = fs.readFileSync(saxPath);
|
||||||
|
const parserReferences = new SAXParser(SaxEventType.Attribute);
|
||||||
|
const parserIds = new SAXParser(SaxEventType.Attribute /*, { highWaterMark: 256 * 1024 } */);
|
||||||
|
|
||||||
|
/** @type {Error[]} */
|
||||||
|
let checkLocalFiles = [];
|
||||||
|
|
||||||
|
/** @type {Error[]} */
|
||||||
|
let errors = [];
|
||||||
|
|
||||||
|
/** @type {Map<string, string[]>} */
|
||||||
|
let idCache = new Map();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} htmlFilePath
|
||||||
|
*/
|
||||||
|
function extractReferences(htmlFilePath) {
|
||||||
|
/** @type {Link[]} */
|
||||||
|
const links = [];
|
||||||
|
/** @type {string[]} */
|
||||||
|
const ids = [];
|
||||||
|
parserReferences.eventHandler = (ev, _data) => {
|
||||||
|
if (ev === SaxEventType.Attribute) {
|
||||||
|
const data = /** @type {Attribute} */ (/** @type {any} */ (_data));
|
||||||
|
const attributeName = data.name.toString();
|
||||||
|
const value = data.value.toString();
|
||||||
|
const entry = {
|
||||||
|
attribute: attributeName,
|
||||||
|
value,
|
||||||
|
htmlFilePath,
|
||||||
|
...data.value.start,
|
||||||
|
};
|
||||||
|
if (attributeName === 'href' || attributeName === 'src') {
|
||||||
|
links.push(entry);
|
||||||
|
}
|
||||||
|
if (attributeName === 'srcset') {
|
||||||
|
if (value.includes(',')) {
|
||||||
|
const srcsets = value.split(',').map(el => el.trim());
|
||||||
|
for (const srcset of srcsets) {
|
||||||
|
if (srcset.includes(' ')) {
|
||||||
|
const srcsetParts = srcset.split(' ');
|
||||||
|
links.push({ ...entry, value: srcsetParts[0] });
|
||||||
|
} else {
|
||||||
|
links.push({ ...entry, value: srcset });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if (value.includes(' ')) {
|
||||||
|
const srcsetParts = value.split(' ');
|
||||||
|
links.push({ ...entry, value: srcsetParts[0] });
|
||||||
|
} else {
|
||||||
|
links.push(entry);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (attributeName === 'id') {
|
||||||
|
ids.push(value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return new Promise(resolve => {
|
||||||
|
const readable = fs.createReadStream(htmlFilePath);
|
||||||
|
readable.on('data', chunk => {
|
||||||
|
// @ts-expect-error
|
||||||
|
parserReferences.write(chunk);
|
||||||
|
});
|
||||||
|
readable.on('end', () => {
|
||||||
|
parserReferences.end();
|
||||||
|
idCache.set(htmlFilePath, ids);
|
||||||
|
resolve({ links });
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} filePath
|
||||||
|
* @param {string} id
|
||||||
|
*/
|
||||||
|
function idExists(filePath, id) {
|
||||||
|
if (idCache.has(filePath)) {
|
||||||
|
const cachedIds = idCache.get(filePath);
|
||||||
|
// return cachedIds.includes(id);
|
||||||
|
return new Promise(resolve => resolve(cachedIds?.includes(id)));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @type {string[]} */
|
||||||
|
const ids = [];
|
||||||
|
parserIds.eventHandler = (ev, _data) => {
|
||||||
|
const data = /** @type {Attribute} */ (/** @type {any} */ (_data));
|
||||||
|
if (ev === SaxEventType.Attribute) {
|
||||||
|
if (data.name.toString() === 'id') {
|
||||||
|
ids.push(data.value.toString());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return new Promise(resolve => {
|
||||||
|
const readable = fs.createReadStream(filePath);
|
||||||
|
readable.on('data', chunk => {
|
||||||
|
// @ts-expect-error
|
||||||
|
parserIds.write(chunk);
|
||||||
|
});
|
||||||
|
readable.on('end', () => {
|
||||||
|
parserIds.end();
|
||||||
|
idCache.set(filePath, ids);
|
||||||
|
resolve(ids.includes(id));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} filePath
|
||||||
|
* @param {string} anchor
|
||||||
|
* @param {Usage} usageObj
|
||||||
|
*/
|
||||||
|
function addLocalFile(filePath, anchor, usageObj) {
|
||||||
|
const foundIndex = checkLocalFiles.findIndex(item => {
|
||||||
|
return item.filePath === filePath;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (foundIndex === -1) {
|
||||||
|
checkLocalFiles.push({
|
||||||
|
filePath,
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [usageObj],
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
checkLocalFiles[foundIndex].usage.push(usageObj);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} inValue
|
||||||
|
*/
|
||||||
|
function getValueAndAnchor(inValue) {
|
||||||
|
let value = inValue.replace(/&#/g, '--__check-html-links__--');
|
||||||
|
let anchor = '';
|
||||||
|
|
||||||
|
if (value.includes('#')) {
|
||||||
|
[value, anchor] = value.split('#');
|
||||||
|
}
|
||||||
|
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, '&#');
|
||||||
|
value = value.trim();
|
||||||
|
anchor = anchor.trim();
|
||||||
|
|
||||||
|
return {
|
||||||
|
value,
|
||||||
|
anchor,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param {Link[]} links
|
||||||
|
* @param {object} options
|
||||||
|
* @param {string} options.htmlFilePath
|
||||||
|
* @param {string} options.rootDir
|
||||||
|
*/
|
||||||
|
async function resolveLinks(links, { htmlFilePath, rootDir }) {
|
||||||
|
for (const hrefObj of links) {
|
||||||
|
const { value, anchor } = getValueAndAnchor(hrefObj.value);
|
||||||
|
|
||||||
|
const usageObj = {
|
||||||
|
attribute: hrefObj.attribute,
|
||||||
|
value: hrefObj.value,
|
||||||
|
file: htmlFilePath,
|
||||||
|
line: hrefObj.line,
|
||||||
|
character: hrefObj.character,
|
||||||
|
anchor,
|
||||||
|
};
|
||||||
|
|
||||||
|
let valueFile = value.endsWith('/') ? path.join(value, 'index.html') : value;
|
||||||
|
|
||||||
|
if (value.includes('mailto:')) {
|
||||||
|
// ignore for now - could add a check to validate if the email address is valid
|
||||||
|
} else if (valueFile === '' && anchor !== '') {
|
||||||
|
addLocalFile(htmlFilePath, anchor, usageObj);
|
||||||
|
} else if (value.startsWith('//') || value.startsWith('http')) {
|
||||||
|
// TODO: handle external urls
|
||||||
|
// external url - we do not handle that (yet)
|
||||||
|
} else if (value.startsWith('/')) {
|
||||||
|
const filePath = path.join(rootDir, valueFile);
|
||||||
|
addLocalFile(filePath, anchor, usageObj);
|
||||||
|
} else if (value === '' && anchor === '') {
|
||||||
|
// no need to check it
|
||||||
|
} else {
|
||||||
|
const filePath = path.join(path.dirname(htmlFilePath), valueFile);
|
||||||
|
addLocalFile(filePath, anchor, usageObj);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return { checkLocalFiles: [...checkLocalFiles] };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @param {Error[]} checkLocalFiles
|
||||||
|
*/
|
||||||
|
async function validateLocalFiles(checkLocalFiles) {
|
||||||
|
for (const localFileObj of checkLocalFiles) {
|
||||||
|
if (
|
||||||
|
!fs.existsSync(localFileObj.filePath) ||
|
||||||
|
fs.lstatSync(localFileObj.filePath).isDirectory()
|
||||||
|
) {
|
||||||
|
errors.push(localFileObj);
|
||||||
|
} else {
|
||||||
|
for (let i = 0; i < localFileObj.usage.length; i += 1) {
|
||||||
|
const usage = localFileObj.usage[i];
|
||||||
|
if (usage.anchor === '') {
|
||||||
|
localFileObj.usage.splice(i, 1);
|
||||||
|
i -= 1;
|
||||||
|
} else {
|
||||||
|
const isValidAnchor = await idExists(localFileObj.filePath, usage.anchor);
|
||||||
|
if (isValidAnchor) {
|
||||||
|
localFileObj.usage.splice(i, 1);
|
||||||
|
i -= 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (localFileObj.usage.length > 0) {
|
||||||
|
if (localFileObj.usage.length === 1 && localFileObj.usage[0].anchor) {
|
||||||
|
localFileObj.onlyAnchorMissing = true;
|
||||||
|
}
|
||||||
|
errors.push(localFileObj);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return errors;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string[]} files
|
||||||
|
* @param {string} rootDir
|
||||||
|
*/
|
||||||
|
export async function validateFiles(files, rootDir) {
|
||||||
|
await parserReferences.prepareWasm(saxWasmBuffer);
|
||||||
|
await parserIds.prepareWasm(saxWasmBuffer);
|
||||||
|
|
||||||
|
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: errors, numberLinks: numberLinks };
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {string} inRootDir
|
||||||
|
*/
|
||||||
|
export async function validateFolder(inRootDir) {
|
||||||
|
const rootDir = path.resolve(inRootDir);
|
||||||
|
const files = await listFiles('**/*.html', rootDir);
|
||||||
|
const { errors } = await validateFiles(files, rootDir);
|
||||||
|
return errors;
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
<img src="/missing.png" alt="" />
|
||||||
|
<img src="./missing.png" alt="" />
|
||||||
|
<img src="/absolute/missing.png" alt="" />
|
||||||
|
<img src="./relative/missing.png" alt="" />
|
||||||
|
|
||||||
|
<!-- valid -->
|
||||||
|
<img src="/empty.png" alt="" />
|
||||||
|
<img src="./empty.png" alt="" />
|
||||||
|
<img src="./empty.png " alt="" />
|
||||||
|
<img src=" ./empty.png " alt="" />
|
||||||
|
<img src="./empty.png?data=in&query=params" alt="" />
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
<a href="./page.html"></a>
|
||||||
|
<a href="./page.html#first-headline"></a>
|
||||||
|
<a href="./page.html#missing-headline"></a>
|
||||||
|
<a href="./missing-page.html#missing-headline"></a>
|
||||||
|
<a href="#local"></a>
|
||||||
|
<a href="#local-missing"></a>
|
||||||
|
|
||||||
|
<p id="local"></p>
|
||||||
|
|
||||||
|
<a href="#audit-your-angular-app's-accessibility-with-codelyzer">
|
||||||
|
Audit your Angular app's accessibility with codelyzer
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<h1 id="audit-your-angular-app's-accessibility-with-codelyzer">Audit your Angular app's accessibility with codelyzer</h1>
|
||||||
|
|
||||||
|
<a href="#local:~:text=put%20your%20labels%20above%20your%20inputs">Sign-in form best practices</a>
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<h1 id="first-headline">First Headline</h1>
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
<a href="./page/index.html"></a>
|
||||||
|
<a href="./page/#my-anchor"></a>
|
||||||
|
<a href="./missing-folder/"></a>
|
||||||
|
<a href="./missing-folder/#my-anchor"></a>
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<p id="my-anchor"></p>
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
<a href="/absolute/index.html"></a>
|
||||||
|
<a href="./relative/index.html"></a>
|
||||||
|
|
||||||
|
<!-- valid -->
|
||||||
|
<a href="./page.html"></a>
|
||||||
|
<a href=" ./page.html "></a>
|
||||||
|
<a href=" /page.html "></a>
|
||||||
|
<a href="//domain.com/something/"></a>
|
||||||
|
<a href="http://domain.com/something/"></a>
|
||||||
|
<a href="https://domain.com/something/"></a>
|
||||||
|
<a href=""></a>
|
||||||
|
<a href=":~:text=put%20your%20labels%20above%20your%20inputs">Sign-in form best practices</a>
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
<a href="/absolute-page/index.html">absolute page</a>
|
||||||
|
<a href="./relative-page/index.html">relative page</a>
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
<a href="/foo"></a>
|
||||||
|
<a href="./foo"></a>
|
||||||
|
<a href="./foo#my-anchor"></a>
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
<picture>
|
||||||
|
<source srcset="/images/empty-300.png 300w, /images/empty-600.png?data=in&query=params 600w" type="image/jpeg" sizes="(min-width: 62.5em) 25vw, (min-width: 30.625em) 50vw, 100vw">
|
||||||
|
<img src="/images/empty.png" alt="Empty" width="300" height="225">
|
||||||
|
</picture>
|
||||||
|
|
||||||
|
<picture>
|
||||||
|
<source srcset="/images/missing-300.png 300w, /images/missing-600.png 600w" type="image/jpeg" sizes="(min-width: 62.5em) 25vw, (min-width: 30.625em) 50vw, 100vw">
|
||||||
|
<img src="/images/missing.png" alt="Empty" width="300" height="225">
|
||||||
|
</picture>
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<a href="mailto:foo@bar.com"></a>
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
<a href="../price/"></a>
|
||||||
|
|
||||||
|
<img src="./images/team.png" />
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
<a href="/aboot"></a>
|
||||||
|
</footer>
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
<a href="/price/#my-teams"></a>
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
<a href="/aboot"></a>
|
||||||
|
</footer>
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
<a href="./prce"></a>
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
<a href="/aboot"></a>
|
||||||
|
</footer>
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
<footer>
|
||||||
|
<a href="/aboot"></a>
|
||||||
|
</footer>
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
<h1 id="overview"></h1>
|
||||||
|
|
||||||
|
<h2 id="teams"></h2>
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
<a href="/aboot"></a>
|
||||||
|
</footer>
|
||||||
38
packages/check-html-links/test-node/formatErrors.test.js
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
import chai from 'chai';
|
||||||
|
import chalk from 'chalk';
|
||||||
|
import { execute } from './test-helpers.js';
|
||||||
|
import { formatErrors } from 'check-html-links';
|
||||||
|
|
||||||
|
const { expect } = chai;
|
||||||
|
|
||||||
|
async function executeAndFormat(inPath) {
|
||||||
|
const { errors, cleanup } = await execute(inPath);
|
||||||
|
return formatErrors(cleanup(errors));
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('formatErrors', () => {
|
||||||
|
before(() => {
|
||||||
|
// ignore colors in tests as most CIs won't support it
|
||||||
|
chalk.level = 0;
|
||||||
|
});
|
||||||
|
|
||||||
|
it('prints a nice summery', async () => {
|
||||||
|
const result = await executeAndFormat('fixtures/test-case');
|
||||||
|
expect(result.trim().split('\n')).to.deep.equal([
|
||||||
|
'1. missing id="my-teams" in fixtures/test-case/price/index.html',
|
||||||
|
' from fixtures/test-case/history/index.html:1:9 via href="/price/#my-teams"',
|
||||||
|
'',
|
||||||
|
'2. missing file fixtures/test-case/about/images/team.png',
|
||||||
|
' from fixtures/test-case/about/index.html:3:10 via src="./images/team.png"',
|
||||||
|
'',
|
||||||
|
'3. missing reference target fixtures/test-case/aboot',
|
||||||
|
' from fixtures/test-case/about/index.html:6:11 via href="/aboot"',
|
||||||
|
' from fixtures/test-case/history/index.html:4:11 via href="/aboot"',
|
||||||
|
' from fixtures/test-case/index.html:4:11 via href="/aboot"',
|
||||||
|
' ... 2 more references to this target',
|
||||||
|
'',
|
||||||
|
'4. missing reference target fixtures/test-case/prce',
|
||||||
|
' from fixtures/test-case/index.html:1:9 via href="./prce"',
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
28
packages/check-html-links/test-node/test-helpers.js
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
import path from 'path';
|
||||||
|
import { fileURLToPath } from 'url';
|
||||||
|
|
||||||
|
import { validateFolder } from 'check-html-links';
|
||||||
|
|
||||||
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||||
|
|
||||||
|
export async function execute(inPath) {
|
||||||
|
const testDir = path.join(__dirname, inPath.split('/').join(path.sep));
|
||||||
|
const errors = await validateFolder(testDir);
|
||||||
|
return {
|
||||||
|
cleanup: items => {
|
||||||
|
const newItems = [];
|
||||||
|
for (const item of items) {
|
||||||
|
newItems.push({
|
||||||
|
...item,
|
||||||
|
filePath: path.relative(__dirname, item.filePath),
|
||||||
|
usage: item.usage.map(usageObj => ({
|
||||||
|
...usageObj,
|
||||||
|
file: path.relative(__dirname, usageObj.file),
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return newItems;
|
||||||
|
},
|
||||||
|
errors,
|
||||||
|
};
|
||||||
|
}
|
||||||
289
packages/check-html-links/test-node/validateFolder.test.js
Normal file
@@ -0,0 +1,289 @@
|
|||||||
|
import chai from 'chai';
|
||||||
|
import { execute } from './test-helpers.js';
|
||||||
|
|
||||||
|
const { expect } = chai;
|
||||||
|
|
||||||
|
describe('validateFolder', () => {
|
||||||
|
it('validates internal links', async () => {
|
||||||
|
const { errors, cleanup } = await execute('fixtures/internal-link');
|
||||||
|
expect(cleanup(errors)).to.deep.equal([
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link/absolute/index.html',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'href',
|
||||||
|
value: '/absolute/index.html',
|
||||||
|
file: 'fixtures/internal-link/index.html',
|
||||||
|
line: 0,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link/relative/index.html',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'href',
|
||||||
|
value: './relative/index.html',
|
||||||
|
file: 'fixtures/internal-link/index.html',
|
||||||
|
line: 1,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link/absolute-page/index.html',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'href',
|
||||||
|
value: '/absolute-page/index.html',
|
||||||
|
file: 'fixtures/internal-link/page.html',
|
||||||
|
line: 0,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link/relative-page/index.html',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'href',
|
||||||
|
value: './relative-page/index.html',
|
||||||
|
file: 'fixtures/internal-link/page.html',
|
||||||
|
line: 1,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('groups multiple usage of the same missing file', async () => {
|
||||||
|
const { errors, cleanup } = await execute('fixtures/internal-links-to-same-file');
|
||||||
|
expect(cleanup(errors)).to.deep.equal([
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-links-to-same-file/foo',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
attribute: 'href',
|
||||||
|
value: '/foo',
|
||||||
|
anchor: '',
|
||||||
|
file: 'fixtures/internal-links-to-same-file/index.html',
|
||||||
|
line: 0,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
attribute: 'href',
|
||||||
|
value: './foo',
|
||||||
|
anchor: '',
|
||||||
|
file: 'fixtures/internal-links-to-same-file/index.html',
|
||||||
|
line: 1,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
attribute: 'href',
|
||||||
|
value: './foo#my-anchor',
|
||||||
|
anchor: 'my-anchor',
|
||||||
|
file: 'fixtures/internal-links-to-same-file/index.html',
|
||||||
|
line: 2,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('validates that ids of anchors exist', async () => {
|
||||||
|
const { errors, cleanup } = await execute('fixtures/internal-link-anchor');
|
||||||
|
expect(cleanup(errors)).to.deep.equal([
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link-anchor/page.html',
|
||||||
|
onlyAnchorMissing: true,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
attribute: 'href',
|
||||||
|
value: './page.html#missing-headline',
|
||||||
|
anchor: 'missing-headline',
|
||||||
|
file: 'fixtures/internal-link-anchor/index.html',
|
||||||
|
line: 2,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link-anchor/missing-page.html',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
attribute: 'href',
|
||||||
|
value: './missing-page.html#missing-headline',
|
||||||
|
anchor: 'missing-headline',
|
||||||
|
file: 'fixtures/internal-link-anchor/index.html',
|
||||||
|
line: 3,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link-anchor/index.html',
|
||||||
|
onlyAnchorMissing: true,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
attribute: 'href',
|
||||||
|
value: '#local-missing',
|
||||||
|
anchor: 'local-missing',
|
||||||
|
file: 'fixtures/internal-link-anchor/index.html',
|
||||||
|
line: 5,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('can handle urls that end with a /', async () => {
|
||||||
|
const { errors, cleanup } = await execute('fixtures/internal-link-folder');
|
||||||
|
expect(cleanup(errors)).to.deep.equal([
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-link-folder/missing-folder/index.html',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'href',
|
||||||
|
value: './missing-folder/',
|
||||||
|
file: 'fixtures/internal-link-folder/index.html',
|
||||||
|
line: 2,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
anchor: 'my-anchor',
|
||||||
|
attribute: 'href',
|
||||||
|
value: './missing-folder/#my-anchor',
|
||||||
|
file: 'fixtures/internal-link-folder/index.html',
|
||||||
|
line: 3,
|
||||||
|
character: 9,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('ignores mailto links', async () => {
|
||||||
|
const { errors, cleanup } = await execute('fixtures/mailto');
|
||||||
|
expect(cleanup(errors)).to.deep.equal([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('can handle img src', async () => {
|
||||||
|
const { errors, cleanup } = await execute('fixtures/internal-images');
|
||||||
|
expect(cleanup(errors)).to.deep.equal([
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-images/missing.png',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'src',
|
||||||
|
value: '/missing.png',
|
||||||
|
file: 'fixtures/internal-images/index.html',
|
||||||
|
line: 0,
|
||||||
|
character: 10,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'src',
|
||||||
|
character: 10,
|
||||||
|
file: 'fixtures/internal-images/index.html',
|
||||||
|
line: 1,
|
||||||
|
value: './missing.png',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-images/absolute/missing.png',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'src',
|
||||||
|
character: 10,
|
||||||
|
file: 'fixtures/internal-images/index.html',
|
||||||
|
line: 2,
|
||||||
|
value: '/absolute/missing.png',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-images/relative/missing.png',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'src',
|
||||||
|
character: 10,
|
||||||
|
file: 'fixtures/internal-images/index.html',
|
||||||
|
line: 3,
|
||||||
|
value: './relative/missing.png',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('can handle picture source srcset', async () => {
|
||||||
|
const { errors, cleanup } = await execute('fixtures/internal-pictures');
|
||||||
|
expect(cleanup(errors)).to.deep.equal([
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-pictures/images/missing-300.png',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'srcset',
|
||||||
|
value: '/images/missing-300.png',
|
||||||
|
file: 'fixtures/internal-pictures/index.html',
|
||||||
|
line: 6,
|
||||||
|
character: 18,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-pictures/images/missing-600.png',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'srcset',
|
||||||
|
value: '/images/missing-600.png',
|
||||||
|
file: 'fixtures/internal-pictures/index.html',
|
||||||
|
line: 6,
|
||||||
|
character: 18,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
filePath: 'fixtures/internal-pictures/images/missing.png',
|
||||||
|
onlyAnchorMissing: false,
|
||||||
|
usage: [
|
||||||
|
{
|
||||||
|
anchor: '',
|
||||||
|
attribute: 'src',
|
||||||
|
value: '/images/missing.png',
|
||||||
|
file: 'fixtures/internal-pictures/index.html',
|
||||||
|
line: 7,
|
||||||
|
character: 12,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
});
|
||||||
24
packages/check-html-links/tsconfig.json
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
// Don't edit this file directly. It is generated by /scripts/update-package-configs.ts
|
||||||
|
|
||||||
|
{
|
||||||
|
"extends": "../../tsconfig.node-base.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"module": "ESNext",
|
||||||
|
"outDir": "./dist-types",
|
||||||
|
"rootDir": ".",
|
||||||
|
"composite": true,
|
||||||
|
"allowJs": true,
|
||||||
|
"checkJs": true,
|
||||||
|
"emitDeclarationOnly": true
|
||||||
|
},
|
||||||
|
"references": [],
|
||||||
|
"include": [
|
||||||
|
"src",
|
||||||
|
"*.js",
|
||||||
|
"types"
|
||||||
|
],
|
||||||
|
"exclude": [
|
||||||
|
"dist",
|
||||||
|
"dist-types"
|
||||||
|
]
|
||||||
|
}
|
||||||
27
packages/check-html-links/types/main.d.ts
vendored
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
export interface Link {
|
||||||
|
value: string;
|
||||||
|
attribute: string;
|
||||||
|
htmlFilePath: string;
|
||||||
|
line: number;
|
||||||
|
character: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Usage {
|
||||||
|
attribute: string;
|
||||||
|
value: string;
|
||||||
|
anchor: string;
|
||||||
|
file: string;
|
||||||
|
line: number;
|
||||||
|
character: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LocalFile {
|
||||||
|
filePath: string;
|
||||||
|
usage: Usage[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Error {
|
||||||
|
filePath: string;
|
||||||
|
onlyAnchorMissing: boolean;
|
||||||
|
usage: Usage[];
|
||||||
|
}
|
||||||
@@ -1,5 +1,32 @@
|
|||||||
# @rocket/cli
|
# @rocket/cli
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
- cd22231: Restructure and simplify Rocket Cli Plugin System
|
||||||
|
|
||||||
|
### Patch Changes
|
||||||
|
|
||||||
|
- cd22231: Add a default Rocket Cli Plugin which checks all links on every save (during start) and after a production build
|
||||||
|
- Updated dependencies [cd22231]
|
||||||
|
- Updated dependencies [cd22231]
|
||||||
|
- @rocket/eleventy-plugin-mdjs-unified@0.3.0
|
||||||
|
- check-html-links@0.1.0
|
||||||
|
|
||||||
## 0.2.1
|
## 0.2.1
|
||||||
|
|
||||||
### Patch Changes
|
### Patch Changes
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
const { setComputedConfig, getComputedConfig } = require('./src/public/computedConfig.cjs');
|
const { setComputedConfig, getComputedConfig } = require('./src/public/computedConfig.cjs');
|
||||||
const rocketEleventyComputed = require('./src/public/rocketEleventyComputed.cjs');
|
const { generateEleventyComputed } = require('./src/public/generateEleventyComputed.cjs');
|
||||||
const { createPageSocialImage } = require('./src/public/createPageSocialImage.cjs');
|
const { createSocialImage } = require('./src/public/createSocialImage.cjs');
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
setComputedConfig,
|
setComputedConfig,
|
||||||
getComputedConfig,
|
getComputedConfig,
|
||||||
rocketEleventyComputed,
|
generateEleventyComputed,
|
||||||
createPageSocialImage,
|
createSocialImage,
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@rocket/cli",
|
"name": "@rocket/cli",
|
||||||
"version": "0.2.1",
|
"version": "0.4.0",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public"
|
"access": "public"
|
||||||
},
|
},
|
||||||
@@ -54,7 +54,7 @@
|
|||||||
"@11ty/eleventy-img": "^0.7.4",
|
"@11ty/eleventy-img": "^0.7.4",
|
||||||
"@rocket/building-rollup": "^0.1.2",
|
"@rocket/building-rollup": "^0.1.2",
|
||||||
"@rocket/core": "^0.1.1",
|
"@rocket/core": "^0.1.1",
|
||||||
"@rocket/eleventy-plugin-mdjs-unified": "^0.2.0",
|
"@rocket/eleventy-plugin-mdjs-unified": "^0.3.0",
|
||||||
"@rocket/eleventy-rocket-nav": "^0.2.1",
|
"@rocket/eleventy-rocket-nav": "^0.2.1",
|
||||||
"@rollup/plugin-babel": "^5.2.2",
|
"@rollup/plugin-babel": "^5.2.2",
|
||||||
"@rollup/plugin-node-resolve": "^11.0.1",
|
"@rollup/plugin-node-resolve": "^11.0.1",
|
||||||
@@ -62,6 +62,7 @@
|
|||||||
"@web/dev-server": "^0.1.4",
|
"@web/dev-server": "^0.1.4",
|
||||||
"@web/dev-server-rollup": "^0.3.2",
|
"@web/dev-server-rollup": "^0.3.2",
|
||||||
"@web/rollup-plugin-copy": "^0.2.0",
|
"@web/rollup-plugin-copy": "^0.2.0",
|
||||||
|
"check-html-links": "^0.1.1",
|
||||||
"command-line-args": "^5.1.1",
|
"command-line-args": "^5.1.1",
|
||||||
"command-line-usage": "^6.1.1",
|
"command-line-usage": "^6.1.1",
|
||||||
"fs-extra": "^9.0.1",
|
"fs-extra": "^9.0.1",
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
const { rocketEleventyComputed } = require('@rocket/cli');
|
const { generateEleventyComputed } = require('@rocket/cli');
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
...rocketEleventyComputed,
|
...generateEleventyComputed(),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -58,21 +58,28 @@ async function productionBuild(config) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export class RocketBuild {
|
export class RocketBuild {
|
||||||
|
static pluginName = 'RocketBuild';
|
||||||
commands = ['build'];
|
commands = ['build'];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {RocketCliOptions} config
|
||||||
|
*/
|
||||||
setupCommand(config) {
|
setupCommand(config) {
|
||||||
config.watch = false;
|
config.watch = false;
|
||||||
|
config.lintInputDir = config.outputDir;
|
||||||
return config;
|
return config;
|
||||||
}
|
}
|
||||||
|
|
||||||
async setup({ config }) {
|
async setup({ config, eleventy }) {
|
||||||
this.config = {
|
this.config = {
|
||||||
emptyOutputDir: true,
|
emptyOutputDir: true,
|
||||||
...config,
|
...config,
|
||||||
};
|
};
|
||||||
|
this.eleventy = eleventy;
|
||||||
}
|
}
|
||||||
|
|
||||||
async build() {
|
async buildCommand() {
|
||||||
|
await this.eleventy.write();
|
||||||
if (this.config.emptyOutputDir) {
|
if (this.config.emptyOutputDir) {
|
||||||
await fs.emptyDir(this.config.outputDir);
|
await fs.emptyDir(this.config.outputDir);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -28,23 +28,15 @@ export class RocketEleventy extends Eleventy {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async write() {
|
async write() {
|
||||||
/** @type {function} */
|
|
||||||
let finishBuild;
|
|
||||||
this.__rocketCli.updateComplete = new Promise(resolve => {
|
|
||||||
finishBuild = resolve;
|
|
||||||
});
|
|
||||||
|
|
||||||
await this.__rocketCli.mergePresets();
|
await this.__rocketCli.mergePresets();
|
||||||
|
|
||||||
await super.write();
|
await super.write();
|
||||||
await this.__rocketCli.update();
|
await this.__rocketCli.update();
|
||||||
// @ts-ignore
|
|
||||||
finishBuild();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export class RocketCli {
|
export class RocketCli {
|
||||||
updateComplete = new Promise(resolve => resolve(null));
|
/** @type {string[]} */
|
||||||
|
errors = [];
|
||||||
|
|
||||||
constructor({ argv } = { argv: undefined }) {
|
constructor({ argv } = { argv: undefined }) {
|
||||||
const mainDefinitions = [
|
const mainDefinitions = [
|
||||||
@@ -72,7 +64,10 @@ export class RocketCli {
|
|||||||
if (!this.eleventy) {
|
if (!this.eleventy) {
|
||||||
const { _inputDirCwdRelative, outputDevDir } = this.config;
|
const { _inputDirCwdRelative, outputDevDir } = this.config;
|
||||||
|
|
||||||
await fs.emptyDir(outputDevDir);
|
// We need to merge before we setup 11ty as the write phase is too late for _data
|
||||||
|
// TODO: find a way so we don't need to double merge
|
||||||
|
await this.mergePresets();
|
||||||
|
|
||||||
const elev = new RocketEleventy(_inputDirCwdRelative, outputDevDir, this);
|
const elev = new RocketEleventy(_inputDirCwdRelative, outputDevDir, this);
|
||||||
elev.isVerbose = false;
|
elev.isVerbose = false;
|
||||||
// 11ty always wants a relative path to cwd - why?
|
// 11ty always wants a relative path to cwd - why?
|
||||||
@@ -81,10 +76,6 @@ export class RocketCli {
|
|||||||
elev.setConfigPathOverride(relCwdPathToConfig);
|
elev.setConfigPathOverride(relCwdPathToConfig);
|
||||||
await elev.init();
|
await elev.init();
|
||||||
|
|
||||||
if (this.config.watch) {
|
|
||||||
elev.watch();
|
|
||||||
}
|
|
||||||
|
|
||||||
this.eleventy = elev;
|
this.eleventy = elev;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -116,42 +107,38 @@ export class RocketCli {
|
|||||||
async run() {
|
async run() {
|
||||||
await this.setup();
|
await this.setup();
|
||||||
|
|
||||||
if (this.config) {
|
|
||||||
for (const plugin of this.config.plugins) {
|
for (const plugin of this.config.plugins) {
|
||||||
if (this.considerPlugin(plugin)) {
|
if (this.considerPlugin(plugin) && typeof plugin.setupCommand === 'function') {
|
||||||
if (typeof plugin.setupCommand === 'function') {
|
|
||||||
this.config = plugin.setupCommand(this.config);
|
this.config = plugin.setupCommand(this.config);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (typeof plugin.setup === 'function') {
|
|
||||||
await plugin.setup({ config: this.config, argv: this.subArgv });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
await this.mergePresets();
|
await fs.emptyDir(this.config.outputDevDir);
|
||||||
await this.setupEleventy();
|
await this.setupEleventy();
|
||||||
|
|
||||||
if (this.config) {
|
for (const plugin of this.config.plugins) {
|
||||||
await this.updateComplete;
|
if (typeof plugin.setup === 'function') {
|
||||||
|
await plugin.setup({ config: this.config, argv: this.subArgv, eleventy: this.eleventy });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// execute the actual command
|
||||||
|
let executedAtLeastOneCommand = false;
|
||||||
|
const commandFn = `${this.config.command}Command`;
|
||||||
|
for (const plugin of this.config.plugins) {
|
||||||
|
if (this.considerPlugin(plugin) && typeof plugin[commandFn] === 'function') {
|
||||||
|
console.log(`Rocket executes ${commandFn} of ${plugin.constructor.pluginName}`);
|
||||||
|
executedAtLeastOneCommand = true;
|
||||||
|
await plugin[commandFn]();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (executedAtLeastOneCommand === false) {
|
||||||
|
throw new Error(`No Rocket Cli Plugin had a ${commandFn} function.`);
|
||||||
|
}
|
||||||
|
|
||||||
for (const plugin of this.config.plugins) {
|
for (const plugin of this.config.plugins) {
|
||||||
if (this.considerPlugin(plugin) && typeof plugin.execute === 'function') {
|
if (this.considerPlugin(plugin) && typeof plugin.postCommand === 'function') {
|
||||||
await plugin.execute();
|
await plugin.postCommand();
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this.config.watch === false && this.eleventy) {
|
|
||||||
await this.eleventy.write();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Build Phase
|
|
||||||
if (this.config.command === 'build') {
|
|
||||||
for (const plugin of this.config.plugins) {
|
|
||||||
if (typeof plugin.build === 'function') {
|
|
||||||
await plugin.build();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -159,7 +146,6 @@ export class RocketCli {
|
|||||||
console.log('Help is here: use build or start');
|
console.log('Help is here: use build or start');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param {RocketPlugin} plugin
|
* @param {RocketPlugin} plugin
|
||||||
@@ -213,7 +199,7 @@ export class RocketCli {
|
|||||||
setComputedConfig({});
|
setComputedConfig({});
|
||||||
if (this.eleventy) {
|
if (this.eleventy) {
|
||||||
this.eleventy.finish();
|
this.eleventy.finish();
|
||||||
// this.eleventy.stopWatch();
|
// await this.eleventy.stopWatch();
|
||||||
}
|
}
|
||||||
this.stop();
|
this.stop();
|
||||||
}
|
}
|
||||||
|
|||||||
91
packages/cli/src/RocketLint.js
Executable file
@@ -0,0 +1,91 @@
|
|||||||
|
/* eslint-disable @typescript-eslint/ban-ts-comment */
|
||||||
|
|
||||||
|
/** @typedef {import('../types/main').RocketCliOptions} RocketCliOptions */
|
||||||
|
|
||||||
|
import chalk from 'chalk';
|
||||||
|
import { validateFolder, formatErrors } from 'check-html-links';
|
||||||
|
|
||||||
|
export class RocketLint {
|
||||||
|
static pluginName = 'RocketLint';
|
||||||
|
commands = ['start', 'build', 'lint'];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {RocketCliOptions} config
|
||||||
|
*/
|
||||||
|
setupCommand(config) {
|
||||||
|
if (config.command === 'lint') {
|
||||||
|
config.watch = false;
|
||||||
|
}
|
||||||
|
return config;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {object} options
|
||||||
|
* @param {RocketCliOptions} options.config
|
||||||
|
* @param {any} options.argv
|
||||||
|
*/
|
||||||
|
async setup({ config, argv, eleventy }) {
|
||||||
|
this.__argv = argv;
|
||||||
|
this.config = {
|
||||||
|
lintInputDir: config.outputDevDir,
|
||||||
|
lintExecutesEleventyBefore: true,
|
||||||
|
...config,
|
||||||
|
};
|
||||||
|
this.eleventy = eleventy;
|
||||||
|
}
|
||||||
|
|
||||||
|
async lintCommand() {
|
||||||
|
if (this.config.lintExecutesEleventyBefore) {
|
||||||
|
await this.eleventy.write();
|
||||||
|
// updated will trigger linting
|
||||||
|
} else {
|
||||||
|
await this.__lint();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async __lint() {
|
||||||
|
if (this.config?.pathPrefix) {
|
||||||
|
console.log('INFO: RocketLint currently does not support being used with a pathPrefix');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const performanceStart = process.hrtime();
|
||||||
|
console.log('👀 Checking if all internal links work...');
|
||||||
|
const errors = await validateFolder(this.config.lintInputDir);
|
||||||
|
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):`,
|
||||||
|
...formatErrors(errors)
|
||||||
|
.split('\n')
|
||||||
|
.map(line => ` ${line}`),
|
||||||
|
`Checking links duration: ${performance[0]}s ${performance[1] / 1000000}ms`,
|
||||||
|
];
|
||||||
|
if (this.config.watch) {
|
||||||
|
console.log(output.join('\n'));
|
||||||
|
} else {
|
||||||
|
throw new Error(output.join('\n'));
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.log('✅ All internal links are valid.');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async postCommand() {
|
||||||
|
if (this.config.watch === false) {
|
||||||
|
await this.__lint();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async updated() {
|
||||||
|
if (this.config.watch === true) {
|
||||||
|
await this.__lint();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -7,6 +7,7 @@ import { metaConfigToWebDevServerConfig } from 'plugins-manager';
|
|||||||
/** @typedef {import('@web/dev-server').DevServerConfig} DevServerConfig */
|
/** @typedef {import('@web/dev-server').DevServerConfig} DevServerConfig */
|
||||||
|
|
||||||
export class RocketStart {
|
export class RocketStart {
|
||||||
|
static pluginName = 'RocketStart';
|
||||||
commands = ['start'];
|
commands = ['start'];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -22,7 +23,7 @@ export class RocketStart {
|
|||||||
* @param {RocketCliOptions} options.config
|
* @param {RocketCliOptions} options.config
|
||||||
* @param {any} options.argv
|
* @param {any} options.argv
|
||||||
*/
|
*/
|
||||||
async setup({ config, argv }) {
|
async setup({ config, argv, eleventy }) {
|
||||||
this.__argv = argv;
|
this.__argv = argv;
|
||||||
this.config = {
|
this.config = {
|
||||||
...config,
|
...config,
|
||||||
@@ -30,13 +31,20 @@ export class RocketStart {
|
|||||||
...config.devServer,
|
...config.devServer,
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
this.eleventy = eleventy;
|
||||||
}
|
}
|
||||||
|
|
||||||
async execute() {
|
async startCommand() {
|
||||||
if (!this.config) {
|
if (!this.config) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (this.config.watch) {
|
||||||
|
await this.eleventy.watch();
|
||||||
|
} else {
|
||||||
|
await this.eleventy.write();
|
||||||
|
}
|
||||||
|
|
||||||
/** @type {DevServerConfig} */
|
/** @type {DevServerConfig} */
|
||||||
const devServerConfig = metaConfigToWebDevServerConfig(
|
const devServerConfig = metaConfigToWebDevServerConfig(
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -39,22 +39,25 @@ const templateEndings = [
|
|||||||
'.pug',
|
'.pug',
|
||||||
];
|
];
|
||||||
|
|
||||||
function endsWithAny(string, suffixes) {
|
function isTemplateFile(href) {
|
||||||
for (let suffix of suffixes) {
|
for (const templateEnding of templateEndings) {
|
||||||
if (string.endsWith(suffix)) {
|
if (href.endsWith(templateEnding)) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
function isTemplateFile(href) {
|
|
||||||
return endsWithAny(href, templateEndings);
|
|
||||||
}
|
|
||||||
|
|
||||||
function isIndexTemplateFile(href) {
|
function isIndexTemplateFile(href) {
|
||||||
|
const hrefParsed = path.parse(href);
|
||||||
const indexTemplateEndings = templateEndings.map(ending => `index${ending}`);
|
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 +94,46 @@ function extractReferences(html, inputPath) {
|
|||||||
return { hrefs, assets };
|
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) {
|
function calculateNewHrefs(hrefs, inputPath) {
|
||||||
const newHrefs = [];
|
const newHrefs = [];
|
||||||
for (const hrefObj of hrefs) {
|
for (const hrefObj of hrefs) {
|
||||||
const newHrefObj = { ...hrefObj };
|
const newHrefObj = { ...hrefObj };
|
||||||
const [href, anchor] = newHrefObj.value.split('#');
|
const { value: href, suffix } = getValueAndAnchor(hrefObj.value);
|
||||||
const suffix = anchor ? `#${anchor}` : '';
|
|
||||||
|
|
||||||
if (isRelativeLink(href) && isTemplateFile(href)) {
|
if (isRelativeLink(href) && isTemplateFile(href)) {
|
||||||
const hrefParsed = path.parse(href);
|
const hrefParsed = path.parse(href);
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import { readConfig } from '@web/config-loader';
|
|||||||
|
|
||||||
import { RocketStart } from './RocketStart.js';
|
import { RocketStart } from './RocketStart.js';
|
||||||
import { RocketBuild } from './RocketBuild.js';
|
import { RocketBuild } from './RocketBuild.js';
|
||||||
|
import { RocketLint } from './RocketLint.js';
|
||||||
|
|
||||||
import { fileURLToPath } from 'url';
|
import { fileURLToPath } from 'url';
|
||||||
|
|
||||||
@@ -30,6 +31,7 @@ export async function normalizeConfig(inConfig) {
|
|||||||
setupDevPlugins: [],
|
setupDevPlugins: [],
|
||||||
setupBuildPlugins: [],
|
setupBuildPlugins: [],
|
||||||
setupEleventyPlugins: [],
|
setupEleventyPlugins: [],
|
||||||
|
setupEleventyComputedConfig: [],
|
||||||
setupCliPlugins: [],
|
setupCliPlugins: [],
|
||||||
eleventy: () => {},
|
eleventy: () => {},
|
||||||
command: 'help',
|
command: 'help',
|
||||||
@@ -105,6 +107,12 @@ export async function normalizeConfig(inConfig) {
|
|||||||
...preset.setupEleventyPlugins,
|
...preset.setupEleventyPlugins,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
if (preset.setupEleventyComputedConfig) {
|
||||||
|
config.setupEleventyComputedConfig = [
|
||||||
|
...config.setupEleventyComputedConfig,
|
||||||
|
...preset.setupEleventyComputedConfig,
|
||||||
|
];
|
||||||
|
}
|
||||||
if (preset.setupCliPlugins) {
|
if (preset.setupCliPlugins) {
|
||||||
config.setupCliPlugins = [...config.setupCliPlugins, ...preset.setupCliPlugins];
|
config.setupCliPlugins = [...config.setupCliPlugins, ...preset.setupCliPlugins];
|
||||||
}
|
}
|
||||||
@@ -114,8 +122,9 @@ export async function normalizeConfig(inConfig) {
|
|||||||
|
|
||||||
/** @type {MetaPlugin[]} */
|
/** @type {MetaPlugin[]} */
|
||||||
let pluginsMeta = [
|
let pluginsMeta = [
|
||||||
{ name: 'rocket-start', plugin: RocketStart },
|
{ name: 'RocketStart', plugin: RocketStart },
|
||||||
{ name: 'rocket-build', plugin: RocketBuild },
|
{ name: 'RocketBuild', plugin: RocketBuild },
|
||||||
|
{ name: 'RocketLint', plugin: RocketLint },
|
||||||
];
|
];
|
||||||
|
|
||||||
if (Array.isArray(config.setupCliPlugins)) {
|
if (Array.isArray(config.setupCliPlugins)) {
|
||||||
|
|||||||
@@ -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,
|
|
||||||
};
|
|
||||||
45
packages/cli/src/public/createSocialImage.cjs
Normal file
@@ -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,
|
||||||
|
};
|
||||||
33
packages/cli/src/public/createSocialImageSvg.cjs
Normal file
@@ -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,
|
||||||
|
};
|
||||||
116
packages/cli/src/public/generateEleventyComputed.cjs
Normal file
@@ -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 };
|
||||||
@@ -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;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
@@ -8,6 +8,7 @@ const rocketCollections = require('../eleventy-plugins/rocketCollections.cjs');
|
|||||||
|
|
||||||
module.exports = function (eleventyConfig) {
|
module.exports = function (eleventyConfig) {
|
||||||
const config = getComputedConfig();
|
const config = getComputedConfig();
|
||||||
|
|
||||||
const { pathPrefix, _inputDirCwdRelative, outputDevDir } = config;
|
const { pathPrefix, _inputDirCwdRelative, outputDevDir } = config;
|
||||||
|
|
||||||
let metaPlugins = [
|
let metaPlugins = [
|
||||||
@@ -46,6 +47,7 @@ module.exports = function (eleventyConfig) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
for (const pluginObj of metaPlugins) {
|
for (const pluginObj of metaPlugins) {
|
||||||
if (pluginObj.options) {
|
if (pluginObj.options) {
|
||||||
eleventyConfig.addPlugin(pluginObj.plugin, pluginObj.options);
|
eleventyConfig.addPlugin(pluginObj.plugin, pluginObj.options);
|
||||||
@@ -53,6 +55,9 @@ module.exports = function (eleventyConfig) {
|
|||||||
eleventyConfig.addPlugin(pluginObj.plugin);
|
eleventyConfig.addPlugin(pluginObj.plugin);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
} catch (err) {
|
||||||
|
console.log('An eleventy plugin had an error', err);
|
||||||
|
}
|
||||||
|
|
||||||
if (config.eleventy) {
|
if (config.eleventy) {
|
||||||
const returnValue = config.eleventy(eleventyConfig);
|
const returnValue = config.eleventy(eleventyConfig);
|
||||||
|
|||||||
182
packages/cli/test-node/RocketCli.computedConfig.test.js
Normal file
@@ -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');
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -4,6 +4,7 @@ import { RocketCli } from '../src/RocketCli.js';
|
|||||||
import path from 'path';
|
import path from 'path';
|
||||||
import { fileURLToPath } from 'url';
|
import { fileURLToPath } from 'url';
|
||||||
import fs from 'fs-extra';
|
import fs from 'fs-extra';
|
||||||
|
import chalk from 'chalk';
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||||
|
|
||||||
@@ -13,7 +14,7 @@ const { expect } = chai;
|
|||||||
* @param {function} method
|
* @param {function} method
|
||||||
* @param {string} errorMessage
|
* @param {string} errorMessage
|
||||||
*/
|
*/
|
||||||
async function expectThrowsAsync(method, errorMessage) {
|
async function expectThrowsAsync(method, { errorMatch, errorMessage } = {}) {
|
||||||
let error = null;
|
let error = null;
|
||||||
try {
|
try {
|
||||||
await method();
|
await method();
|
||||||
@@ -21,8 +22,11 @@ async function expectThrowsAsync(method, errorMessage) {
|
|||||||
error = err;
|
error = err;
|
||||||
}
|
}
|
||||||
expect(error).to.be.an('Error', 'No error was thrown');
|
expect(error).to.be.an('Error', 'No error was thrown');
|
||||||
|
if (errorMatch) {
|
||||||
|
expect(error.message).to.match(errorMatch);
|
||||||
|
}
|
||||||
if (errorMessage) {
|
if (errorMessage) {
|
||||||
expect(error.message).to.match(errorMessage);
|
expect(error.message).to.equal(errorMessage);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -57,11 +61,6 @@ describe('RocketCli e2e', () => {
|
|||||||
return text;
|
return text;
|
||||||
}
|
}
|
||||||
|
|
||||||
function readStartOutput(fileName, options = {}) {
|
|
||||||
options.type = 'start';
|
|
||||||
return readOutput(fileName, options);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function execute() {
|
async function execute() {
|
||||||
await cli.setup();
|
await cli.setup();
|
||||||
cli.config.outputDevDir = path.join(__dirname, 'e2e-fixtures', '__output-dev');
|
cli.config.outputDevDir = path.join(__dirname, 'e2e-fixtures', '__output-dev');
|
||||||
@@ -72,17 +71,18 @@ describe('RocketCli e2e', () => {
|
|||||||
await cli.run();
|
await cli.run();
|
||||||
}
|
}
|
||||||
|
|
||||||
async function executeStart(pathToConfig) {
|
async function executeLint(pathToConfig) {
|
||||||
cli = new RocketCli({
|
cli = new RocketCli({
|
||||||
argv: [
|
argv: ['lint', '--config-file', path.join(__dirname, pathToConfig.split('/').join(path.sep))],
|
||||||
'start',
|
|
||||||
'--config-file',
|
|
||||||
path.join(__dirname, pathToConfig.split('/').join(path.sep)),
|
|
||||||
],
|
|
||||||
});
|
});
|
||||||
await execute();
|
await execute();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
before(() => {
|
||||||
|
// ignore colors in tests as most CIs won't support it
|
||||||
|
chalk.level = 0;
|
||||||
|
});
|
||||||
|
|
||||||
afterEach(async () => {
|
afterEach(async () => {
|
||||||
if (cli?.cleanup) {
|
if (cli?.cleanup) {
|
||||||
await cli.cleanup();
|
await cli.cleanup();
|
||||||
@@ -133,7 +133,9 @@ describe('RocketCli e2e', () => {
|
|||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
await expectThrowsAsync(() => execute(), /Error in your Eleventy config file.*/);
|
await expectThrowsAsync(() => execute(), {
|
||||||
|
errorMatch: /Error in your Eleventy config file.*/,
|
||||||
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -219,12 +221,12 @@ describe('RocketCli e2e', () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('can add a pathprefix that will not influence the start command', async () => {
|
it('can add a pathPrefix that will not influence the start command', async () => {
|
||||||
cli = new RocketCli({
|
cli = new RocketCli({
|
||||||
argv: [
|
argv: [
|
||||||
'start',
|
'start',
|
||||||
'--config-file',
|
'--config-file',
|
||||||
path.join(__dirname, 'e2e-fixtures', 'content', 'pathprefix.rocket.config.js'),
|
path.join(__dirname, 'e2e-fixtures', 'content', 'pathPrefix.rocket.config.js'),
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
await execute();
|
await execute();
|
||||||
@@ -233,7 +235,7 @@ describe('RocketCli e2e', () => {
|
|||||||
type: 'start',
|
type: 'start',
|
||||||
});
|
});
|
||||||
expect(linkHtml).to.equal(
|
expect(linkHtml).to.equal(
|
||||||
['<p><a href="../../">home</a></p>', '<p><a href="/">absolute home</a></p>'].join('\n'),
|
['<p><a href="../">home</a></p>', '<p><a href="/">absolute home</a></p>'].join('\n'),
|
||||||
);
|
);
|
||||||
const assetHtml = await readOutput('use-assets/index.html', {
|
const assetHtml = await readOutput('use-assets/index.html', {
|
||||||
type: 'start',
|
type: 'start',
|
||||||
@@ -256,10 +258,9 @@ describe('RocketCli e2e', () => {
|
|||||||
stripToBody: true,
|
stripToBody: true,
|
||||||
});
|
});
|
||||||
expect(linkHtml).to.equal(
|
expect(linkHtml).to.equal(
|
||||||
[
|
['<p><a href="../">home</a></p>', '<p><a href="/my-sub-folder/">absolute home</a></p>'].join(
|
||||||
'<p><a href="../../">home</a></p>',
|
'\n',
|
||||||
'<p><a href="/my-sub-folder/">absolute home</a></p>',
|
),
|
||||||
].join('\n'),
|
|
||||||
);
|
);
|
||||||
const assetHtml = await readOutput('use-assets/index.html', {
|
const assetHtml = await readOutput('use-assets/index.html', {
|
||||||
stripServiceWorker: true,
|
stripServiceWorker: true,
|
||||||
@@ -269,141 +270,9 @@ describe('RocketCli e2e', () => {
|
|||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('will extract a title from markdown and set first folder as section', async () => {
|
it('smoke test for link checking', async () => {
|
||||||
cli = new RocketCli({
|
await expectThrowsAsync(() => executeLint('e2e-fixtures/lint-links/rocket.config.js'), {
|
||||||
argv: [
|
errorMatch: /Found 1 missing reference targets/,
|
||||||
'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('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="../guides/#with-anchor">Guides</a>',
|
|
||||||
'<a href="../one-level/raw/">Raw</a>',
|
|
||||||
'<a href="../../up-one-level/template/">Template</a>',
|
|
||||||
'<img src="../images-one-level/my-img.svg" alt="my-img">',
|
|
||||||
'<img src="/absolute-img.svg" alt="absolute-img"></p>',
|
|
||||||
];
|
|
||||||
|
|
||||||
const namedHtmlContent = [
|
|
||||||
'<div>',
|
|
||||||
' <a href="../">Root</a>',
|
|
||||||
' <a href="../guides/#with-anchor">Guides</a>',
|
|
||||||
' <a href="../one-level/raw/">Raw</a>',
|
|
||||||
' <a href="../../up-one-level/template/">Template</a>',
|
|
||||||
' <img src="../images-one-level/my-img.svg" alt="my-img">',
|
|
||||||
' <img src="/absolute-img.svg" alt="absolute-img">',
|
|
||||||
' <picture>',
|
|
||||||
' <source media="(min-width:465px)" srcset="../picture-min-465.jpg">',
|
|
||||||
' <img src="../../images-up-one-level/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
|
|
||||||
' </picture>',
|
|
||||||
'</div>',
|
|
||||||
];
|
|
||||||
|
|
||||||
const rawHtml = await readStartOutput('raw/index.html');
|
|
||||||
expect(rawHtml, 'raw/index.html does not match').to.equal(namedHtmlContent.join('\n'));
|
|
||||||
|
|
||||||
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>',
|
|
||||||
);
|
|
||||||
|
|
||||||
// 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="../up-one-level/template/">Template</a>',
|
|
||||||
'<img src="./images-one-level/my-img.svg" alt="my-img">',
|
|
||||||
'<img src="/absolute-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="../up-one-level/template/">Template</a>',
|
|
||||||
' <img src="./images-one-level/my-img.svg" alt="my-img">',
|
|
||||||
' <img src="/absolute-img.svg" alt="absolute-img">',
|
|
||||||
' <picture>',
|
|
||||||
' <source media="(min-width:465px)" srcset="./picture-min-465.jpg">',
|
|
||||||
' <img src="../images-up-one-level/picture-fallback.jpg" alt="Fallback" style="width:auto;">',
|
|
||||||
' </picture>',
|
|
||||||
'</div>',
|
|
||||||
].join('\n'),
|
|
||||||
);
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -0,0 +1,15 @@
|
|||||||
|
[Root](./index.md)
|
||||||
|
[Raw](./one-level/raw.html)
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
<div id="with-anchor">
|
||||||
|
<a href="./index.md">Root</a>
|
||||||
|
<a href="./one-level/raw.html">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>
|
||||||
|
Before Width: | Height: | Size: 118 B After Width: | Height: | Size: 118 B |
|
Before Width: | Height: | Size: 5.7 KiB After Width: | Height: | Size: 5.7 KiB |
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
@@ -0,0 +1,21 @@
|
|||||||
|
[Root](./)
|
||||||
|
[Guides](./guides.md#with-anchor)
|
||||||
|
[Raw](./one-level/raw.html)
|
||||||
|
[Template](./template.njk)
|
||||||
|
[EndingIndex](./rules/tabindex.md)
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
<div>
|
||||||
|
<a href="./">Root</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>
|
||||||
|
<source media="(min-width:465px)" srcset="./images/picture-min-465.jpg">
|
||||||
|
<img src="./images/picture-fallback.jpg" alt="Fallback" style="width:auto;">
|
||||||
|
</picture>
|
||||||
|
</div>
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
<div>
|
||||||
|
<a href="../index.md">Root</a>
|
||||||
|
<a href="../guides.md#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>
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
<div id="with-anchor">
|
||||||
|
<a href="./index.md">Root</a>
|
||||||
|
<a href="./one-level/raw.html">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>
|
||||||
@@ -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;
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{{ test }}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
**/*.njk
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# Guides
|
||||||
@@ -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;
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
**/*.njk
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
{{ socialMediaImage }}
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# First Pages >> Getting Started
|
||||||
@@ -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,
|
||||||
|
};
|
||||||
|
};
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# Guides
|
||||||
@@ -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,
|
||||||
|
};
|
||||||
|
};
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
# Rocket
|
||||||
@@ -2,6 +2,6 @@
|
|||||||
layout: layout.njk
|
layout: layout.njk
|
||||||
---
|
---
|
||||||
|
|
||||||
[home](../index.md)
|
[home](./index.md)
|
||||||
|
|
||||||
<a href="{{ '/' | url }}">absolute home</a>
|
<a href="{{ '/' | url }}">absolute home</a>
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
[Root](./index.md)
|
|
||||||
[Guides](./guides.md#with-anchor)
|
|
||||||
[Raw](./one-level/raw.html)
|
|
||||||
[Template](../up-one-level/template.njk)
|
|
||||||

|
|
||||||

|
|
||||||
|
|
||||||
<div>
|
|
||||||
<a href="./index.md">Root</a>
|
|
||||||
<a href="./guides.md#with-anchor">Guides</a>
|
|
||||||
<a href="./one-level/raw.html">Raw</a>
|
|
||||||
<a href="../up-one-level/template.njk">Template</a>
|
|
||||||
<img src="./images-one-level/my-img.svg" alt="my-img">
|
|
||||||
<img src="/absolute-img.svg" alt="absolute-img">
|
|
||||||
<picture>
|
|
||||||
<source media="(min-width:465px)" srcset="./picture-min-465.jpg">
|
|
||||||
<img src="../images-up-one-level/picture-fallback.jpg" alt="Fallback" style="width:auto;">
|
|
||||||
</picture>
|
|
||||||
</div>
|
|
||||||