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

Add lib functions renderTemplate() and renderPreview() etc #4329

Merged
merged 4 commits into from
Oct 20, 2023
Merged

Add lib functions renderTemplate() and renderPreview() etc #4329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fcd4fa0
Align options between render functions
colinrotherham Oct 18, 2023
0f1a980
Add standalone lib `renderTemplate()` for Nunjucks template rendering
colinrotherham Oct 13, 2023
461f03c
Add standalone lib `renderPreview()` for Nunjucks boilerplate preview
colinrotherham Oct 16, 2023
699dccc
Rename component render functions to `render()`
colinrotherham Oct 16, 2023
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
1 change: 1 addition & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 10 additions & 8 deletions packages/govuk-frontend-review/src/app.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ import {
getComponentsFixtures,
getComponentNames,
getComponentNamesFiltered,
renderComponent
render,
renderPreview
} from '@govuk-frontend/lib/components'
import { filterPath, hasPath } from '@govuk-frontend/lib/files'
import { getStats, modulePaths } from '@govuk-frontend/stats'
Expand Down Expand Up @@ -158,11 +159,10 @@ export default async () => {
}

// Construct and evaluate the component with the data for this example
res.locals.componentView = renderComponent(
componentName,
fixture.options,
{ env }
)
res.locals.componentView = render(componentName, {
context: fixture.options,
env
})

let bodyClasses = 'app-template__body'

