Move component helpers into @govuk-frontend/lib/components

alphagov · Oct 13, 2023 · 5e4c831 · 5e4c831
1 parent 003fbb0
commit 5e4c831
Show file tree

Hide file tree

Showing 37 changed files with 57 additions and 49 deletions.
diff --git a/packages/govuk-frontend/src/govuk/components/accordion/template.test.js b/packages/govuk-frontend/src/govuk/components/accordion/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Accordion', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/back-link/template.test.js b/packages/govuk-frontend/src/govuk/components/back-link/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('back-link component', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/breadcrumbs/template.test.js b/packages/govuk-frontend/src/govuk/components/breadcrumbs/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Breadcrumbs', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/button/template.test.js b/packages/govuk-frontend/src/govuk/components/button/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Button', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/character-count/template.test.js b/packages/govuk-frontend/src/govuk/components/character-count/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/checkboxes/template.test.js b/packages/govuk-frontend/src/govuk/components/checkboxes/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/cookie-banner/template.test.js b/packages/govuk-frontend/src/govuk/components/cookie-banner/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Cookie Banner', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/date-input/template.test.js b/packages/govuk-frontend/src/govuk/components/date-input/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/details/template.test.js b/packages/govuk-frontend/src/govuk/components/details/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Details', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/error-message/template.test.js b/packages/govuk-frontend/src/govuk/components/error-message/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Error message', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/error-summary/template.test.js b/packages/govuk-frontend/src/govuk/components/error-summary/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Error-summary', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/exit-this-page/template.test.js b/packages/govuk-frontend/src/govuk/components/exit-this-page/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Exit this page', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/fieldset/template.test.js b/packages/govuk-frontend/src/govuk/components/fieldset/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('fieldset', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/file-upload/template.test.js b/packages/govuk-frontend/src/govuk/components/file-upload/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/footer/template.test.js b/packages/govuk-frontend/src/govuk/components/footer/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('footer', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/header/template.test.js b/packages/govuk-frontend/src/govuk/components/header/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('header', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/hint/template.test.js b/packages/govuk-frontend/src/govuk/components/hint/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Hint', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/input/template.test.js b/packages/govuk-frontend/src/govuk/components/input/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/inset-text/template.test.js b/packages/govuk-frontend/src/govuk/components/inset-text/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Inset text', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/label/template.test.js b/packages/govuk-frontend/src/govuk/components/label/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Label', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/notification-banner/template.test.js b/packages/govuk-frontend/src/govuk/components/notification-banner/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Notification-banner', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/pagination/template.test.js b/packages/govuk-frontend/src/govuk/components/pagination/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Pagination', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/panel/template.test.js b/packages/govuk-frontend/src/govuk/components/panel/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Panel', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/phase-banner/template.test.js b/packages/govuk-frontend/src/govuk/components/phase-banner/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/radios/template.test.js b/packages/govuk-frontend/src/govuk/components/radios/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/select/template.test.js b/packages/govuk-frontend/src/govuk/components/select/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/skip-link/template.test.js b/packages/govuk-frontend/src/govuk/components/skip-link/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Skip link', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/summary-list/template.test.js b/packages/govuk-frontend/src/govuk/components/summary-list/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Summary list', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/table/template.test.js b/packages/govuk-frontend/src/govuk/components/table/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Table', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/tabs/template.test.js b/packages/govuk-frontend/src/govuk/components/tabs/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Tabs', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/tag/template.test.js b/packages/govuk-frontend/src/govuk/components/tag/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Tag', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/task-list/template.test.js b/packages/govuk-frontend/src/govuk/components/task-list/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Task List', () => {

diff --git a/packages/govuk-frontend/src/govuk/components/textarea/template.test.js b/packages/govuk-frontend/src/govuk/components/textarea/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { htmlWithClassName } = require('@govuk-frontend/helpers/tests')
 const { getExamples } = require('@govuk-frontend/lib/components')
 

diff --git a/packages/govuk-frontend/src/govuk/components/warning-text/template.test.js b/packages/govuk-frontend/src/govuk/components/warning-text/template.test.js
@@ -1,4 +1,4 @@
-const { render } = require('@govuk-frontend/helpers/nunjucks')
+const { render } = require('@govuk-frontend/helpers/components')
 const { getExamples } = require('@govuk-frontend/lib/components')
 
 describe('Warning text', () => {

diff --git a/shared/helpers/components.js b/shared/helpers/components.js
@@ -0,0 +1,21 @@
+const components = require('@govuk-frontend/lib/components')
+const cheerio = require('cheerio')
+
+/**
+ * Render component HTML into cheerio
+ *
+ * @param {string} componentName - Component name
+ * @param {MacroRenderOptions} [options] - Nunjucks macro render options
+ * @returns {import('cheerio').CheerioAPI} HTML rendered by the macro
+ */
+function render(componentName, options) {
+  return cheerio.load(components.render(componentName, options))
+}
+
+module.exports = {
+  render
+}
+
+/**
+ * @typedef {import('@govuk-frontend/lib/nunjucks').MacroRenderOptions} MacroRenderOptions
+ */
diff --git a/shared/helpers/index.js b/shared/helpers/index.js
@@ -1,3 +1,4 @@
+const components = require('./components')
 const nunjucks = require('./nunjucks')
 const puppeteer = require('./puppeteer')
 const tests = require('./tests')
@@ -6,6 +7,7 @@ const tests = require('./tests')
  * Helpers
  */
 module.exports = {
+  components,
   nunjucks,
   puppeteer,
   tests

diff --git a/shared/helpers/nunjucks.js b/shared/helpers/nunjucks.js
@@ -1,18 +1,6 @@
-const components = require('@govuk-frontend/lib/components')
 const nunjucks = require('@govuk-frontend/lib/nunjucks')
 const cheerio = require('cheerio')
 
-/**
- * Render component HTML into cheerio
- *
- * @param {string} componentName - Component name
- * @param {MacroRenderOptions} [options] - Nunjucks macro render options
- * @returns {import('cheerio').CheerioAPI} HTML rendered by the macro
- */
-function render(componentName, options) {
-  return cheerio.load(components.render(componentName, options))
-}
-
 /**
  * Render template HTML into cheerio
  *
@@ -25,12 +13,9 @@ function renderTemplate(templatePath, options) {
 }
 
 module.exports = {
-  render,
   renderTemplate
 }
 
 /**
- * @typedef {import('@govuk-frontend/lib/nunjucks').MacroOptions} MacroOptions
- * @typedef {import('@govuk-frontend/lib/nunjucks').MacroRenderOptions} MacroRenderOptions
  * @typedef {import('@govuk-frontend/lib/nunjucks').TemplateRenderOptions} TemplateRenderOptions
  */