Lint JavaScript

x-govuk · Dec 15, 2023 · bea4a14 · bea4a14
1 parent 4308e86
commit bea4a14
Show file tree

Hide file tree

Showing 14 changed files with 96 additions and 59 deletions.
diff --git a/lib/extensions/address.js b/lib/extensions/address.js
@@ -7,17 +7,19 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\$A\n(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       return blockTokenizer(this.lexer, src, 'govspeak-address', '$A')
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('address', options)
-      return `<address class="${className}">\n  ${this.parser.parse(tokens)}\n</address>`
+      return `<address class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</address>`
     }
   }
 }
diff --git a/lib/extensions/button.js b/lib/extensions/button.js
@@ -6,11 +6,11 @@ module.exports = function (options) {
 
     level: 'inline',
 
-    start (src) {
+    start(src) {
       return src.match(/{button(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       if (!src.startsWith('{button')) {
         return
       }
@@ -38,7 +38,7 @@ module.exports = function (options) {
       }
     },
 
-    renderer ({ isStartButton, tokens }) {
+    renderer({ isStartButton, tokens }) {
       if (isStartButton) {
         const className = classGenerator('button--start', options)
         return `<a class="${className}" href="${tokens[0].href}" role="button">${tokens[0].text}<svg class="govuk-button__start-icon" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" aria-hidden="true" focusable="false"><path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z"/></svg></a>`

diff --git a/lib/extensions/call-to-action.js b/lib/extensions/call-to-action.js
@@ -7,17 +7,19 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\$CTA(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       return blockTokenizer(this.lexer, src, 'govspeak-call-to-action', '$CTA')
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('call-to-action', options)
-      return `<div class="${className}">\n  ${this.parser.parse(tokens)}\n</div>`
+      return `<div class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</div>`
     }
   }
 }
diff --git a/lib/extensions/contact.js b/lib/extensions/contact.js
@@ -7,17 +7,19 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\$C\n(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       return blockTokenizer(this.lexer, src, 'govspeak-contact', '$C')
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('contact', options)
-      return `<div class="${className}">\n  ${this.parser.parse(tokens)}\n</div>`
+      return `<div class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</div>`
     }
   }
 }
diff --git a/lib/extensions/example.js b/lib/extensions/example.js
@@ -7,17 +7,19 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\$E\n(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       return blockTokenizer(this.lexer, src, 'govspeak-example', '$E')
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('example', options)
-      return `<div class="${className}">\n  ${this.parser.parse(tokens)}\n</div>`
+      return `<div class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</div>`
     }
   }
 }
diff --git a/lib/extensions/form-download.js b/lib/extensions/form-download.js
@@ -7,17 +7,19 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\$D\n(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       return blockTokenizer(this.lexer, src, 'govspeak-form-download', '$D')
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('form-download', options)
-      return `<div class="${className}">\n  ${this.parser.parse(tokens)}\n</div>`
+      return `<div class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</div>`
     }
   }
 }
diff --git a/lib/extensions/information-callout.js b/lib/extensions/information-callout.js
@@ -6,11 +6,11 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\^(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       if (!src.startsWith('^')) {
         return
       }
@@ -25,9 +25,11 @@ module.exports = function (options) {
       }
     },
 
-    renderer ({ text }) {
+    renderer({ text }) {
       const className = classGenerator('information-callout', options)
-      return `<div class="${className}" role="note" aria-label="Information">\n  <p>${this.parser.parseInline(text)}</p>\n</div>`
+      return `<div class="${className}" role="note" aria-label="Information">\n  <p>${this.parser.parseInline(
+        text
+      )}</p>\n</div>`
     }
   }
 }
diff --git a/lib/extensions/information.js b/lib/extensions/information.js
@@ -7,17 +7,19 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\$I\n(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       return blockTokenizer(this.lexer, src, 'govspeak-information', '$I')
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('information', options)
-      return `<div class="${className}">\n  ${this.parser.parse(tokens)}\n</div>`
+      return `<div class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</div>`
     }
   }
 }
diff --git a/lib/extensions/place.js b/lib/extensions/place.js
@@ -7,17 +7,19 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\$C\n(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       return blockTokenizer(this.lexer, src, 'govspeak-place', '$P')
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('place', options)
-      return `<div class="${className}">\n  ${this.parser.parse(tokens)}\n</div>`
+      return `<div class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</div>`
     }
   }
 }
diff --git a/lib/extensions/stat-headline.js b/lib/extensions/stat-headline.js
@@ -7,17 +7,25 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/{stat(?!\s)/)?.index
     },
 
-    tokenizer (src) {
-      return blockTokenizer(this.lexer, src, 'govspeak-stat-headline', '{stat-headline}', '{/stat-headline}')
+    tokenizer(src) {
+      return blockTokenizer(
+        this.lexer,
+        src,
+        'govspeak-stat-headline',
+        '{stat-headline}',
+        '{/stat-headline}'
+      )
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('stat-headline', options)
-      return `<div class="${className}">\n  ${this.parser.parse(tokens)}\n</div>`
+      return `<div class="${className}">\n  ${this.parser.parse(
+        tokens
+      )}\n</div>`
     }
   }
 }
