Use unix line-endings everywhere

.github/workflows/test.yaml

@@ -24,6 +24,10 @@ jobs:
       CYPRESS_CACHE_FOLDER: ~/.cache/Cypress
 
     steps:
+    - run: |
+        git config --global core.autocrlf false
+        git config --global core.eol lf
+
     - uses: actions/checkout@v3
       with:
         fetch-depth: 0
@@ -45,4 +49,4 @@ jobs:
     - run: npm run test:unit && npm run test:integration
       env:
         CI: true
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

__tests__/spec/migrate.js

@@ -4,7 +4,6 @@ const path = require('path')
 const fs = require('fs')
 const fse = require('fs-extra')
 const { spawn } = require('../../lib/exec')
-const os = require('os')
 const { mkdtempSync } = require('../util')
 const { sleep } = require('../../lib/utils')
 
@@ -57,27 +56,27 @@ describe('migrate test prototype', () => {
 
     expect(routesFileContents).toEqual(
       'const router = require(\'govuk-prototype-kit\').requests.setupRouter()' +
-      os.EOL + os.EOL +
+      '\n\n' +
       '// Add your routes here' +
-      os.EOL + os.EOL + os.EOL
+      '\n\n\n'
     )
   })
 
   it('filters.js', () => {
     const filtersFileContents = fs.readFileSync(path.join(appDirectory, 'filters.js'), 'utf8')
 
     expect(filtersFileContents).toEqual(
-      'const addFilter = require(\'govuk-prototype-kit\').views.addFilter' + os.EOL
+      'const addFilter = require(\'govuk-prototype-kit\').views.addFilter' + '\n'
     )
   })
 
   it('application.js', () => {
     const jsFileContents = fs.readFileSync(path.join(assetsDirectory, 'javascripts', 'application.js'), 'utf8')
 
     expect(jsFileContents).toEqual(
-      'window.GOVUKPrototypeKit.documentReady(() => {' + os.EOL +
-      '  // Add JavaScript here' + os.EOL +
-      '})' + os.EOL
+      'window.GOVUKPrototypeKit.documentReady(() => {' + '\n' +
+      '  // Add JavaScript here' + '\n' +
+      '})' + '\n'
     )
   })
 
@@ -86,15 +85,15 @@ describe('migrate test prototype', () => {
 
     expect(sassFileContents).toEqual(
       '// Add extra styles here' +
-      os.EOL + os.EOL + os.EOL
+      '\n\n\n'
     )
   })
 
   it('layout.html', () => {
     const layoutFileContents = fs.readFileSync(path.join(appDirectory, 'views', 'layout.html'), 'utf8')
 
     expect(layoutFileContents).toEqual(
-      '{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}' + os.EOL
+      '{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}' + '\n'
     )
   })
 })

bin/cli

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 
 const fs = require('fs-extra')
-const os = require('os')
 const path = require('path')
 
 const { spawn } = require('../lib/exec')
@@ -40,7 +39,7 @@ const packageJson = {
   }
 }
 
-const packageJsonFormat = { encoding: 'utf8', EOL: os.EOL, spaces: 2 }
+const packageJsonFormat = { encoding: 'utf8', spaces: 2 }
 
 async function updatePackageJson (packageJsonPath) {
   let newPackageJson = Object.assign({}, packageJson)

lib/build/tasks.js

@@ -1,5 +1,4 @@
 const path = require('path')
-const { EOL } = require('os')
 
 const chokidar = require('chokidar')
 const colour = require('ansi-colors')
@@ -90,7 +89,7 @@ function proxyUserSassIfItExists (filename) {
   }
   ensureTempDirExists(path.dirname(proxyFilePath))
 
-  fse.writeFileSync(path.join(proxyFilePath), proxyFileLines.join(EOL))
+  fse.writeFileSync(path.join(proxyFilePath), proxyFileLines.join('\n'))
 }
 
 function generateCss (sassPath, cssPath, options = {}) {
@@ -181,15 +180,15 @@ function autoImportComponentsSync () {
       macroName,
       importFrom
     }
-  }) => `{% from "${importFrom}" import ${macroName} %}`).join(EOL)
+  }) => `{% from "${importFrom}" import ${macroName} %}`).join('\n')
 
   extensions.getByType('importNunjucksMacrosInto').map(({ packageName, item: templatePath }) => {
     return {
       shadowPath: path.join(shadowNunjucks, packageName, templatePath),
       newContents: [
         includeString,
         fse.readFileSync(path.join(projectDir, 'node_modules', packageName, templatePath), 'utf8')
-      ].join(EOL + EOL)
+      ].join('\n\n')
     }
   }).forEach(file => {
     fse.ensureDirSync(path.dirname(file.shadowPath))

lib/migrator/fileHelpers.js

@@ -1,4 +1,3 @@
-const os = require('os')
 const path = require('path')
 const { packageDir, projectDir } = require('../path-utils')
 const fs = require('fs').promises
@@ -24,8 +23,8 @@ const verboseLogError = async (e) => {
   await verboseLog()
 }
 
-const joinLines = arr => arr.join(os.EOL)
-const splitIntoLines = fileContents => fileContents.split(os.EOL)
+const joinLines = arr => arr.join('\n')
+const splitIntoLines = fileContents => fileContents.split('\n')
 const successOutput = () => true
 
 const getFileAsLines = async (filePath) => {

lib/migrator/fileHelpers.spec.js

@@ -1,7 +1,6 @@
 /* eslint-env jest */
 
 const util = require('util')
-const os = require('os')
 const path = require('path')
 
 jest.mock('./logger')
@@ -11,7 +10,7 @@ const { projectDir } = require('../path-utils')
 const { removeLineFromFile, replaceStartOfFile, deleteFile, deleteDirectory } = require('./fileHelpers')
 
 describe('file helpers', () => {
-  const joinLines = arr => arr.join(os.EOL)
+  const joinLines = arr => arr.join('\n')
   const writeFileToMockFile = (filePathParts, contentStringOrArray) => testScope.fileSystem
     .writeFile(filePathParts, typeof contentStringOrArray === 'string' ? contentStringOrArray : joinLines(contentStringOrArray))
 

server.js

@@ -1,7 +1,6 @@
 // Core dependencies
 const path = require('path')
 const url = require('url')
-const os = require('os')
 const { existsSync } = require('fs')
 const fs = require('fs').promises
 
@@ -167,7 +166,7 @@ app.get('/docs/tutorials-and-examples', function (req, res) {
 app.get('/', async (req, res) => {
   const starterHomepageCode = await fs.readFile(path.join(packageDir, 'prototype-starter', 'app', 'views', 'index.html'), 'utf8')
   res.render('govuk-prototype-kit/backup-homepage', {
-    starterHomepageCodeLines: starterHomepageCode.split(os.EOL)
+    starterHomepageCodeLines: starterHomepageCode.split('\n')
   })
 })