Expand Down Expand Up @@ -201,9 +201,11 @@ export default async () => {

// Test view for injecting rendered components
// and testing specific JavaScript configurations
// Example view
app.get('/tests/boilerplate', function (req, res) {
res.render('tests/boilerplate')
const componentName = undefined

// Render blank component preview
res.send(renderPreview(componentName, { env }))
})

// Full page example views
Expand Down
5 changes: 4 additions & 1 deletion packages/govuk-frontend-review/src/common/middleware/assets.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ const frontendPath = packageTypeToPath('govuk-frontend', {

router.use('/assets', express.static(join(frontendPath, 'assets')))
router.use('/javascripts', express.static(frontendPath))
router.use('/stylesheets', express.static(join(paths.app, 'dist/stylesheets')))
router.use('/stylesheets', [
express.static(frontendPath),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question Just to confirm that I understand this change properly: this leads Express to also look in govuk-frontend (however resolved earlier in the file) alongside looking at the built stylesheets from the review app. In turn, this enables it to find the /stylesheets/govuk-frontend.min.css from the boilerplate markup, is that it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah Express.js accepts an array of routes to try in order

Makes sure we can resolve CSS files from both locations:

/stylesheets/govuk-frontend.min.css
/stylesheets/app.min.css

express.static(join(paths.app, 'dist/stylesheets'))
])

export default router
16 changes: 7 additions & 9 deletions packages/govuk-frontend-review/src/common/nunjucks/globals/get-html-code.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,24 @@
import { renderComponent } from '@govuk-frontend/lib/components'
import { render } from '@govuk-frontend/lib/components'
import beautify from 'js-beautify'

/**
* Component HTML code (formatted)
*
* @this {{ env: import('nunjucks').Environment }}
* @param {string} componentName - Component name
* @param {MacroOptions} [params] - Nunjucks macro options (or params)
* @param {MacroRenderOptions} [options] - Nunjucks macro render options
* @returns {string} HTML rendered by the component
*/
export function getHTMLCode(componentName, params) {
const html = renderComponent(componentName, params, {
env: this.env
})
export function getHTMLCode(componentName, options) {
const html = render(componentName, { ...options, env: this.env })

// Default beautify options
const options = beautify.html.defaultOptions()
const beautifyOptions = beautify.html.defaultOptions()

return beautify.html(html, {
indent_size: 2,
// Ensure nested labels in headings are indented properly
inline: options.inline.filter((tag) => !['label'].includes(tag)),
inline: beautifyOptions.inline.filter((tag) => !['label'].includes(tag)),
// Remove blank lines
max_preserve_newlines: 0,
// Ensure attribute wrapping in header SVG is preserved
Expand All @@ -29,5 +27,5 @@ export function getHTMLCode(componentName, params) {
}

/**
* @typedef {import('@govuk-frontend/lib/components').MacroOptions} MacroOptions
* @typedef {import('@govuk-frontend/lib/components').MacroRenderOptions} MacroRenderOptions
*/
8 changes: 4 additions & 4 deletions packages/govuk-frontend-review/src/common/nunjucks/globals/get-nunjucks-code.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ import { componentNameToMacroName } from '../filters/index.mjs'
* Component Nunjucks code (formatted)
*
* @param {string} componentName - Component name
* @param {MacroOptions} [params] - Nunjucks macro options (or params)
* @param {MacroRenderOptions} [options] - Nunjucks macro render options
* @returns {string} Nunjucks code for the component
*/
export function getNunjucksCode(componentName, params) {
export function getNunjucksCode(componentName, options) {
const macroName = componentNameToMacroName(componentName)

// Allow nested HTML strings to wrap at `\n`
const paramsFormatted = inspect(params, {
const paramsFormatted = inspect(options.context, {
compact: false,
depth: Infinity,
maxArrayLength: Infinity,
Expand All @@ -39,5 +39,5 @@ export function getNunjucksCode(componentName, params) {
}

/**
* @typedef {import('@govuk-frontend/lib/components').MacroOptions} MacroOptions
* @typedef {import('@govuk-frontend/lib/components').MacroRenderOptions} MacroRenderOptions
*/
8 changes: 6 additions & 2 deletions packages/govuk-frontend-review/src/views/macros/showExamples.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,16 @@
{% set codeExamplesHtml %}
<h4 class="govuk-heading-s">Markup</h4>
<pre class="app-code"><code tabindex="0" class="app-code__container hljs language-html">
{{- getHTMLCode(componentName, example.options) | highlight("html") | safe -}}
{{- getHTMLCode(componentName, {
context: example.options
}) | highlight("html") | safe -}}
</code></pre>

<h4 class="govuk-heading-s">Macro</h4>
<pre class="app-code"><code tabindex="0" class="app-code__container hljs language-js">
{{- getNunjucksCode(componentName, example.options) | highlight("js") | safe -}}
{{- getNunjucksCode(componentName, {
context: example.options
}) | highlight("js") | safe -}}
</code></pre>
{% endset %}

Expand Down
25 changes: 0 additions & 25 deletions packages/govuk-frontend-review/src/views/tests/boilerplate.njk
View file
Open in desktop

This file was deleted.

10 changes: 5 additions & 5 deletions packages/govuk-frontend/src/govuk/components/accordion/accordion.puppeteer.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const {
goToComponent,
goToExample,
renderAndInitialise,
render,
getAccessibleName
} = require('@govuk-frontend/helpers/puppeteer')
const { getExamples } = require('@govuk-frontend/lib/components')
Expand Down Expand Up @@ -685,7 +685,7 @@ describe('/components/accordion', () => {
})

it('injects the localised strings as text not HTML', async () => {
await renderAndInitialise(page, 'accordion', examples.default, {
await render(page, 'accordion', examples.default, {
config: {
i18n: {
showAllSections: 'Show <strong>all sections</strong>',
Expand Down Expand Up @@ -721,7 +721,7 @@ describe('/components/accordion', () => {

it('throws when GOV.UK Frontend is not supported', async () => {
await expect(
renderAndInitialise(page, 'accordion', examples.default, {
render(page, 'accordion', examples.default, {
beforeInitialisation() {
document.body.classList.remove('govuk-frontend-supported')
}
Expand All @@ -734,7 +734,7 @@ describe('/components/accordion', () => {

it('throws when $module is not set', async () => {
await expect(
renderAndInitialise(page, 'accordion', examples.default, {
render(page, 'accordion', examples.default, {
beforeInitialisation($module) {
$module.remove()
}
Expand All @@ -747,7 +747,7 @@ describe('/components/accordion', () => {

it('throws when receiving the wrong type for $module', async () => {
await expect(
renderAndInitialise(page, 'accordion', examples.default, {
render(page, 'accordion', examples.default, {
beforeInitialisation($module) {
// Replace with an `<svg>` element which is not an `HTMLElement` in the DOM (but an `SVGElement`)
$module.outerHTML = `<svg data-module="govuk-accordion"></svg>`
Expand Down
28 changes: 10 additions & 18 deletions packages/govuk-frontend/src/govuk/components/button/button.puppeteer.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
const {
goToComponent,
renderAndInitialise
} = require('@govuk-frontend/helpers/puppeteer')
const { goToComponent, render } = require('@govuk-frontend/helpers/puppeteer')
const { getExamples } = require('@govuk-frontend/lib/components')

describe('/components/button', () => {
Expand Down Expand Up @@ -178,7 +175,7 @@ describe('/components/button', () => {
let $button

beforeEach(async () => {
await renderAndInitialise(page, 'button', examples.default, {
await render(page, 'button', examples.default, {
config: {
preventDoubleClick: true
}
Expand Down Expand Up @@ -237,16 +234,11 @@ describe('/components/button', () => {
let $button

beforeEach(async () => {
await renderAndInitialise(
page,
'button',
examples["don't prevent double click"],
{
config: {
preventDoubleClick: true
}
await render(page, 'button', examples["don't prevent double click"], {
config: {
preventDoubleClick: true
}
)
})

$button = await setButtonTracking(await page.$('button'))
})
Expand All @@ -266,7 +258,7 @@ describe('/components/button', () => {
let $button

beforeEach(async () => {
await renderAndInitialise(page, 'button', examples.default, {
await render(page, 'button', examples.default, {
config: {
preventDoubleClick: true
}
Expand Down Expand Up @@ -329,7 +321,7 @@ describe('/components/button', () => {

it('throws when GOV.UK Frontend is not supported', async () => {
await expect(
renderAndInitialise(page, 'button', examples.default, {
render(page, 'button', examples.default, {
beforeInitialisation() {
document.body.classList.remove('govuk-frontend-supported')
}
Expand All @@ -342,7 +334,7 @@ describe('/components/button', () => {

it('throws when $module is not set', async () => {
await expect(
renderAndInitialise(page, 'button', examples.default, {
render(page, 'button', examples.default, {
beforeInitialisation($module) {
$module.remove()
}
Expand All @@ -355,7 +347,7 @@ describe('/components/button', () => {

it('throws when receiving the wrong type for $module', async () => {
await expect(
renderAndInitialise(page, 'button', examples.default, {
render(page, 'button', examples.default, {
beforeInitialisation($module) {
// Replace with an `<svg>` element which is not an `HTMLElement` in the DOM (but an `SVGElement`)
$module.outerHTML = `<svg data-module="govuk-button"></svg>`
Expand Down
7 changes: 2 additions & 5 deletions packages/govuk-frontend/src/govuk/components/character-count/character-count.jsdom.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { getExamples, renderComponent } from '@govuk-frontend/lib/components'
import { getExamples, render } from '@govuk-frontend/lib/components'

import { CharacterCount } from './character-count.mjs'

Expand All @@ -7,10 +7,7 @@ describe('CharacterCount', () => {

beforeAll(async () => {
const examples = await getExamples('character-count')
html = renderComponent(
'character-count',
examples['to configure in JavaScript']
)
html = render('character-count', examples['to configure in JavaScript'])
})

beforeEach(async () => {
Expand Down
Loading