diff --git a/lib/extensions/steps.js b/lib/extensions/steps.js
@@ -6,11 +6,11 @@ module.exports.steps = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/\s*(?:s\d+\.\s.*(?:\n|$))+/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       const rule = /^\s*(?:s\d+\.\s.*(?:\n|$))+/
       const match = rule.exec(src)
       if (match) {
@@ -26,9 +26,11 @@ module.exports.steps = function (options) {
       }
     },
 
-    renderer ({ tokens }) {
+    renderer({ tokens }) {
       const className = classGenerator('steps', options)
-      return `<ol class="${className}">${this.parser.parseInline(tokens)}\n</ol>`
+      return `<ol class="${className}">${this.parser.parseInline(
+        tokens
+      )}\n</ol>`
     }
   }
 }
@@ -39,11 +41,11 @@ module.exports.step = function (_options) {
 
     level: 'inline',
 
-    start (src) {
+    start(src) {
       return src.match(/s(\d+)\./)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       const rule = /s(\d+)\.\s(.*)(?:\n|$)/
       const match = rule.exec(src)
 
@@ -58,7 +60,7 @@ module.exports.step = function (_options) {
       }
     },
 
-    renderer ({ li }) {
+    renderer({ li }) {
       return `\n  <li>${this.parser.parseInline(li)}</li>`
     },
 

diff --git a/lib/extensions/warning-callout.js b/lib/extensions/warning-callout.js
@@ -6,11 +6,11 @@ module.exports = function (options) {
 
     level: 'block',
 
-    start (src) {
+    start(src) {
       return src.match(/%(?!\s)/)?.index
     },
 
-    tokenizer (src) {
+    tokenizer(src) {
       if (!src.startsWith('%')) {
         return
       }
@@ -25,9 +25,11 @@ module.exports = function (options) {
       }
     },
 
-    renderer ({ text }) {
+    renderer({ text }) {
       const className = classGenerator('warning-callout', options)
-      return `<div class="${className}" role="note" aria-label="Warning">\n  <p>${this.parser.parseInline(text)}</p>\n</div>`
+      return `<div class="${className}" role="note" aria-label="Warning">\n  <p>${this.parser.parseInline(
+        text
+      )}</p>\n</div>`
     }
   }
 }
diff --git a/test/compatibility.js b/test/compatibility.js
@@ -4,9 +4,11 @@ const { marked } = require('marked')
 const govspeak = require('../index.js')
 
 describe('Govspeak with RubyGem compatibility', () => {
-  marked.use(govspeak({
-    govspeakGemCompatibility: true
-  }))
+  marked.use(
+    govspeak({
+      govspeakGemCompatibility: true
+    })
+  )
 
   it('Renders address', () => {
     assert.equal(
@@ -32,7 +34,8 @@ describe('Govspeak with RubyGem compatibility', () => {
   it('Renders call to action', () => {
     assert.equal(
       marked('$CTA\nCall to action\n$CTA'),
-      '<div class="call-to-action">\n  <p>Call to action</p>\n\n</div>')
+      '<div class="call-to-action">\n  <p>Call to action</p>\n\n</div>'
+    )
   })
 
   it('Renders contact', () => {
@@ -79,7 +82,9 @@ describe('Govspeak with RubyGem compatibility', () => {
 
   it('Renders stat headline', () => {
     assert.equal(
-      marked('{stat-headline}\n*13.8bn* years since the big bang{/stat-headline}'),
+      marked(
+        '{stat-headline}\n*13.8bn* years since the big bang{/stat-headline}'
+      ),
       '<div class="stat-headline">\n  <p><em>13.8bn</em> years since the big bang</p>\n\n</div>'
     )
   })

diff --git a/test/index.js b/test/index.js
@@ -51,7 +51,8 @@ describe('Govspeak', () => {
   it('Renders example', () => {
     assert.equal(
       marked('$E\nExample\n$E'),
-      '<div class="govspeak-example">\n  <p>Example</p>\n\n</div>')
+      '<div class="govspeak-example">\n  <p>Example</p>\n\n</div>'
+    )
   })
 
   it('Renders information callout', () => {
@@ -77,7 +78,9 @@ describe('Govspeak', () => {
 
   it('Renders stat headline', () => {
     assert.equal(
-      marked('{stat-headline}\n*13.8bn* years since the big bang{/stat-headline}'),
+      marked(
+        '{stat-headline}\n*13.8bn* years since the big bang{/stat-headline}'
+      ),
       '<div class="govspeak-stat-headline">\n  <p><em>13.8bn</em> years since the big bang</p>\n\n</div>'
     )
   })
@@ -92,6 +95,7 @@ describe('Govspeak', () => {
   it('Renders warning callout', () => {
     assert.equal(
       marked('%warning%'),
-      '<div class="govspeak-warning-callout" role="note" aria-label="Warning">\n  <p>warning</p>\n</div>')
+      '<div class="govspeak-warning-callout" role="note" aria-label="Warning">\n  <p>warning</p>\n</div>'
+    )
   })
 })