Support Prototype Kit v13 #2851
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import { join, relative } from 'path' | ||
| import slash from 'slash' | ||
|
|
||
| import { filterPath, getDirectories, getListing } from '../../lib/file-helper.js' | ||
| import { componentNameToMacroName } from '../../lib/helper-functions.js' | ||
| import configPaths from '../../config/paths.js' | ||
|
|
||
| /** | ||
| * GOV.UK Prototype Kit config builder | ||
| */ | ||
| export default async () => { | ||
| const componentsFiles = await getListing(configPaths.components) | ||
| const componentNames = await getDirectories(configPaths.components) | ||
|
|
||
| // Build array of macros | ||
| const nunjucksMacros = componentNames | ||
| .map((componentName) => { | ||
| const [macroPath] = componentsFiles | ||
| .filter(filterPath([`${componentName}/macro.njk`])) | ||
|
|
||
| // Relative path to src without 'govuk' | ||
| const rootPath = join(configPaths.src, '../') | ||
|
|
||
| return { | ||
| importFrom: slash(relative(rootPath, join(configPaths.components, macroPath))), | ||
| macroName: componentNameToMacroName(componentName) | ||
| } | ||
| }) | ||
|
|
||
| return { | ||
| assets: [ | ||
| '/govuk/assets' | ||
| ], | ||
| sass: [ | ||
| '/govuk-prototype-kit/init.scss' | ||
| ], | ||
| scripts: [ | ||
| '/govuk/all.js', | ||
| '/govuk-prototype-kit/init.js' | ||
| ], | ||
| nunjucksMacros, | ||
| nunjucksPaths: ['/'] | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| import configFn from './govuk-prototype-kit.config.mjs' | ||
colinrotherham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| describe('GOV.UK Prototype Kit config', () => { | ||
| let config | ||
|
|
||
| beforeAll(async () => { | ||
| config = await configFn() | ||
| }) | ||
|
|
||
| it('includes paths for assets, scripts, sass', () => { | ||
| expect(config.assets).toEqual([ | ||
| '/govuk/assets' | ||
| ]) | ||
|
|
||
| expect(config.sass).toEqual([ | ||
| '/govuk-prototype-kit/init.scss' | ||
| ]) | ||
|
|
||
| expect(config.scripts).toEqual([ | ||
| '/govuk/all.js', | ||
| '/govuk-prototype-kit/init.js' | ||
| ]) | ||
| }) | ||
|
|
||
| describe('Nunjucks', () => { | ||
| it('includes macros list', () => { | ||
| expect(config.nunjucksMacros).toEqual([ | ||
|
There was a problem hiding this comment. This doesn't quite feel like it's testing the right thing – if we added a new component and (somehow) the code we'd written meant that it didn't get added to the list of macro imports, the tests would still pass. Conversely, as currently written this test will fail every time we add a new component. Would it make sense to either test that the macros lists includes all current components, or stub out There was a problem hiding this comment. Don't mind at all But yep, new components will automatically break this test I lifted and shifted the old We use It'll get stale and miss new components but at least tests won't fail There was a problem hiding this comment. Depending on what we decide to do re my other comment, I think I'd be inclined to stub out |
||
| { | ||
| importFrom: 'govuk/components/accordion/macro.njk', | ||
| macroName: 'govukAccordion' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/back-link/macro.njk', | ||
| macroName: 'govukBackLink' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/breadcrumbs/macro.njk', | ||
| macroName: 'govukBreadcrumbs' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/button/macro.njk', | ||
| macroName: 'govukButton' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/character-count/macro.njk', | ||
| macroName: 'govukCharacterCount' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/checkboxes/macro.njk', | ||
| macroName: 'govukCheckboxes' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/cookie-banner/macro.njk', | ||
| macroName: 'govukCookieBanner' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/date-input/macro.njk', | ||
| macroName: 'govukDateInput' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/details/macro.njk', | ||
| macroName: 'govukDetails' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/error-message/macro.njk', | ||
| macroName: 'govukErrorMessage' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/error-summary/macro.njk', | ||
| macroName: 'govukErrorSummary' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/fieldset/macro.njk', | ||
| macroName: 'govukFieldset' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/file-upload/macro.njk', | ||
| macroName: 'govukFileUpload' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/footer/macro.njk', | ||
| macroName: 'govukFooter' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/header/macro.njk', | ||
| macroName: 'govukHeader' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/hint/macro.njk', | ||
| macroName: 'govukHint' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/input/macro.njk', | ||
| macroName: 'govukInput' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/inset-text/macro.njk', | ||
| macroName: 'govukInsetText' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/label/macro.njk', | ||
| macroName: 'govukLabel' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/notification-banner/macro.njk', | ||
| macroName: 'govukNotificationBanner' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/pagination/macro.njk', | ||
| macroName: 'govukPagination' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/panel/macro.njk', | ||
| macroName: 'govukPanel' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/phase-banner/macro.njk', | ||
| macroName: 'govukPhaseBanner' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/radios/macro.njk', | ||
| macroName: 'govukRadios' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/select/macro.njk', | ||
| macroName: 'govukSelect' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/skip-link/macro.njk', | ||
| macroName: 'govukSkipLink' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/summary-list/macro.njk', | ||
| macroName: 'govukSummaryList' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/table/macro.njk', | ||
| macroName: 'govukTable' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/tabs/macro.njk', | ||
| macroName: 'govukTabs' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/tag/macro.njk', | ||
| macroName: 'govukTag' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/textarea/macro.njk', | ||
| macroName: 'govukTextarea' | ||
| }, | ||
| { | ||
| importFrom: 'govuk/components/warning-text/macro.njk', | ||
| macroName: 'govukWarningText' | ||
| } | ||
| ]) | ||
| }) | ||
|
|
||
| it('includes paths', () => { | ||
| expect(config.nunjucksPaths).toEqual(['/']) | ||
| }) | ||
| }) | ||
| }) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| if (window.GOVUKPrototypeKit && | ||
| window.GOVUKPrototypeKit.documentReady && | ||
| window.GOVUKPrototypeKit.majorVersion >= 13) { | ||
| window.GOVUKPrototypeKit.documentReady(function () { | ||
| window.GOVUKFrontend.initAll() | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| $govuk-prototype-kit-major-version: 0 !default; | ||
|
|
||
| $govuk-assets-path: if( | ||
| $govuk-prototype-kit-major-version > 12, | ||
| $govuk-extensions-url-context + "/govuk-frontend/govuk/assets/", | ||
| "/govuk/assets/" | ||
| ) !default; | ||
|
|
||
| $govuk-global-styles: true !default; | ||
| $govuk-new-link-styles: true !default; | ||
|
|
||
| @import "../govuk/all"; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah-ah!
Separator of the universe
Slash
Ah-ah!
He'll separate out the filesystem!
(That was in my head and I wanted to share it with you)