Merge pull request #2253 from alphagov/2252-add-comments-to-the-starter-filtersjs-file

Add comments to the prototype-starter filters file

Author: BenSurgisonGDS

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Fixes
+
+- [#2253: Add comments to the prototype-starter filters file](https://github.com/alphagov/govuk-prototype-kit/pull/2253)
+
 ## 13.10.0
 
 ### New features

__tests__/spec/migrate.js

@@ -99,9 +99,17 @@ describe('migrate test prototype', () => {
   it('filters.js should be overwritten', () => {
     const filtersFileContents = getNormalisedFileContent(path.join(appDirectory, 'filters.js'))
 
-    expect(filtersFileContents).toEqual(
-      'const govukPrototypeKit = require(\'govuk-prototype-kit\')\n' +
-      'const addFilter = govukPrototypeKit.views.addFilter' + '\n'
+    expect(filtersFileContents).toEqual(`//
+// For guidance on how to create filters see:
+// https://prototype-kit.service.gov.uk/docs/filters
+//
+
+const govukPrototypeKit = require('govuk-prototype-kit')
+const addFilter = govukPrototypeKit.views.addFilter
+
+// Add your filters here
+
+`
     )
   })
 

prototype-starter/app/filters.js

@@ -1,2 +1,10 @@
+//
+// For guidance on how to create filters see:
+// https://prototype-kit.service.gov.uk/docs/filters
+//
+
 const govukPrototypeKit = require('govuk-prototype-kit')
 const addFilter = govukPrototypeKit.views.addFilter
+
+// Add your filters here
+