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

Fix settings layer being implicitly dependant on itself #1381

Merged
merged 4 commits into from
May 28, 2019
Merged

Fix settings layer being implicitly dependant on itself #1381

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
4b74fb0
Refactor Sass to use renderSass jest helper
NickColley May 28, 2019
513d29a
Add tests to ensure all layers can be compiled individually
NickColley May 28, 2019
d26d331
Ensure settings layer imports it's dependencies
NickColley May 28, 2019
22532e6
Add CHANGELOG entry
NickColley May 28, 2019
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,10 @@

🔧 Fixes:

- Fix settings layer being implicitly dependant on itself.

([PR #1381](https://github.com/alphagov/govuk-frontend/pull/1381))

- Fix improperly indented html output in Design System examples

Thanks to [Debs](https://github.com/debsdee) and [Joe](https://github.com/joelanman) for raising this issue.
Expand Down
15 changes: 4 additions & 11 deletions src/all.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
/* eslint-env jest */

const util = require('util')

const configPaths = require('../config/paths.json')
const PORT = configPaths.ports.test

const sass = require('node-sass')
const sassRender = util.promisify(sass.render)

const sassConfig = {
includePaths: [ configPaths.src ]
}
const { renderSass } = require('../lib/jest-helpers')

let baseUrl = 'http://localhost:' + PORT

Expand Down Expand Up @@ -105,7 +98,7 @@ describe('GOV.UK Frontend', () => {
const sass = `
@import "all";
`
const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass })
expect(results.css.toString()).not.toContain(', a {')
expect(results.css.toString()).not.toContain(', p {')
})
Expand All @@ -114,7 +107,7 @@ describe('GOV.UK Frontend', () => {
$govuk-global-styles: true;
@import "all";
`
const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass })
expect(results.css.toString()).toContain(', a {')
expect(results.css.toString()).toContain(', p {')
})
Expand Down Expand Up @@ -153,7 +146,7 @@ describe('GOV.UK Frontend', () => {
it('does not contain any unexpected govuk- function calls', async () => {
const sass = `@import "all"`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass })
const css = results.css.toString()

const functionCalls = css.match(/_?govuk-[\w-]+\(.*?\)/g)
Expand Down
38 changes: 16 additions & 22 deletions src/helpers/colour.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
/* eslint-env jest */

const util = require('util')

const configPaths = require('../../config/paths.json')

const sass = require('node-sass')
const sassRender = util.promisify(sass.render)
const { renderSass } = require('../../lib/jest-helpers')

const sassConfig = {
includePaths: [ configPaths.src ],
outputStyle: 'compact'
}

Expand All @@ -35,7 +29,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('red');
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #ff0000; }')
})
Expand All @@ -48,7 +42,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour(red);
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #ff0000; }')
})
Expand All @@ -61,7 +55,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('hooloovoo');
}`

await expect(sassRender({ data: sass, ...sassConfig }))
await expect(renderSass({ data: sass, ...sassConfig }))
.rejects
.toThrow(
'Unknown colour `hooloovoo`'
Expand All @@ -84,7 +78,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('red', $legacy: 'blue');
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #0000ff; }')
})
Expand All @@ -97,7 +91,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('red', $legacy: #BADA55);
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #BADA55; }')
})
Expand All @@ -110,7 +104,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('hooloovoo', $legacy: 'blue');
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #0000ff; }')
})
Expand All @@ -122,7 +116,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('red', $legacy: 'hooloovoo');
}`

await expect(sassRender({ data: sass, ...sassConfig }))
await expect(renderSass({ data: sass, ...sassConfig }))
.rejects
.toThrow(
'Unknown colour `hooloovoo`'
Expand All @@ -146,7 +140,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('red', $legacy: 'blue');
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #ff0000; }')
})
Expand All @@ -159,7 +153,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('red', $legacy: #BADA55);
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #ff0000; }')
})
Expand All @@ -172,7 +166,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('hooloovoo', $legacy: 'blue');
}`

