Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tools: fix CJS/ESM toggle on small screens #43506

Merged
merged 4 commits into from
Jun 27, 2022
Merged

tools: fix CJS/ESM toggle on small screens #43506

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbd9385
tools: fix CJS/ESM toggle on small screens
aduh95 Jun 20, 2022
ba014dd
fixup! tools: fix CJS/ESM toggle on small screens
aduh95 Jun 22, 2022
e6adc23
fixup! tools: fix CJS/ESM toggle on small screens
aduh95 Jun 23, 2022
40906b8
fixup! tools: fix CJS/ESM toggle on small screens
aduh95 Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/api_assets/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -953,6 +953,8 @@ kbd {
background-repeat: no-repeat;
width: 142px;
height: 20px;
display: block;
cursor: pointer;
}
aduh95 marked this conversation as resolved.
Show resolved Hide resolved
.js-flavor-selector:checked {
background-image: url(./js-flavor-esm.svg);
Expand Down
1 change: 1 addition & 0 deletions doc/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<link rel="stylesheet" href="assets/hljs.css">
<link rel="canonical" href="https://nodejs.org/api/__FILENAME__.html">
<script async defer src="assets/api.js" type="text/javascript"></script>
__JS_FLAVORED_DYNAMIC_CSS__
</head>
<body class="alt apidoc" id="api-section-__FILENAME__">
<div id="content" class="clearfix">
Expand Down
10 changes: 9 additions & 1 deletion tools/doc/allhtml.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// of the generated html files.

import fs from 'fs';
import buildCSSForFlavoredJS from './buildCSSForFlavoredJS.mjs';

const source = new URL('../../out/doc/api/', import.meta.url);

Expand Down Expand Up @@ -90,7 +91,14 @@ all = all.slice(0, tocStart.index + tocStart[0].length) +
// Replace apicontent with the concatenated set of apicontents from each source.
const apiStart = /<\w+ id="apicontent">\s*/.exec(all);
const apiEnd = all.lastIndexOf('<!-- API END -->');
all = all.slice(0, apiStart.index + apiStart[0].length) +
all = all.slice(0, apiStart.index + apiStart[0].length)
.replace(
'\n</head>',
buildCSSForFlavoredJS(new Set(Array.from(
apicontent.matchAll(/(?<=<pre class="with-)\d+(?=-chars">)/g),
(x) => Number(x[0])
))) + '\n</head>'
) +
apicontent +
all.slice(apiEnd);

Expand Down
11 changes: 11 additions & 0 deletions tools/doc/buildCSSForFlavoredJS.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export default function buildCSSForFlavoredJS(dynamicSizes) {
if (dynamicSizes == null || dynamicSizes.length === 0) return '';

return `<style>${Array.from(dynamicSizes, (charCount) =>
`@media(max-width:${charCount * 8 + 142 + 16 * 4 + (charCount > 68 ? 274 : 0)}px){` +
aduh95 marked this conversation as resolved.
Show resolved Hide resolved
`.with-${charCount}-chars>.js-flavor-selector{` +
'float:none;' +
'margin:0 0 1em auto;' +
aduh95 marked this conversation as resolved.
Show resolved Hide resolved
'}' +
'}').join('')}</style>`;
}
13 changes: 12 additions & 1 deletion tools/doc/html.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ import { visit } from 'unist-util-visit';

import * as common from './common.mjs';
import * as typeParser from './type-parser.mjs';
import buildCSSForFlavoredJS from './buildCSSForFlavoredJS.mjs';

const dynamicSizes = Object.create(null);

const { highlight, getLanguage } = highlightJs;

Expand Down Expand Up @@ -90,6 +93,8 @@ function processContent(content) {
}

export function toHTML({ input, content, filename, nodeVersion, versions }) {
const dynamicSizesForThisFile = dynamicSizes[filename];

filename = path.basename(filename, '.md');

const id = filename.replace(/\W+/g, '-');
Expand All @@ -99,6 +104,7 @@ export function toHTML({ input, content, filename, nodeVersion, versions }) {
.replace('__SECTION__', content.section)
.replace(/__VERSION__/g, nodeVersion)
.replace(/__TOC__/g, content.toc)
.replace('__JS_FLAVORED_DYNAMIC_CSS__', buildCSSForFlavoredJS(dynamicSizesForThisFile))
.replace(/__TOC_PICKER__/g, tocPicker(id, content))
.replace(/__GTOC_PICKER__/g, gtocPicker(id))
.replace(/__GTOC__/g, gtocHTML.replace(
Expand Down Expand Up @@ -228,14 +234,19 @@ export function preprocessElements({ filename }) {
const previousNode = parent.children[index - 1] || {};
const nextNode = parent.children[index + 1] || {};

const charCountFirstTwoLines = Math.max(...node.value.split('\n', 2).map((str) => str.length));

if (!isJSFlavorSnippet(previousNode) &&
isJSFlavorSnippet(nextNode) &&
nextNode.lang !== node.lang) {
// Saving the highlight code as value to be added in the next node.
node.value = highlighted;
node.charCountFirstTwoLines = charCountFirstTwoLines;
} else if (isJSFlavorSnippet(previousNode) &&
previousNode.lang !== node.lang) {
node.value = '<pre>' +
const actualCharCount = Math.max(charCountFirstTwoLines, previousNode.charCountFirstTwoLines);
(dynamicSizes[filename] ??= new Set()).add(actualCharCount);
node.value = `<pre class="with-${actualCharCount}-chars">` +
'<input class="js-flavor-selector" type="checkbox"' +
// If CJS comes in second, ESM should display by default.
(node.lang === 'cjs' ? ' checked' : '') +
Expand Down