test: added tests (ipfs#1273)

src/document-check.js

@@ -26,19 +26,21 @@ const tasks = new Listr(
        * @param {Task} task
        */
       task: async (ctx, task) => {
-        let configPath = './tsconfig-doc-check.aegir.json'
+        const configPath = './tsconfig-doc-check.aegir.json'
+
+        let userTSConfig = {}
         let markdownFiles = ['README.md']
 
         if (ctx.tsConfigPath && ctx.tsConfigPath !== '.') {
-          configPath = `${ctx.tsConfigPath}/tsconfig.json`
+          userTSConfig = readJson(`${ctx.tsConfigPath}/tsconfig.json`)
+        } else {
+          userTSConfig = readJson(fromRoot('tsconfig.json'))
         }
 
         if (ctx.inputFiles) {
           markdownFiles = await globby(ctx.inputFiles)
         }
 
-        const userTSConfig = readJson(fromRoot('tsconfig.json'))
-
         try {
           fs.writeJsonSync(
             configPath,
@@ -66,8 +68,6 @@ const tasks = new Listr(
               console.log(formatCode(result.snippet, result.linesWithErrors))
             }
           })
-        } catch (error) {
-          console.error('Error complining Typescript snippets ', error)
         } finally {
           fs.removeSync(configPath)
           fs.removeSync(fromRoot('dist', 'tsconfig-doc-check.aegir.tsbuildinfo'))

test/document-check.js

@@ -0,0 +1,37 @@
+/* eslint-env mocha */
+
+import { createRequire } from 'module'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import { execa } from 'execa'
+import { expect } from '../utils/chai.js'
+
+const require = createRequire(import.meta.url)
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const bin = require.resolve('../src/index.js')
+
+describe('document check', () => {
+  it('should fail for errant typescript in docs', async () => {
+    const cwd = path.join(__dirname, 'fixtures/document-check/ts-fail')
+
+    await expect(execa(bin, ['doc-check', '--inputFiles', `${cwd}/*.md`, '--tsConfigPath', `${cwd}`]))
+      .to.eventually.be.rejected()
+      .with.property('stdout')
+      .that.include('Error compiling example code block 1')
+  })
+
+  it('should pass for correct typescript in docs', async () => {
+    const cwd = path.join(__dirname, 'fixtures/document-check/pass')
+
+    await expect(execa(bin, ['doc-check', '--inputFiles', `${cwd}/*.md`])).to.eventually.be.fulfilled()
+  })
+
+  it('should fail for missing tsconfig.json', async () => {
+    const cwd = path.join(__dirname, 'fixtures/document-check/tsconfig-fail')
+
+    await expect(execa(bin, ['doc-check', '--inputFiles', `${cwd}/*.md`, '--tsConfigPath', `${cwd}`]))
+      .to.eventually.be.rejected()
+      .with.property('stderr')
+      .that.include('no such file or directory')
+  })
+})

test/fixtures/document-check/pass/GOODREADME.md

@@ -0,0 +1,3 @@
+```ts
+export const a = 1;
+```

test/fixtures/document-check/pass/tsconfig.json

@@ -0,0 +1,14 @@
+{
+    "extends": "./../../../../src/config/tsconfig.aegir.json",
+    "compilerOptions": {
+        "outDir": "dist",
+        "emitDeclarationOnly": true,
+	      "isolatedModules": true
+    },
+    "include": [
+      "package.json",
+      "src",
+      "test",
+      "utils"
+    ]
+}

test/fixtures/document-check/ts-fail/ANOTHERBADREADME.md

@@ -0,0 +1,3 @@
+```typescript
+still.bad.code
+```

test/fixtures/document-check/ts-fail/BADREADME.md

@@ -0,0 +1,3 @@
+```typescript
+   wrong.code()
+```

test/fixtures/document-check/ts-fail/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "extends": "./../../../../src/config/tsconfig.aegir.json",
+    "compilerOptions": {
+        "outDir": "dist",
+        "emitDeclarationOnly": true
+    },
+    "include": [
+      "package.json",
+      "src",
+      "test",
+      "utils"
+    ]
+}

test/fixtures/document-check/tsconfig-fail/GOODREADME.md

@@ -0,0 +1,3 @@
+```ts
+export const a = 1;
+```

test/node.js

@@ -3,6 +3,7 @@ import './docs.js'
 import './lint.js'
 import './fixtures.js'
 import './dependants.js'
+import './document-check.js'
 import './dependency-check.js'
 import './utils/echo-server.js'
 import './utils/get-port.js'