await expect(sassRender({ data: sass, ...sassConfig }))
await expect(renderSass({ data: sass, ...sassConfig }))
.rejects
.toThrow(
'Unknown colour `hooloovoo`'
Expand All @@ -187,7 +181,7 @@ describe('@function govuk-colour', () => {
color: govuk-colour('red', $legacy: 'hooloovoo');
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #ff0000; }')
})
Expand Down Expand Up @@ -217,7 +211,7 @@ describe('@function govuk-organisation-colour', () => {
color: govuk-organisation-colour('floo-network-authority');
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #9A00A8; }')
})
Expand All @@ -230,7 +224,7 @@ describe('@function govuk-organisation-colour', () => {
color: govuk-organisation-colour('broom-regulatory-control');
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { color: #A81223; }')
})
Expand All @@ -243,7 +237,7 @@ describe('@function govuk-organisation-colour', () => {
border-color: govuk-organisation-colour('floo-network-authority', $websafe: false);
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe('.foo { border-color: #EC22FF; }')
})
Expand All @@ -256,7 +250,7 @@ describe('@function govuk-organisation-colour', () => {
color: govuk-organisation-colour('muggle-born-registration-commission');
}`

await expect(sassRender({ data: sass, ...sassConfig }))
await expect(renderSass({ data: sass, ...sassConfig }))
.rejects
.toThrow(
'Unknown organisation `muggle-born-registration-commission`'
Expand Down
22 changes: 9 additions & 13 deletions src/helpers/grid.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
/* eslint-env jest */

const util = require('util')
const outdent = require('outdent')

const configPaths = require('../../config/paths.json')

const sass = require('node-sass')
const sassRender = util.promisify(sass.render)
const { renderSass } = require('../../lib/jest-helpers')

const sassConfig = {
includePaths: [ configPaths.src ],
outputStyle: 'nested'
}

describe('grid system', () => {
const sassImports = `
@import "settings/ie8";
Expand All @@ -33,7 +29,7 @@ describe('grid system', () => {
content: govuk-grid-width(one-quarter);
}`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css.toString().trim()).toBe(outdent`
.foo {
Expand All @@ -47,7 +43,7 @@ describe('grid system', () => {
$value: govuk-grid-width(seven-fifths);
`

await expect(sassRender({ data: sass, ...sassConfig }))
await expect(renderSass({ data: sass, ...sassConfig }))
.rejects
.toThrow('Unknown grid width `seven-fifths`')
})
Expand All @@ -63,7 +59,7 @@ describe('grid system', () => {
}
`

const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css
.toString()
Expand All @@ -87,7 +83,7 @@ describe('grid system', () => {
@include govuk-grid-column(two-thirds);
}
`
const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css
.toString()
Expand All @@ -112,7 +108,7 @@ describe('grid system', () => {
@include govuk-grid-column(one-quarter, $at: desktop);
}
`
const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css
.toString()
Expand All @@ -135,7 +131,7 @@ describe('grid system', () => {
@include govuk-grid-column(one-quarter, $at: 500px);
}
`
const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css
.toString()
Expand All @@ -160,7 +156,7 @@ describe('grid system', () => {
@include govuk-grid-column(one-half, $float: right);
}
`
const results = await sassRender({ data: sass, ...sassConfig })
const results = await renderSass({ data: sass, ...sassConfig })

expect(results.css
.toString()
Expand Down
13 changes: 9 additions & 4 deletions src/helpers/helpers.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
/* eslint-env jest */

const path = require('path')
const util = require('util')

const sass = require('node-sass')
const sassRender = util.promisify(sass.render)
const glob = require('glob')

const { renderSass } = require('../../lib/jest-helpers')
const configPaths = require('../../config/paths.json')

const sassFiles = glob.sync(`${configPaths.src}/helpers/**/*.scss`)

describe('The helpers layer', () => {
it('should not output any CSS', async () => {
const helpers = path.join(configPaths.src, 'helpers', '_all.scss')

const output = await sassRender({ file: helpers })
const output = await renderSass({ file: helpers })
expect(output.css.toString()).toEqual('')
})

it.each(sassFiles)('%s renders to CSS without errors', (file) => {
return renderSass({ file: file })
})
})
Loading