Merge pull request #1485 from rwblair/1484_readme_error

update missing readme check to allow extensions.

Author: rwblair

bids-validator/utils/issues/list.js

@@ -1119,4 +1119,10 @@ export default {
     severity: 'error',
     reason: 'Inconsistent TIFF file type and extension',
   },
+  228: {
+    key: 'MULTIPLE_README_FILES',
+    severity: 'error',
+    reason:
+      'A BIDS dataset MUST NOT contain more than one `README` file (with or without extension) at its root directory.',
+  },
 }

bids-validator/validators/bids/__tests__/checkReadme.spec.js

@@ -0,0 +1,70 @@
+import { assert } from 'chai'
+import checkReadme from '../checkReadme'
+
+describe('checkReadme', () => {
+  it('returns issues with multiple readme files', () => {
+    const fileList = {
+      '/README': {
+        name: 'README',
+        path: '/ds-999/README',
+        relativePath: '/README',
+        stats: { size: 155 },
+      },
+      '/README.md': {
+        name: 'README.md',
+        path: '/ds-999/README.md',
+        relativePath: '/README.md',
+        stats: { size: 155 },
+      },
+    }
+    const issues = checkReadme(fileList)
+    assert.lengthOf(issues, 1)
+    assert.equal(issues[0].code, 228)
+  })
+  it('returns issues with multiple small readme files', () => {
+    const fileList = {
+      '/README': {
+        name: 'README',
+        path: '/ds-999/README',
+        relativePath: '/README',
+        stats: { size: 100 },
+      },
+      '/README.md': {
+        name: 'README.md',
+        path: '/ds-999/README.md',
+        relativePath: '/README.md',
+        stats: { size: 100 },
+      },
+    }
+    const issues = checkReadme(fileList)
+    assert.lengthOf(issues, 3)
+    const codes = issues.map(issue => issue.code)
+    assert.equal(codes.filter(x => x === 213).length, 2)
+    assert.equal(codes.filter(x => x === 228).length, 1)
+  })
+  it('returns no issues on readme with extension', () => {
+    const fileList = {
+      '/README.md': {
+        name: 'README.md',
+        path: '/ds-999/README.md',
+        relativePath: '/README.md',
+        stats: { size: 155 },
+      },
+    }
+    const issues = checkReadme(fileList)
+    assert.lengthOf(issues, 0)
+  })
+  it('returns issue on no readme', () => {
+    const fileList = {
+      '/bad.md': {
+        name: 'bad.md',
+        path: '/ds-999/bad.md',
+        relativePath: '/bad.md',
+        stats: { size: 155 },
+      },
+    }
+    const issues = checkReadme(fileList)
+    assert.lengthOf(issues, 1)
+    assert.equal(issues[0].code, 101)
+  })
+})

bids-validator/validators/bids/checkReadme.js

@@ -4,16 +4,20 @@ const Issue = require('../../utils').issues.Issue
 
 const checkReadme = fileList => {
   const issues = []
-  const readmeFile = Array.from(Object.values(fileList)).find(
-    file => file.relativePath && file.relativePath == '/README',
+  const readmeFiles = Array.from(Object.values(fileList)).filter(
+    file => file.relativePath && file.relativePath.startsWith('/README'),
   )
-  if (readmeFile) {
+
+  readmeFiles.map(readmeFile => {
     const size = !isNode ? readmeFile.size : readmeFile.stats.size
     const failsSizeRequirement = size <= 150
     if (failsSizeRequirement) {
-      issues.push(new Issue({ code: 213 }))
+      issues.push(new Issue({ code: 213, file: readmeFile }))
     }
-  } else {
+  })
+  if (readmeFiles.length > 1) {
+    issues.push(new Issue({ code: 228 }))
+  } else if (readmeFiles.length === 0) {
     issues.push(new Issue({ code: 101 }))
   }
   return issues