fix: allow for non-existent source directories

Author: davewasmer

src/extracter.ts

@@ -136,7 +136,6 @@ export default class Extracter {
   extractApi(): API {
     debug(`Extracting API for ${ this.dir }`);
     let sourceType = this.detectSourceType();
-    debug(`Source type for this project seems to be ${ sourceType }`);
     if (!sourceType) {
       throw new Error('Cannot extract API docs from this directory: unknown source type. Source must be Typescript or JavaScript');
     }
@@ -145,11 +144,21 @@ export default class Extracter {
   }
 
   detectSourceType(): 'typescript' | 'javascript' | null {
+    debug(`Checking source type for project located in ${ this.dir }`);
+    let basePattern: string;
+    if (this.sourceDirs.length > 1) {
+      basePattern = `{${ this.sourceDirs.join(',') }}`;
+    } else {
+      basePattern = this.sourceDirs[0];
+    }
+    basePattern = path.join(basePattern, '**', '*');
     // Typescript
-    if (glob(path.join(this.dir, `{${ this.sourceDirs.join(',') }}`, '**', '*.ts'))) {
+    if (glob(`${ basePattern }.ts`).length > 0) {
+      debug(`Found .ts files in ${ this.dir }, assuming Typescript`);
       return 'typescript';
     // JavaScript
-    } else if (glob(path.join(this.dir, `{${ this.sourceDirs.join(',') }}`, '**', '*.js'))) {
+    } else if (glob(`${ basePattern }.js`).length > 0) {
+      debug(`Found no .ts files ${ this.dir }, assuming JavaScript`);
       return 'javascript';
     }
     return null;

src/source-extracters/javascript.ts

@@ -2,6 +2,7 @@ import * as Y from 'yuidocjs';
 import { forEach } from 'lodash';
 import { dirSync as tmp } from 'tmp';
 import { inspect } from 'util';
+import { existsSync as exists } from 'fs';
 import API, { FreeFunction, Package, Class, Method, Property } from '../api';
 import ui from '../ui';
 import * as createDebug from 'debug';
@@ -23,10 +24,11 @@ export default class JavascriptSourceExtracter extends SourceExtracter {
   runYuidoc(): YUIDoc.Project {
     debug(`Running Yuidoc to extract inline documentation`);
     let outDir = tmp({ prefix: 'yuidoc-output-', unsafeCleanup: true }).name;
+    let paths = this.sourceDirs.filter(exists);
     let config = {
       quiet: true,
       outdir: outDir,
-      paths: this.sourceDirs,
+      paths,
       parseOnly: true
     };
     let yuidoc = new Y.YUIDoc(config);

test/javascript.js

@@ -7,10 +7,10 @@ test('javascript projects', async (t) => {
   let extracter = new Extracter({
     dir: path.join(__dirname, 'fixtures', 'javascript-project'),
     pagesDir: 'guides',
-    sourceDirs: [ 'src' ],
+    sourceDirs: [ 'src', 'non-existent-folder' ],
     projectName: 'javascript-project',
     projectVersion: '1.0.0'
   });
   let result = extracter.extract();
   t.deepEqual(result, output('js'));
-});
+});

test/typescript.js

@@ -7,7 +7,7 @@ test('typescript projects', async (t) => {
   let extracter = new Extracter({
     dir: path.join(__dirname, 'fixtures', 'typescript-project'),
     pagesDir: 'guides',
-    sourceDirs: [ 'src' ],
+    sourceDirs: [ 'src', 'non-existent-folder' ],
     projectName: 'typescript-project',
     projectVersion: '1.0.0'
   });