mirror of
https://github.com/modernweb-dev/rocket.git
synced 2026-03-21 08:51:18 +00:00
Compare commits
7 Commits
@rocket/en
...
@rocket/la
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
58692147e9 | ||
|
|
8dedc56afa | ||
|
|
bcbfae332d | ||
|
|
0fae0037d8 | ||
|
|
390335da18 | ||
|
|
6d2f469d26 | ||
|
|
94a6f54585 |
@@ -36,7 +36,7 @@
|
||||
"start:experimental": "NODE_DEBUG=engine:rendering node --no-warnings --experimental-loader ./packages/engine/src/litCssLoader.js packages/cli/src/cli.js start --open",
|
||||
"start": "NODE_DEBUG=engine:rendering node --trace-warnings packages/cli/src/cli.js start --open",
|
||||
"test": "yarn test:node && yarn test:web",
|
||||
"test:integration": "playwright test packages/*/test-node/*.spec.js",
|
||||
"test:integration": "playwright test packages/*/test-node/*.spec.js --retries=3",
|
||||
"test:node": "yarn test:unit && yarn test:integration",
|
||||
"test:unit": "node --trace-warnings ./node_modules/.bin/mocha --require ./scripts/testMochaGlobalHooks.js \"packages/*/test-node/**/*.test.{ts,js,mjs,cjs}\" -- --timeout 8000 --reporter dot --exit",
|
||||
"test:web": "web-test-runner",
|
||||
|
||||
@@ -1,5 +1,22 @@
|
||||
# @rocket/cli
|
||||
|
||||
## 0.20.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 8dedc56: Add start message for `rocket start`
|
||||
|
||||
```
|
||||
🚀 Rocket Engine v0.2.5
|
||||
|
||||
🚧 Local: http://localhost:8000/
|
||||
🌐 Network: http://xxx.xxx.xxx.xxx:8000/
|
||||
```
|
||||
|
||||
- Updated dependencies [8dedc56]
|
||||
- Updated dependencies [390335d]
|
||||
- @rocket/engine@0.2.6
|
||||
|
||||
## 0.20.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@rocket/cli",
|
||||
"version": "0.20.0",
|
||||
"version": "0.20.1",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
@@ -53,16 +53,18 @@
|
||||
],
|
||||
"dependencies": {
|
||||
"@rocket/building-rollup": "^0.4.0",
|
||||
"@rocket/engine": "^0.2.0",
|
||||
"@rocket/engine": "^0.2.6",
|
||||
"@web/rollup-plugin-copy": "^0.3.0",
|
||||
"colorette": "^2.0.16",
|
||||
"commander": "^9.0.0",
|
||||
"fs-extra": "^9.0.1",
|
||||
"gray-matter": "^4.0.3",
|
||||
"ip": "^1.1.5",
|
||||
"plugins-manager": "^0.3.0",
|
||||
"puppeteer": "^13.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/ip": "^1.1.0",
|
||||
"koa-proxy": "^1.0.0-alpha.3"
|
||||
},
|
||||
"types": "./dist-types/src/index.d.ts",
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { fromRollup } from '@web/dev-server-rollup';
|
||||
|
||||
import { Engine } from '@rocket/engine/server';
|
||||
import { logStartMessage } from './start/logStartMessage.js';
|
||||
|
||||
export class RocketStart {
|
||||
/** @type {Engine | undefined} */
|
||||
@@ -60,7 +61,14 @@ export class RocketStart {
|
||||
setupDevServerPlugins: [...this.cli.options.setupDevServerPlugins, ...withWrap],
|
||||
});
|
||||
try {
|
||||
console.log('🚀 Engines online');
|
||||
this.engine.events.on('devServerStarted', () => {
|
||||
if (this.engine?.devServer) {
|
||||
logStartMessage(
|
||||
{ devServerOptions: this.engine.devServer?.config, engine: this.engine },
|
||||
console,
|
||||
);
|
||||
}
|
||||
});
|
||||
await this.engine.start();
|
||||
} catch (e) {
|
||||
console.log('Engine start errored');
|
||||
@@ -71,7 +79,6 @@ export class RocketStart {
|
||||
async stop({ hard = true } = {}) {
|
||||
if (this.engine) {
|
||||
await this.engine.stop({ hard });
|
||||
console.log('🚀 Engines offline');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
54
packages/cli/src/start/logStartMessage.js
Normal file
54
packages/cli/src/start/logStartMessage.js
Normal file
@@ -0,0 +1,54 @@
|
||||
import ip from 'ip';
|
||||
import { white, bold, cyan, gray } from 'colorette';
|
||||
|
||||
/** @typedef {import('@web/dev-server').DevServerConfig} DevServerConfig */
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {DevServerConfig} devServerOptions
|
||||
* @param {string} host
|
||||
* @param {string} path
|
||||
* @returns {string}
|
||||
*/
|
||||
function createAddress(devServerOptions, host, path) {
|
||||
return `http${devServerOptions.http2 ? 's' : ''}://${host}:${devServerOptions.port}${path}`;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {DevServerConfig} devServerOptions
|
||||
* @param {console} logger
|
||||
* @param {string} openPath
|
||||
*/
|
||||
function logNetworkAddress(devServerOptions, logger, openPath) {
|
||||
try {
|
||||
const address = ip.address();
|
||||
if (typeof address === 'string') {
|
||||
logger.log(
|
||||
`${white(' 🌐 Network:')} ${cyan(createAddress(devServerOptions, address, openPath))}`,
|
||||
);
|
||||
}
|
||||
} catch (_a) {
|
||||
//
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {{ devServerOptions: DevServerConfig, engine: import('@rocket/engine/server').Engine}} options
|
||||
* @param {console} logger
|
||||
*/
|
||||
export function logStartMessage({ devServerOptions, engine }, logger) {
|
||||
const prettyHost = devServerOptions.hostname ?? 'localhost';
|
||||
let openPath = typeof devServerOptions.open === 'string' ? devServerOptions.open : '/';
|
||||
if (!openPath.startsWith('/')) {
|
||||
openPath = `/${openPath}`;
|
||||
}
|
||||
|
||||
logger.log(`${bold(`🚀 Rocket Engine`)} ${gray(`v${engine.getVersion()}`)}`);
|
||||
logger.log('');
|
||||
logger.log(
|
||||
`${white(' 🚧 Local:')} ${cyan(createAddress(devServerOptions, prettyHost, openPath))}`,
|
||||
);
|
||||
logNetworkAddress(devServerOptions, logger, openPath);
|
||||
logger.log('');
|
||||
}
|
||||
@@ -5,7 +5,7 @@ import { setupTestCli } from './test-helpers.js';
|
||||
|
||||
export function prepareTestCli(importMetaUrl) {
|
||||
const dir = path.dirname(fileURLToPath(importMetaUrl));
|
||||
return (cwd, cliOptions = ['build'], options = {}) => setupTestCli(cwd, cliOptions, options, dir);
|
||||
return fullOptions => setupTestCli({ dir, ...fullOptions });
|
||||
}
|
||||
|
||||
const { expect } = chai;
|
||||
|
||||
@@ -60,7 +60,13 @@ function cleanupLitMarkersFn(text) {
|
||||
return newText;
|
||||
}
|
||||
|
||||
export async function setupTestCli(cwd, cliOptions = ['build'], options = {}, dir) {
|
||||
export async function setupTestCli({
|
||||
cwd,
|
||||
cliOptions = ['build'],
|
||||
options = {},
|
||||
testOptions = {},
|
||||
dir,
|
||||
}) {
|
||||
const resolvedCwd = path.join(dir, cwd.split('/').join(path.sep));
|
||||
const useOptions = { buildOptimize: false, buildAutoStop: false, ...options, cwd: resolvedCwd };
|
||||
if (useOptions.inputDir) {
|
||||
@@ -69,6 +75,18 @@ export async function setupTestCli(cwd, cliOptions = ['build'], options = {}, di
|
||||
useOptions.outputDir = path.join(resolvedCwd, '__output');
|
||||
useOptions.outputDevDir = path.join(resolvedCwd, '__output-dev');
|
||||
|
||||
const capturedLogs = [];
|
||||
const origLog = console.log;
|
||||
const origError = console.error;
|
||||
if (testOptions.captureLogs) {
|
||||
console.log = msg => {
|
||||
capturedLogs.push(msg);
|
||||
};
|
||||
console.error = msg => {
|
||||
capturedLogs.push(msg);
|
||||
};
|
||||
}
|
||||
|
||||
const cli = new RocketCli({
|
||||
argv: [process.argv[0], new URL('../src/cli.js', import.meta.url).pathname, ...cliOptions],
|
||||
});
|
||||
@@ -184,6 +202,10 @@ export async function setupTestCli(cwd, cliOptions = ['build'], options = {}, di
|
||||
|
||||
async function cleanup() {
|
||||
await cli.stop({ hard: false });
|
||||
if (testOptions.captureLogs) {
|
||||
console.log = origLog;
|
||||
console.error = origError;
|
||||
}
|
||||
}
|
||||
|
||||
async function build() {
|
||||
@@ -243,5 +265,6 @@ export async function setupTestCli(cwd, cliOptions = ['build'], options = {}, di
|
||||
renameSource,
|
||||
backupOrRestoreSource,
|
||||
restoreSource,
|
||||
capturedLogs,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -8,11 +8,11 @@ const { expect } = chai;
|
||||
|
||||
describe('Config', () => {
|
||||
it('01: no config file', async () => {
|
||||
const { build, readOutput, readDevOutput } = await setupTestCli(
|
||||
'fixtures/01-config/01-no-config/',
|
||||
undefined,
|
||||
{ buildOptimize: true },
|
||||
);
|
||||
const { build, readOutput, readDevOutput } = await setupTestCli({
|
||||
cwd: 'fixtures/01-config/01-no-config/',
|
||||
options: { buildOptimize: true },
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
|
||||
expect(readOutput('index.html')).to.equal(
|
||||
@@ -31,14 +31,21 @@ describe('Config', () => {
|
||||
});
|
||||
|
||||
it('02: change input dir', async () => {
|
||||
const { build, readDevOutput } = await setupTestCli('fixtures/01-config/02-change-input-dir/');
|
||||
const { build, readDevOutput } = await setupTestCli({
|
||||
cwd: 'fixtures/01-config/02-change-input-dir/',
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
|
||||
expect(readDevOutput('index.html')).to.equal(['Hello World!'].join('\n'));
|
||||
});
|
||||
|
||||
it('03: can add a middleware (api proxy) to the dev server', async () => {
|
||||
const { cleanup, cli } = await setupTestCli('fixtures/01-config/03-add-middleware/', ['start']);
|
||||
const { cleanup, cli } = await setupTestCli({
|
||||
cwd: 'fixtures/01-config/03-add-middleware/',
|
||||
cliOptions: ['start'],
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
const apiServer = http.createServer((request, response) => {
|
||||
if (request.url === '/api/message') {
|
||||
response.writeHead(200);
|
||||
@@ -61,20 +68,22 @@ describe('Config', () => {
|
||||
});
|
||||
|
||||
it('04: can add a rollup plugin via setupDevServerAndBuildPlugins to build', async () => {
|
||||
const { build, readOutput } = await setupTestCli(
|
||||
'fixtures/01-config/04-add-rollup-plugin/',
|
||||
undefined,
|
||||
{ buildOptimize: true },
|
||||
);
|
||||
const { build, readOutput } = await setupTestCli({
|
||||
cwd: 'fixtures/01-config/04-add-rollup-plugin/',
|
||||
options: { buildOptimize: true },
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
const inlineModule = await readOutput('e97af63d.js', { format: false });
|
||||
expect(inlineModule).to.equal('var a={test:"data"};console.log(a);\n');
|
||||
});
|
||||
|
||||
it('04a: can add a rollup plugin via setupDevServerAndBuildPlugins to start', async () => {
|
||||
const { cli, cleanup } = await setupTestCli('fixtures/01-config/04-add-rollup-plugin/', [
|
||||
'start',
|
||||
]);
|
||||
const { cli, cleanup } = await setupTestCli({
|
||||
cwd: 'fixtures/01-config/04-add-rollup-plugin/',
|
||||
cliOptions: ['start'],
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await cli.start();
|
||||
const { port } = cli?.activePlugin?.engine.devServer.config;
|
||||
|
||||
@@ -88,9 +97,10 @@ describe('Config', () => {
|
||||
});
|
||||
|
||||
it('05: long file header comments', async () => {
|
||||
const { build, readSource } = await setupTestCli(
|
||||
'fixtures/01-config/05-long-file-header-comment/',
|
||||
);
|
||||
const { build, readSource } = await setupTestCli({
|
||||
cwd: 'fixtures/01-config/05-long-file-header-comment/',
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
|
||||
expect(readSource('index.rocket.js', { format: false })).to.equal(
|
||||
|
||||
@@ -5,13 +5,13 @@ const { expect } = chai;
|
||||
|
||||
describe('Build', () => {
|
||||
it('01: copy public files', async () => {
|
||||
const { build, readOutput, outputExists, readDevOutput } = await setupTestCli(
|
||||
'fixtures/02-build/01-copy-public-files/',
|
||||
undefined,
|
||||
{
|
||||
const { build, readOutput, outputExists, readDevOutput } = await setupTestCli({
|
||||
cwd: 'fixtures/02-build/01-copy-public-files/',
|
||||
options: {
|
||||
buildOptimize: true,
|
||||
},
|
||||
);
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
|
||||
expect(readOutput('index.html')).to.equal(
|
||||
|
||||
@@ -6,7 +6,11 @@ const { expect } = chai;
|
||||
describe('Upgrade System', () => {
|
||||
it('2021-09-menu', async () => {
|
||||
const { build, sourceExists, readSource, backupOrRestoreSource, restoreSource } =
|
||||
await setupTestCli('fixtures/03-upgrade/2022-03-menu', ['upgrade']);
|
||||
await setupTestCli({
|
||||
cwd: 'fixtures/03-upgrade/2022-03-menu',
|
||||
cliOptions: ['upgrade'],
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await backupOrRestoreSource();
|
||||
|
||||
await build();
|
||||
|
||||
@@ -5,13 +5,13 @@ const { expect } = chai;
|
||||
|
||||
describe('Open Graph', () => {
|
||||
it('generates the image and adds the meta tags', async () => {
|
||||
const { build, readOutput, outputExists } = await setupTestCli(
|
||||
'fixtures/04-open-graph/01-generate-image-and-inject-meta',
|
||||
undefined,
|
||||
{
|
||||
const { build, readOutput, outputExists } = await setupTestCli({
|
||||
cwd: 'fixtures/04-open-graph/01-generate-image-and-inject-meta',
|
||||
options: {
|
||||
buildOptimize: true,
|
||||
},
|
||||
);
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
|
||||
expect(readOutput('index.html', { replaceImageHashes: true })).to.equal(
|
||||
@@ -35,13 +35,13 @@ describe('Open Graph', () => {
|
||||
});
|
||||
|
||||
it('handles multiple pages', async () => {
|
||||
const { build, readOutput } = await setupTestCli(
|
||||
'fixtures/04-open-graph/02-multiple-pages',
|
||||
undefined,
|
||||
{
|
||||
const { build, readOutput } = await setupTestCli({
|
||||
cwd: 'fixtures/04-open-graph/02-multiple-pages',
|
||||
options: {
|
||||
buildOptimize: true,
|
||||
},
|
||||
);
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
|
||||
expect(readOutput('index.html', { replaceImageHashes: true })).to.equal(
|
||||
|
||||
25
packages/cli/test-node/05-start.test.js
Normal file
25
packages/cli/test-node/05-start.test.js
Normal file
@@ -0,0 +1,25 @@
|
||||
import chai from 'chai';
|
||||
import { white, bold } from 'colorette';
|
||||
|
||||
import { setupTestCli } from './test-helpers.js';
|
||||
|
||||
const { expect } = chai;
|
||||
|
||||
describe('Start', () => {
|
||||
it('Start Message', async () => {
|
||||
const { cli, capturedLogs, cleanup } = await setupTestCli({
|
||||
cwd: 'fixtures/05-start/01-start-message',
|
||||
cliOptions: ['start'],
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
|
||||
await cli.start();
|
||||
await cleanup();
|
||||
|
||||
expect(capturedLogs[0].startsWith(`${bold(`🚀 Rocket Engine`)} `)).to.be.true;
|
||||
expect(capturedLogs[1]).to.equal('');
|
||||
expect(capturedLogs[2].startsWith(`${white(' 🚧 Local:')}`)).to.be.true;
|
||||
expect(capturedLogs[3].startsWith(`${white(' 🌐 Network:')}`)).to.be.true;
|
||||
expect(capturedLogs[4]).to.equal('');
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,5 @@
|
||||
/* START - Rocket auto generated - do not touch */
|
||||
export const sourceRelativeFilePath = 'index.rocket.js';
|
||||
/* END - Rocket auto generated - do not touch */
|
||||
|
||||
export default () => 'Hello World!';
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"name": "index.rocket.js",
|
||||
"menuLinkText": "index.rocket.js",
|
||||
"url": "/",
|
||||
"outputRelativeFilePath": "index.html",
|
||||
"sourceRelativeFilePath": "index.rocket.js",
|
||||
"level": 0
|
||||
}
|
||||
@@ -1,5 +1,12 @@
|
||||
# @rocket/engine
|
||||
|
||||
## 0.2.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 8dedc56: Add `engine.getVersion()` method
|
||||
- 390335d: Improve title tag handling
|
||||
|
||||
## 0.2.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@rocket/engine",
|
||||
"version": "0.2.5",
|
||||
"version": "0.2.6",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
@@ -36,7 +36,7 @@
|
||||
"debug": "DEBUG=engine:rendering yarn test",
|
||||
"debug:integration": "PWDEBUG=1 yarn test:integration",
|
||||
"test": "mocha --require ../../scripts/testMochaGlobalHooks.js --timeout 8000 test-node/**/*.test.js test-node/*.test.js",
|
||||
"test:integration": "playwright test test-node/*.spec.js",
|
||||
"test:integration": "playwright test test-node/*.spec.js --retries=3",
|
||||
"test:watch": "onchange 'src/**/*.js' 'test-node/**/*.js' -- npm test",
|
||||
"types:copy": "copyfiles \"./types/**/*.d.ts\" dist-types/"
|
||||
},
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
import { existsSync } from 'fs';
|
||||
// TODO: implement copy without extra dependency => node 16.7.0 copy has recursive
|
||||
import fse from 'fs-extra';
|
||||
import { mkdir, rm } from 'fs/promises';
|
||||
import { mkdir, readFile, rm } from 'fs/promises';
|
||||
import path from 'path';
|
||||
import { EventEmitter } from 'events';
|
||||
import { startDevServer } from '@web/dev-server';
|
||||
@@ -32,6 +32,8 @@ import { RocketHeader } from './file-header/RocketHeader.js';
|
||||
|
||||
const logRendering = debuglog('engine:rendering');
|
||||
|
||||
const pkgJson = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8'));
|
||||
|
||||
export class Engine {
|
||||
/** @type {EngineOptions} */
|
||||
options = {
|
||||
@@ -121,8 +123,10 @@ export class Engine {
|
||||
if (pageTree.pageTreeChangedOnSave) {
|
||||
for (const sourceFilePath of sourceFiles) {
|
||||
const result = await this.renderFile({ sourceFilePath, throwOnError: true });
|
||||
await pageTree.add(result.sourceRelativeFilePath);
|
||||
await cleanupAutoGeneratedFiles(result);
|
||||
}
|
||||
await pageTree.save();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -265,6 +269,7 @@ export class Engine {
|
||||
readFileConfig: false,
|
||||
// argv: this.__argv,
|
||||
});
|
||||
this.events.emit('devServerStarted');
|
||||
|
||||
this.devServer.webSockets.on(
|
||||
'message',
|
||||
@@ -467,4 +472,8 @@ export class Engine {
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
getVersion() {
|
||||
return pkgJson.version;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -28,16 +28,20 @@ export function getHtmlMetaData(htmlFilePath) {
|
||||
const metaData = {
|
||||
// headlinesWithId: [],
|
||||
};
|
||||
|
||||
/** @type {string | undefined} */
|
||||
let capturedHeadlineText = undefined;
|
||||
let withinHTMLHead = false;
|
||||
parser.eventHandler = (ev, _data) => {
|
||||
if (ev === SaxEventType.OpenTag) {
|
||||
const data = /** @type {Tag} */ (/** @type {any} */ (_data));
|
||||
if (isHeadline(data)) {
|
||||
capturedHeadlineText = '';
|
||||
}
|
||||
if (data.name === 'head') {
|
||||
withinHTMLHead = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (capturedHeadlineText !== undefined && ev === SaxEventType.Text) {
|
||||
const data = /** @type {Text} */ (/** @type {any} */ (_data));
|
||||
capturedHeadlineText += data.value;
|
||||
@@ -74,7 +78,7 @@ export function getHtmlMetaData(htmlFilePath) {
|
||||
metaData.menuNoLink = getAttribute(data, 'content') !== 'false';
|
||||
}
|
||||
}
|
||||
if (!metaData.title && data.name === 'title') {
|
||||
if (withinHTMLHead && data.name === 'title') {
|
||||
metaData.title = getText(data);
|
||||
}
|
||||
|
||||
@@ -87,7 +91,7 @@ export function getHtmlMetaData(htmlFilePath) {
|
||||
.replace(/&/g, '&')
|
||||
.trim();
|
||||
const text = linkText || processedCapturedHeadlineText || '';
|
||||
if (data.name === 'h1') {
|
||||
if (!metaData.h1 && data.name === 'h1') {
|
||||
metaData.h1 = text;
|
||||
}
|
||||
if (id && text) {
|
||||
@@ -104,6 +108,10 @@ export function getHtmlMetaData(htmlFilePath) {
|
||||
}
|
||||
capturedHeadlineText = undefined;
|
||||
}
|
||||
|
||||
if (data.name === 'head') {
|
||||
withinHTMLHead = false;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@@ -894,7 +894,7 @@ describe('Engine menus', () => {
|
||||
});
|
||||
});
|
||||
|
||||
it('15: link-text attribute', async () => {
|
||||
it('16: link-text attribute', async () => {
|
||||
const { build, readSource } = await setupTestEngine(
|
||||
'fixtures/05-menu/16-link-text-attribute/docs',
|
||||
);
|
||||
@@ -929,4 +929,23 @@ describe('Engine menus', () => {
|
||||
url: '/',
|
||||
});
|
||||
});
|
||||
|
||||
it('17: title-tag', async () => {
|
||||
const { build, readSource, deleteSource } = await setupTestEngine(
|
||||
'fixtures/05-menu/17-title-tag/docs',
|
||||
);
|
||||
await deleteSource('pageTreeData.rocketGenerated.json');
|
||||
await build();
|
||||
|
||||
expect(JSON.parse(readSource('pageTreeData.rocketGenerated.json'))).to.deep.equal({
|
||||
h1: 'Welcome to Rocket',
|
||||
level: 0,
|
||||
menuLinkText: 'Welcome to Rocket',
|
||||
name: 'Welcome to Rocket',
|
||||
outputRelativeFilePath: 'index.html',
|
||||
sourceRelativeFilePath: 'index.rocket.js',
|
||||
title: 'Welcome to Rocket | Rocket',
|
||||
url: '/',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -6,7 +6,13 @@ export { layout };
|
||||
|
||||
import { html } from 'lit';
|
||||
export default () => html`
|
||||
<meta name="menu:link.text" content="About" />
|
||||
<title>About | MyPage</title>
|
||||
<h1>This is About</h1>
|
||||
<html>
|
||||
<head>
|
||||
<title>About | MyPage</title>
|
||||
</head>
|
||||
<body>
|
||||
<meta name="menu:link.text" content="About" />
|
||||
<h1>This is About</h1>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
|
||||
@@ -8,8 +8,8 @@
|
||||
"level": 0,
|
||||
"children": [
|
||||
{
|
||||
"menuLinkText": "About",
|
||||
"title": "About | MyPage",
|
||||
"menuLinkText": "About",
|
||||
"h1": "This is About",
|
||||
"name": "This is About",
|
||||
"url": "/about/",
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
/* START - Rocket auto generated - do not touch */
|
||||
export const sourceRelativeFilePath = 'index.rocket.js';
|
||||
import { layout, html } from './recursive.data.js';
|
||||
export { layout, html };
|
||||
/* END - Rocket auto generated - do not touch */
|
||||
|
||||
export default () => html` <h1>Welcome to Rocket</h1> `;
|
||||
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"title": "Welcome to Rocket | Rocket",
|
||||
"h1": "Welcome to Rocket",
|
||||
"name": "Welcome to Rocket",
|
||||
"menuLinkText": "Welcome to Rocket",
|
||||
"url": "/",
|
||||
"outputRelativeFilePath": "index.html",
|
||||
"sourceRelativeFilePath": "index.rocket.js",
|
||||
"level": 0
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
import { PageTree } from '@rocket/engine';
|
||||
import { html } from 'lit';
|
||||
|
||||
const pageTree = new PageTree({
|
||||
inputDir: new URL('./', import.meta.url),
|
||||
outputDir: new URL('../__output', import.meta.url),
|
||||
});
|
||||
|
||||
await pageTree.restore();
|
||||
|
||||
const titleWrapperFn = title => (title ? `${title} | Rocket` : '');
|
||||
|
||||
export const layout = data => {
|
||||
const title = titleWrapperFn(pageTree.getPage(data.sourceRelativeFilePath)?.model?.name);
|
||||
return html`
|
||||
<html>
|
||||
<head>
|
||||
<title-server-only>${title}</title-server-only>
|
||||
</head>
|
||||
</html>
|
||||
<body>
|
||||
<main>${data.content()}</main>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
};
|
||||
|
||||
export { html };
|
||||
@@ -1,5 +1,16 @@
|
||||
# @rocket/launch
|
||||
|
||||
## 0.21.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 390335d: Improve title tag handling
|
||||
- Updated dependencies [8dedc56]
|
||||
- Updated dependencies [390335d]
|
||||
- Updated dependencies [8dedc56]
|
||||
- @rocket/engine@0.2.6
|
||||
- @rocket/cli@0.20.1
|
||||
|
||||
## 0.21.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@rocket/launch",
|
||||
"version": "0.21.0",
|
||||
"version": "0.21.1",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
@@ -46,9 +46,9 @@
|
||||
"preset"
|
||||
],
|
||||
"dependencies": {
|
||||
"@rocket/cli": "^0.20.0",
|
||||
"@rocket/cli": "^0.20.1",
|
||||
"@rocket/components": "^0.2.0",
|
||||
"@rocket/engine": "^0.2.0",
|
||||
"@rocket/engine": "^0.2.6",
|
||||
"@webcomponents/template-shadowroot": "^0.1.0",
|
||||
"lit": "^2.3.0",
|
||||
"workbox-window": "^6.1.5"
|
||||
|
||||
@@ -65,7 +65,7 @@ export class LayoutMain extends Layout {
|
||||
},
|
||||
],
|
||||
footerMenu: [],
|
||||
titleWrapperFn: title => `${title} | ${this.options.siteName}`,
|
||||
titleWrapperFn: title => (title ? `${title} | ${this.options.siteName}` : ''),
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -7,13 +7,13 @@ const { expect } = chai;
|
||||
|
||||
describe('Search', () => {
|
||||
it('01: writes the search index', async () => {
|
||||
const { build, readOutput, readPublic } = await setupTestCli(
|
||||
'fixtures/01-single-page/',
|
||||
undefined,
|
||||
{
|
||||
const { build, readOutput, readPublic } = await setupTestCli({
|
||||
cwd: 'fixtures/01-single-page/',
|
||||
options: {
|
||||
buildOptimize: true,
|
||||
},
|
||||
);
|
||||
testOptions: { captureLogs: true },
|
||||
});
|
||||
await build();
|
||||
|
||||
const indexString =
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# @rocket/spark
|
||||
|
||||
## 0.2.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- 390335d: Improve title tag handling
|
||||
- Updated dependencies [8dedc56]
|
||||
- Updated dependencies [390335d]
|
||||
- @rocket/engine@0.2.6
|
||||
|
||||
## 0.2.0
|
||||
|
||||
### Minor Changes
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@rocket/spark",
|
||||
"version": "0.2.0",
|
||||
"version": "0.2.1",
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
@@ -41,7 +41,7 @@
|
||||
],
|
||||
"dependencies": {
|
||||
"@rocket/components": "^0.2.0",
|
||||
"@rocket/engine": "^0.2.0",
|
||||
"@rocket/engine": "^0.2.6",
|
||||
"lit": "^2.3.0"
|
||||
},
|
||||
"devDependencies": {},
|
||||
|
||||
@@ -31,7 +31,7 @@ export class LayoutHome extends Layout {
|
||||
return nothing;
|
||||
}
|
||||
const page = this.options.pageTree.getPage(data.sourceRelativeFilePath);
|
||||
if (page.model.headlinesWithId) {
|
||||
if (page?.model?.headlinesWithId) {
|
||||
return html`
|
||||
${page.model.headlinesWithId.map(
|
||||
headline => html`
|
||||
|
||||
@@ -54,7 +54,7 @@ Like any unfamiliar technology, Rocket comes with a slight learning curve. Howev
|
||||
|
||||
### Example Projects
|
||||
|
||||
If you prefer to learn Rocket by example, check out our [examples](https://github.com/modernweb-dev/rocket/tree/next/examples) on GitHub.
|
||||
If you prefer to learn Rocket by example, check out our [examples](https://github.com/modernweb-dev/rocket/tree/main/examples) on GitHub.
|
||||
|
||||
You locally install any of these examples by running `npx @rocket/create@latest` and selecting it within the wizard.
|
||||
|
||||
|
||||
@@ -48,11 +48,11 @@ This with start rocket in development mode and you will see your site running in
|
||||
|
||||
## What is a page?
|
||||
|
||||
A page is a file that ends either with `*.rocket.js`, `*.rocket.md` or `*.rocket.html` and is located in the input directory (`docs` by default). Pages will make up the majority or your website.
|
||||
A page is a file that ends either with `*.rocket.js`, `*.rocket.md` or `*.rocket.html` and is located in the input directory (`site/pages` by default). Pages will make up the majority or your website.
|
||||
|
||||
The simplest way to get started is to create a file
|
||||
|
||||
👉 `docs/index.rocket.md`
|
||||
👉 `site/pages/index.rocket.md`
|
||||
|
||||
```md
|
||||
# Hello World
|
||||
@@ -78,15 +78,23 @@ This section will be used to auto inject settings and data via a data cascade.
|
||||
|
||||
To test it you can create a file
|
||||
|
||||
👉 `docs/recursive.data.js`
|
||||
👉 `site/pages/recursive.data.js`
|
||||
|
||||
```js
|
||||
import { html } from 'lit';
|
||||
|
||||
export const layout = data => html`<div>${data.content()}</div>`;
|
||||
export const layout = data => html`
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<body>
|
||||
<header>My Website</header>
|
||||
<div>${data.content()}</div>
|
||||
</body>
|
||||
</html>
|
||||
`;
|
||||
```
|
||||
|
||||
Now if you go back to your `docs/index.rocket.md` you will see that `layout` got automatically injected.
|
||||
Now if you go back to your `site/pages/index.rocket.md` you will see that `layout` got automatically injected.
|
||||
|
||||
````md
|
||||
```js server
|
||||
|
||||
@@ -31,7 +31,7 @@ export const description = 'Learn how to structure a project with Rocket.';
|
||||
# Project Structure
|
||||
|
||||
Rocket works with one input folder for all your pages that defaults to `site/pages`.
|
||||
Within `pages` there is a `__public` folder that will be copied as is to the output folder.
|
||||
Within `pages` there is a `public` folder that will be copied as is to the output folder.
|
||||
|
||||
All other files like `layouts`, `css`, `data`, ... can be placed anywhere in your project.
|
||||
|
||||
|
||||
@@ -11,6 +11,8 @@ export async function registerCustomElements() {
|
||||
// prettier-ignore
|
||||
customElements.define('rocket-header', await import('@rocket/components/header.js').then(m => m.RocketHeader));
|
||||
// prettier-ignore
|
||||
customElements.define('inline-notification', await import('@rocket/components/inline-notification.js').then(m => m.InlineNotification));
|
||||
// prettier-ignore
|
||||
customElements.define('rocket-main-docs', await import('@rocket/components/main-docs.js').then(m => m.RocketMainDocs));
|
||||
// prettier-ignore
|
||||
customElements.define('rocket-content-area', await import('@rocket/components/content-area.js').then(m => m.RocketContentArea));
|
||||
|
||||
@@ -22,6 +22,8 @@ export async function registerCustomElements() {
|
||||
}
|
||||
export const needsLoader = true;
|
||||
/* END - Rocket auto generated - do not touch */
|
||||
export const title = 'Plugins Manager';
|
||||
export const subTitle = 'Enable fully customizable options for your plugin system';
|
||||
```
|
||||
|
||||
# Overview
|
||||
|
||||
@@ -22,6 +22,9 @@ export async function registerCustomElements() {
|
||||
}
|
||||
export const needsLoader = true;
|
||||
/* END - Rocket auto generated - do not touch */
|
||||
|
||||
export const title = 'Markdown JavaScript';
|
||||
export const subTitle = 'Executable JavaScript in markdown by annotating code blocks';
|
||||
```
|
||||
|
||||
# Overview
|
||||
|
||||
@@ -22,6 +22,10 @@ export async function registerCustomElements() {
|
||||
}
|
||||
export const needsLoader = true;
|
||||
/* END - Rocket auto generated - do not touch */
|
||||
|
||||
export const title = 'Rocket Rollup Config';
|
||||
export const subTitle =
|
||||
'A ready to use and customizable rollup config for web sites, MPAs and SPAs';
|
||||
```
|
||||
|
||||
# Overview
|
||||
|
||||
@@ -24,11 +24,14 @@ export async function registerCustomElements() {
|
||||
}
|
||||
export const needsLoader = true;
|
||||
/* END - Rocket auto generated - do not touch */
|
||||
|
||||
export const title = 'Check HTML links';
|
||||
export const subTitle = 'A fast checker for broken links/references in HTML files';
|
||||
```
|
||||
|
||||
# Overview
|
||||
|
||||
A fast checker for broken links/references in HTML.
|
||||
A fast checker for broken links/references in HTML files.
|
||||
|
||||
<inline-notification type="tip">
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"title": "Welcome to Rocket",
|
||||
"h1": "\n \n ",
|
||||
"name": "\n \n ",
|
||||
"menuLinkText": "\n \n ",
|
||||
"h1": "",
|
||||
"name": "Welcome to Rocket",
|
||||
"menuLinkText": "Welcome to Rocket",
|
||||
"url": "/",
|
||||
"outputRelativeFilePath": "index.html",
|
||||
"sourceRelativeFilePath": "index.rocket.js",
|
||||
@@ -386,6 +386,31 @@
|
||||
"text": "Recommended Project Structure",
|
||||
"id": "recommended-project-structure",
|
||||
"level": 2
|
||||
},
|
||||
{
|
||||
"text": "site/pages/",
|
||||
"id": "sitepages",
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "site/src/",
|
||||
"id": "sitesrc",
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "site/src/components",
|
||||
"id": "sitesrccomponents",
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "site/src/layouts",
|
||||
"id": "sitesrclayouts",
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "site/public/",
|
||||
"id": "sitepublic",
|
||||
"level": 3
|
||||
}
|
||||
],
|
||||
"name": "Project Structure",
|
||||
@@ -758,6 +783,16 @@
|
||||
"id": "menu-link-text",
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "link-text=\"...\"",
|
||||
"id": "link-text",
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "Headings with HTML",
|
||||
"id": "headings-with-html",
|
||||
"level": 2
|
||||
},
|
||||
{
|
||||
"text": "Menu No Link",
|
||||
"id": "menu-no-link",
|
||||
@@ -937,7 +972,7 @@
|
||||
"level": 2
|
||||
},
|
||||
{
|
||||
"text": "The Function",
|
||||
"text": "The :resolve Function",
|
||||
"id": "the-resolve-function",
|
||||
"level": 2
|
||||
},
|
||||
@@ -1432,7 +1467,7 @@
|
||||
"level": 2
|
||||
},
|
||||
{
|
||||
"text": "1. Simple Tags and External Files",
|
||||
"text": "1. Simple <link> Tags and External Files",
|
||||
"id": "1-simple-link-tags-and-external-files",
|
||||
"level": 3
|
||||
},
|
||||
@@ -1447,7 +1482,7 @@
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "Recommendations & Best Practices",
|
||||
"text": "Recommendations & Best Practices",
|
||||
"id": "recommendations--best-practices",
|
||||
"level": 2
|
||||
},
|
||||
@@ -2239,7 +2274,7 @@
|
||||
"needsLoader": true,
|
||||
"children": [
|
||||
{
|
||||
"title": "Overview | Rocket",
|
||||
"title": "Plugins Manager",
|
||||
"h1": "Overview",
|
||||
"headlinesWithId": [
|
||||
{
|
||||
@@ -2313,7 +2348,7 @@
|
||||
"level": 2
|
||||
}
|
||||
],
|
||||
"name": "Overview",
|
||||
"name": "Plugins Manager",
|
||||
"menuLinkText": "Overview",
|
||||
"url": "/tools/plugins-manager/overview/",
|
||||
"outputRelativeFilePath": "tools/plugins-manager/overview/index.html",
|
||||
@@ -2345,7 +2380,8 @@
|
||||
"launch-blog-details": "@rocket/launch/blog-details.js::LaunchBlogDetails",
|
||||
"my-counter": "#src/components/MyCounter.js::MyCounter"
|
||||
},
|
||||
"needsLoader": true
|
||||
"needsLoader": true,
|
||||
"subTitle": "Enable fully customizable options for your plugin system"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -2388,7 +2424,7 @@
|
||||
"needsLoader": true,
|
||||
"children": [
|
||||
{
|
||||
"title": "Overview | Rocket",
|
||||
"title": "Markdown JavaScript",
|
||||
"h1": "Overview",
|
||||
"headlinesWithId": [
|
||||
{
|
||||
@@ -2451,13 +2487,23 @@
|
||||
"id": "basic",
|
||||
"level": 3
|
||||
},
|
||||
{
|
||||
"text": "mdjsDocPage",
|
||||
"id": "mdjsdocpage",
|
||||
"level": 4
|
||||
},
|
||||
{
|
||||
"text": "mdjsProcess",
|
||||
"id": "mdjsprocess",
|
||||
"level": 4
|
||||
},
|
||||
{
|
||||
"text": "Advanced",
|
||||
"id": "advanced",
|
||||
"level": 3
|
||||
}
|
||||
],
|
||||
"name": "Overview",
|
||||
"name": "Markdown JavaScript",
|
||||
"menuLinkText": "Overview",
|
||||
"url": "/tools/markdown-javascript/overview/",
|
||||
"outputRelativeFilePath": "tools/markdown-javascript/overview/index.html",
|
||||
@@ -2489,7 +2535,8 @@
|
||||
"launch-blog-details": "@rocket/launch/blog-details.js::LaunchBlogDetails",
|
||||
"my-counter": "#src/components/MyCounter.js::MyCounter"
|
||||
},
|
||||
"needsLoader": true
|
||||
"needsLoader": true,
|
||||
"subTitle": "Executable JavaScript in markdown by annotating code blocks"
|
||||
},
|
||||
{
|
||||
"title": "Preview | Rocket",
|
||||
@@ -2655,7 +2702,7 @@
|
||||
"needsLoader": true,
|
||||
"children": [
|
||||
{
|
||||
"title": "Overview | Rocket",
|
||||
"title": "Rocket Rollup Config",
|
||||
"h1": "Overview",
|
||||
"headlinesWithId": [
|
||||
{
|
||||
@@ -2689,7 +2736,7 @@
|
||||
"level": 3
|
||||
}
|
||||
],
|
||||
"name": "Overview",
|
||||
"name": "Rocket Rollup Config",
|
||||
"menuLinkText": "Overview",
|
||||
"url": "/tools/rollup-config/overview/",
|
||||
"outputRelativeFilePath": "tools/rollup-config/overview/index.html",
|
||||
@@ -2721,7 +2768,8 @@
|
||||
"launch-blog-details": "@rocket/launch/blog-details.js::LaunchBlogDetails",
|
||||
"my-counter": "#src/components/MyCounter.js::MyCounter"
|
||||
},
|
||||
"needsLoader": true
|
||||
"needsLoader": true,
|
||||
"subTitle": "A ready to use and customizable rollup config for web sites, MPAs and SPAs"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -2764,7 +2812,7 @@
|
||||
"needsLoader": true,
|
||||
"children": [
|
||||
{
|
||||
"title": "Overview | Rocket",
|
||||
"title": "Check HTML links",
|
||||
"h1": "Overview",
|
||||
"headlinesWithId": [
|
||||
{
|
||||
@@ -2803,7 +2851,7 @@
|
||||
"level": 2
|
||||
}
|
||||
],
|
||||
"name": "Overview",
|
||||
"name": "Check HTML links",
|
||||
"menuLinkText": "Overview",
|
||||
"url": "/tools/check-html-links/overview/",
|
||||
"outputRelativeFilePath": "tools/check-html-links/overview/index.html",
|
||||
@@ -2835,7 +2883,8 @@
|
||||
"launch-blog-details": "@rocket/launch/blog-details.js::LaunchBlogDetails",
|
||||
"my-counter": "#src/components/MyCounter.js::MyCounter"
|
||||
},
|
||||
"needsLoader": true
|
||||
"needsLoader": true,
|
||||
"subTitle": "A fast checker for broken links/references in HTML files"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
13
yarn.lock
13
yarn.lock
@@ -1656,6 +1656,13 @@
|
||||
resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-1.8.2.tgz#7315b4c4c54f82d13fa61c228ec5c2ea5cc9e0e1"
|
||||
integrity sha512-EqX+YQxINb+MeXaIqYDASb6U6FCHbWjkj4a1CKDBks3d/QiB2+PqBLyO72vLDgAO1wUI4O+9gweRcQK11bTL/w==
|
||||
|
||||
"@types/ip@^1.1.0":
|
||||
version "1.1.0"
|
||||
resolved "https://registry.yarnpkg.com/@types/ip/-/ip-1.1.0.tgz#aec4f5bfd49e4a4c53b590d88c36eb078827a7c0"
|
||||
integrity sha512-dwNe8gOoF70VdL6WJBwVHtQmAX4RMd62M+mAB9HQFjG1/qiCLM/meRy95Pd14FYBbEDwCq7jgJs89cHpLBu4HQ==
|
||||
dependencies:
|
||||
"@types/node" "*"
|
||||
|
||||
"@types/is-ci@^3.0.0":
|
||||
version "3.0.0"
|
||||
resolved "https://registry.yarnpkg.com/@types/is-ci/-/is-ci-3.0.0.tgz#7e8910af6857601315592436f030aaa3ed9783c3"
|
||||
@@ -2085,9 +2092,9 @@
|
||||
glob "^7.1.6"
|
||||
|
||||
"@web/rollup-plugin-html@^1.8.0":
|
||||
version "1.10.3"
|
||||
resolved "https://registry.yarnpkg.com/@web/rollup-plugin-html/-/rollup-plugin-html-1.10.3.tgz#78fa06a9a7f2ec6973a12bd1000b900c1fd4e4eb"
|
||||
integrity sha512-2RMIeKxpGtrcXiqPTgMVq5neGa5xa69MfNK860BHVMEO2N/MrHFuQNr1eNLsspcq2DL/xnymwC3w5hgjtlgxag==
|
||||
version "1.11.0"
|
||||
resolved "https://registry.yarnpkg.com/@web/rollup-plugin-html/-/rollup-plugin-html-1.11.0.tgz#46c2bcb3a3b9db55d53b897ffc7e7ef2f618a052"
|
||||
integrity sha512-EqUcV5plGYTV/utdbX8g5t8Yq/z6VfFuQuPD39ckOQuRj7Rj6HD15FHwLHpFAWOR0+GrDnNzR74RvI4ipGm0qQ==
|
||||
dependencies:
|
||||
"@web/parse5-utils" "^1.3.0"
|
||||
glob "^7.1.6"
|
||||
|
||||
Reference in New Issue
Block a user