Move Common templates to the Common templates plugin

CHANGELOG.md

@@ -7,6 +7,9 @@
 - [#1915: Move Task list template to Task list plugin](https://github.com/alphagov/govuk-prototype-kit/pull/1915)
   The Task list template has been moved to the new
   [Task list plugin](https://github.com/alphagov/govuk-prototype-kit-task-list)
+- [#1923: Move Common templates to Common templates plugin](https://github.com/alphagov/govuk-prototype-kit/pull/1923)
+  The Common templates have been moved to the new
+  [Common templates plugin](https://github.com/alphagov/govuk-prototype-kit-common-templates)
 
 ## 13.2.4
 

bin/cli

@@ -234,7 +234,7 @@ async function runCreate () {
 
   progressLogger('Installing dependencies')
 
-  await npmInstall(installDirectory, [kitDependency, 'govuk-frontend'])
+  await npmInstall(installDirectory, [kitDependency, 'govuk-frontend', '@govuk-prototype-kit/common-templates'])
 
   let runningWithinCreateScriptFlag = '--running-within-create-script'
 

cypress/e2e/plugins/1-available-plugins-tests/available-plugins.cypress.js

@@ -0,0 +1,91 @@
+// local dependencies
+const { waitForApplication, uninstallPlugin } = require('../../utils')
+
+const managePluginsPagePath = '/manage-prototype/plugins'
+const manageTemplatesPagePath = '/manage-prototype/templates'
+const panelCompleteQuery = '[aria-live="polite"] #panel-complete'
+
+async function loadPluginsPage () {
+  cy.task('log', 'Visit the manage prototype plugins page')
+  await waitForApplication(managePluginsPagePath)
+}
+
+async function loadTemplatesPage () {
+  cy.task('log', 'Visit the manage prototype templates page')
+  await waitForApplication(manageTemplatesPagePath)
+}
+
+async function installPluginTests ({ plugin, templates }) {
+  describe(plugin, () => {
+    before(() => {
+      uninstallPlugin(plugin)
+      cy.wait(4000)
+    })
+
+    beforeEach(() => {
+      cy.wait(4000)
+    })
+
+    it(`The ${plugin} plugin templates are not available`, () => {
+      loadTemplatesPage()
+      cy.get(`[data-plugin-package-name="${plugin}"]`).should('not.exist')
+    })
+
+    it(`Install the ${plugin} plugin`, () => {
+      loadPluginsPage()
+      cy.task('log', `Install the ${plugin} plugin`)
+      cy.get(`button[formaction*="/install?package=${encodeURIComponent(plugin)}"]`)
+        .contains('Install').click()
+
+      cy.get(panelCompleteQuery, { timeout: 20000 })
+        .should('be.visible')
+      cy.get('a').contains('Back to plugins').click()
+
+      cy.get(`button[formaction*="/uninstall?package=${encodeURIComponent(plugin)}"]`)
+        .contains('Uninstall')
+    })
+
+    it(`The ${plugin} plugin templates are available`, () => {
+      loadTemplatesPage()
+      cy.get(`[data-plugin-package-name="${plugin}"]`).should('exist')
+    })
+
+    templates.forEach(({ name, filename }) => {
+      it(`View ${name} template`, () => {
+        loadTemplatesPage()
+        cy.get(`[data-plugin-package-name="${plugin}"] a`).contains(`View ${name} page`).click()
+        cy.url().then(url => expect(url).to.contain(filename))
+      })
+    })
+
+    it(`Uninstall the ${plugin} plugin`, () => {
+      loadPluginsPage()
+      cy.task('log', `Uninstall the ${plugin} plugin`)
+      cy.get(`button[formaction*="/uninstall?package=${encodeURIComponent(plugin)}"]`)
+        .contains('Uninstall').click()
+
+      cy.get(panelCompleteQuery, { timeout: 20000 })
+        .should('be.visible')
+      cy.get('a').contains('Back to plugins').click()
+
+      cy.get(`button[formaction*="/install?package=${encodeURIComponent(plugin)}"]`)
+        .contains('Install')
+    })
+  })
+}
+
+describe('Plugin tests', () => {
+  installPluginTests({
+    plugin: '@govuk-prototype-kit/common-templates',
+    templates: [
+      { name: 'Blank GOV.UK', filename: 'blank-govuk.html' },
+      { name: 'Blank unbranded', filename: 'blank-unbranded.html' },
+      { name: 'Check answers', filename: 'check-answers.html' },
+      { name: 'Confirmation', filename: 'confirmation.html' },
+      { name: 'Content', filename: 'content.html' },
+      { name: 'Mainstream guide', filename: 'mainstream-guide.html' },
+      { name: 'Start', filename: 'start.html' },
+      { name: 'Question', filename: 'question.html' }
+    ]
+  })
+})

cypress/e2e/plugins/1-available-plugins-tests/install-common-templates-plugin-from-templates-page.cypress.js

@@ -0,0 +1,31 @@
+const { waitForApplication, uninstallPlugin } = require('../../utils')
+
+const manageTemplatesPagePath = '/manage-prototype/templates'
+const panelCompleteQuery = '[aria-live="polite"] #panel-complete'
+const plugin = '@govuk-prototype-kit/common-templates'
+
+async function loadTemplatesPage () {
+  cy.task('log', 'Visit the manage prototype templates page')
+  await waitForApplication(manageTemplatesPagePath)
+}
+
+describe('Install common templates from templates page', () => {
+  before(() => {
+    uninstallPlugin(plugin)
+    cy.wait(4000)
+  })
+
+  it('install', () => {
+    loadTemplatesPage()
+    cy.get('a').contains('Install common templates').click()
+
+    cy.get(panelCompleteQuery, { timeout: 20000 })
+      .should('be.visible')
+
+    cy.get('a').contains('Back to templates').click()
+
+    cy.get(`[data-plugin-package-name="${plugin}"]`).contains('Common Templates')
+
+    cy.get('a.govuk-button').should('not.exist')
+  })
+})

govuk-prototype-kit.config.json

@@ -14,47 +14,5 @@
   "importNunjucksMacrosInto": [
     "/lib/nunjucks/govuk-prototype-kit/layouts/govuk-branded.html",
     "/lib/nunjucks/govuk-prototype-kit/layouts/unbranded.html"
-  ],
-  "templates": [
-    {
-      "name": "Blank GOV.UK page",
-      "path": "/lib/nunjucks/templates/blank-govuk.html",
-      "type": "nunjucks"
-    },
-    {
-      "name": "Blank unbranded page",
-      "path": "/lib/nunjucks/templates/blank-unbranded.html",
-      "type":  "nunjucks"
-    },
-    {
-      "name": "Start page",
-      "path": "/lib/nunjucks/templates/start.html",
-      "type":  "nunjucks"
-    },
-    {
-      "name": "Question page",
-      "path": "/lib/nunjucks/templates/question.html",
-      "type":  "nunjucks"
-    },
-    {
-      "name": "Content page",
-      "path": "/lib/nunjucks/templates/content.html",
-      "type":  "nunjucks"
-    },
-    {
-      "name": "Check answers page",
-      "path": "/lib/nunjucks/templates/check-answers.html",
-      "type":  "nunjucks"
-    },
-    {
-      "name": "Confirmation page",
-      "path": "/lib/nunjucks/templates/confirmation.html",
-      "type":  "nunjucks"
-    },
-    {
-      "name": "Mainstream guide page",
-      "path": "/lib/nunjucks/templates/mainstream-guide.html",
-      "type":  "nunjucks"
-    }
   ]
 }

known-plugins.json

@@ -2,6 +2,7 @@
   "plugins": {
     "available": [
       "govuk-frontend",
+      "@govuk-prototype-kit/common-templates",
       "@govuk-prototype-kit/step-by-step",
       "@govuk-prototype-kit/task-list",
       "hmrc-frontend",

lib/manage-prototype-handlers.js

@@ -210,10 +210,22 @@ function getPluginTemplates () {
 
 function getTemplatesHandler (req, res) {
   const pageName = 'Templates'
+  const availableTemplates = getPluginTemplates()
+
+  const commonTemplatesPackageName = '@govuk-prototype-kit/common-templates'
+  let commonTemplatesDetails
+  if (!availableTemplates.some(plugin => plugin.packageName === commonTemplatesPackageName)) {
+    commonTemplatesDetails = {
+      pluginDisplayName: plugins.preparePackageNameForDisplay(commonTemplatesPackageName),
+      installLink: `${contextPath}/plugins/install?package=${encodeURIComponent(commonTemplatesPackageName)}&returnTo=templates`
+    }
+  }
+
   res.render(getManagementView('templates.njk'), {
     currentPage: pageName,
     links: managementLinks,
-    availableTemplates: getPluginTemplates()
+    availableTemplates,
+    commonTemplatesDetails
   })
 }
 
@@ -506,6 +518,16 @@ async function getPluginsModeHandler (req, res) {
 
   const pageName = `${verb.title} ${chosenPlugin.name}`
 
+  const returnLink = req.query.returnTo === 'templates'
+    ? {
+        href: '/manage-prototype/templates',
+        text: 'Back to templates'
+      }
+    : {
+        href: '/manage-prototype/plugins',
+        text: 'Back to plugins'
+      }
+
   res.render(getManagementView('plugin-install-or-uninstall.njk'), {
     currentPage: pageName,
     currentUrl: req.originalUrl,
@@ -514,7 +536,8 @@ async function getPluginsModeHandler (req, res) {
     command: getCommand(mode, chosenPlugin),
     verb,
     isSameOrigin,
-    csrfToken: req.csrfToken()
+    csrfToken: req.csrfToken(),
+    returnLink
   })
 }
 

lib/manage-prototype-handlers.test.js

@@ -394,7 +394,11 @@ describe('manage-prototype-handlers', () => {
           csrfToken,
           currentPage: `Install ${pluginDisplayName.name}`,
           currentUrl: req.originalUrl,
-          isSameOrigin: false
+          isSameOrigin: false,
+          returnLink: {
+            href: '/manage-prototype/plugins',
+            text: 'Back to plugins'
+          }
         })
       )
     })