fix(docs/single): support files with .markdown extension (#549)

* fix: support files with .markdown extension

* test: random cleanup

fixing typo, removing unused version param, stricter error checks

* chore: capitalize Markdown

* chore: lowercase all file extension checks

__tests__/cmds/changelogs.test.js

@@ -32,19 +32,19 @@ describe('rdme changelogs', () => {
   });
 
   it('should error if no folder provided', () => {
-    return expect(changelogs.run({ key, version: '1.0.0' })).rejects.toThrow(
+    return expect(changelogs.run({ key })).rejects.toThrow(
       'No folder provided. Usage `rdme changelogs <folder> [options]`.'
     );
   });
 
-  it('should error if the argument isnt a folder', () => {
-    return expect(changelogs.run({ key, version: '1.0.0', folder: 'not-a-folder' })).rejects.toThrow(
+  it('should error if the argument is not a folder', () => {
+    return expect(changelogs.run({ key, folder: 'not-a-folder' })).rejects.toThrow(
       "ENOENT: no such file or directory, scandir 'not-a-folder'"
     );
   });
 
   it('should error if the folder contains no markdown files', () => {
-    return expect(changelogs.run({ key, version: '1.0.0', folder: '.github/workflows' })).rejects.toThrow(
+    return expect(changelogs.run({ key, folder: '.github/workflows' })).rejects.toThrow(
       'We were unable to locate Markdown files in .github/workflows.'
     );
   });
@@ -356,14 +356,20 @@ describe('rdme changelogs:single', () => {
   });
 
   it('should error if no file path provided', () => {
-    return expect(changelogsSingle.run({ key, version: '1.0.0' })).rejects.toThrow(
+    return expect(changelogsSingle.run({ key })).rejects.toThrow(
       'No file path provided. Usage `rdme changelogs:single <file> [options]`.'
     );
   });
 
-  it('should error if the argument is not a markdown file', async () => {
-    await expect(changelogsSingle.run({ key, version: '1.0.0', filePath: 'not-a-markdown-file' })).rejects.toThrow(
-      'The file path specified is not a markdown file.'
+  it('should error if the argument is not a Markdown file', async () => {
+    await expect(changelogsSingle.run({ key, filePath: 'not-a-markdown-file' })).rejects.toThrow(
+      'The file path specified is not a Markdown file.'
+    );
+  });
+
+  it('should support .markdown files but error if file path cannot be found', async () => {
+    await expect(changelogsSingle.run({ key, filePath: 'non-existent-file.markdown' })).rejects.toThrow(
+      'ENOENT: no such file or directory'
     );
   });
 

__tests__/cmds/custompages.test.js

@@ -402,9 +402,9 @@ describe('rdme custompages:single', () => {
     );
   });
 
-  it('should error if the argument is not a markdown file', async () => {
+  it('should error if the argument is not a Markdown file', async () => {
     await expect(customPagesSingle.run({ key, filePath: 'not-a-markdown-file' })).rejects.toStrictEqual(
-      new Error('The file path specified is not a markdown or HTML file.')
+      new Error('The file path specified is not a Markdown or HTML file.')
     );
   });
 

__tests__/cmds/docs.test.js

@@ -49,7 +49,7 @@ describe('rdme docs', () => {
     );
   });
 
-  it('should error if the argument isnt a folder', async () => {
+  it('should error if the argument is not a folder', async () => {
     const versionMock = getApiNock().get(`/api/v1/version/${version}`).basicAuth({ user: key }).reply(200, { version });
 
     await expect(docs.run({ key, version: '1.0.0', folder: 'not-a-folder' })).rejects.toThrow(
@@ -564,12 +564,20 @@ describe('rdme docs:single', () => {
     );
   });
 
-  it('should error if the argument is not a markdown file', async () => {
+  it('should error if the argument is not a Markdown file', async () => {
     await expect(docsSingle.run({ key, version: '1.0.0', filePath: 'not-a-markdown-file' })).rejects.toThrow(
-      'The file path specified is not a markdown file.'
+      'The file path specified is not a Markdown file.'
     );
   });
 
+  it('should support .markdown files but error if file path cannot be found', async () => {
+    const versionMock = getApiNock().get(`/api/v1/version/${version}`).basicAuth({ user: key }).reply(200, { version });
+    await expect(docsSingle.run({ key, version: '1.0.0', filePath: 'non-existent-file.markdown' })).rejects.toThrow(
+      'ENOENT: no such file or directory'
+    );
+    versionMock.done();
+  });
+
   describe('new docs', () => {
     it('should create new doc', async () => {
       const slug = 'new-doc';

src/cmds/changelogs/index.js

@@ -62,7 +62,9 @@ module.exports = class ChangelogsCommand {
     };
 
     // Strip out non-markdown files
-    const files = readdirRecursive(folder).filter(file => file.endsWith('.md') || file.endsWith('.markdown'));
+    const files = readdirRecursive(folder).filter(
+      file => file.toLowerCase().endsWith('.md') || file.toLowerCase().endsWith('.markdown')
+    );
 
     debug(`number of files: ${files.length}`);
 

src/cmds/changelogs/single.js

@@ -45,8 +45,8 @@ module.exports = class SingleChangelogCommand {
       return Promise.reject(new Error(`No file path provided. Usage \`${config.get('cli')} ${this.usage}\`.`));
     }
 
-    if (filePath.endsWith('.md') === false || !filePath.endsWith('.markdown') === false) {
-      return Promise.reject(new Error('The file path specified is not a markdown file.'));
+    if (!(filePath.toLowerCase().endsWith('.md') || filePath.toLowerCase().endsWith('.markdown'))) {
+      return Promise.reject(new Error('The file path specified is not a Markdown file.'));
     }
 
     const createdDoc = await pushDoc(key, undefined, dryRun, filePath, this.cmdCategory);

src/cmds/custompages/index.js

@@ -63,7 +63,10 @@ module.exports = class CustomPagesCommand {
 
     // Strip out non-markdown files
     const files = readdirRecursive(folder).filter(
-      file => file.endsWith('.html') || file.endsWith('.md') || file.endsWith('.markdown')
+      file =>
+        file.toLowerCase().endsWith('.html') ||
+        file.toLowerCase().endsWith('.md') ||
+        file.toLowerCase().endsWith('.markdown')
     );
 
     debug(`number of files: ${files.length}`);

src/cmds/custompages/single.js

@@ -45,8 +45,14 @@ module.exports = class SingleCustomPageCommand {
       return Promise.reject(new Error(`No file path provided. Usage \`${config.get('cli')} ${this.usage}\`.`));
     }
 
-    if (!(filePath.endsWith('.html') || filePath.endsWith('.md') || filePath.endsWith('.markdown'))) {
-      return Promise.reject(new Error('The file path specified is not a markdown or HTML file.'));
+    if (
+      !(
+        filePath.toLowerCase().endsWith('.html') ||
+        filePath.toLowerCase().endsWith('.md') ||
+        filePath.toLowerCase().endsWith('.markdown')
+      )
+    ) {
+      return Promise.reject(new Error('The file path specified is not a Markdown or HTML file.'));
     }
 
     const createdDoc = await pushDoc(key, undefined, dryRun, filePath, this.cmdCategory);

src/cmds/docs/index.js

@@ -75,7 +75,9 @@ module.exports = class DocsCommand {
     };
 
     // Strip out non-markdown files
-    const files = readdirRecursive(folder).filter(file => file.endsWith('.md') || file.endsWith('.markdown'));
+    const files = readdirRecursive(folder).filter(
+      file => file.toLowerCase().endsWith('.md') || file.toLowerCase().endsWith('.markdown')
+    );
 
     debug(`number of files: ${files.length}`);
 

src/cmds/docs/single.js

@@ -51,8 +51,8 @@ module.exports = class SingleDocCommand {
       return Promise.reject(new Error(`No file path provided. Usage \`${config.get('cli')} ${this.usage}\`.`));
     }
 
-    if (filePath.endsWith('.md') === false || !filePath.endsWith('.markdown') === false) {
-      return Promise.reject(new Error('The file path specified is not a markdown file.'));
+    if (!(filePath.toLowerCase().endsWith('.md') || filePath.toLowerCase().endsWith('.markdown'))) {
+      return Promise.reject(new Error('The file path specified is not a Markdown file.'));
     }
 
     // TODO: should we allow version selection at all here?