Release Candidate - 0.2

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basketry/typescript-docs",
-  "version": "0.1.1",
+  "version": "0.2.0-rc.0",
   "description": "Basketry generator for documenting services that have a Typescript language target.",
   "main": "./lib/index.js",
   "scripts": {
@@ -31,7 +31,7 @@
   "bugs": {
     "url": "https://github.com/basketry/typescript-docs/issues"
   },
-  "homepage": "https://github.com/basketry/typescript-docs#readme",
+  "homepage": "https://basketry.io/docs/components/@basketry/typescript-docs",
   "funding": "https://github.com/sponsors/basketry",
   "devDependencies": {
     "@types/jest": "^29.5.12",
@@ -49,8 +49,8 @@
     "typescript": "^4.5.5"
   },
   "dependencies": {
-    "@basketry/typescript": "^0.1.4",
-    "basketry": "^0.1.5",
+    "@basketry/typescript": "^0.2.0",
+    "basketry": "^0.2.0",
     "case": "^1.6.3",
     "prettier": "^2.5.1"
   }

src/interface-info.ts

@@ -92,14 +92,14 @@ export class InterfaceInfo {
   private init(): void {
     for (const method of this.int.methods) {
       for (const param of method.parameters) {
-        for (const t of this.traverse(param.typeName.value, 'input')) {
+        for (const t of this.traverse(param.value.typeName.value, 'input')) {
           // noop
         }
       }
 
-      if (method.returnType && !method.returnType.isPrimitive) {
+      if (method.returns?.value.kind === 'ComplexValue') {
         for (const t of this.traverse(
-          method.returnType.typeName.value,
+          method.returns.value.typeName.value,
           'output',
         )) {
           // noop
@@ -132,8 +132,8 @@ export class InterfaceInfo {
       yield type;
 
       for (const prop of type.properties) {
-        if (!prop.isPrimitive) {
-          yield* this.traverse(prop.typeName.value, mode);
+        if (prop.value.kind === 'ComplexValue') {
+          yield* this.traverse(prop.value.typeName.value, mode);
         }
       }
     } else if (union) {

src/readme-factory.test.ts

@@ -1,30 +1,15 @@
 import { readFileSync } from 'fs';
 import { join } from 'path';
-import { generateDocs } from './readme-factory';
+import { generateFiles } from './snapshot/test-utils';
 
 const pkg = require('../package.json');
 const withVersion = `${pkg.name}@${pkg.version}`;
 const withoutVersion = `${pkg.name}@{{version}}`;
 
 describe('InterfaceFactory', () => {
-  it('recreates a valid snapshot', () => {
-    // ARRANGE
-    const service = require('basketry/lib/example-ir.json');
-
-    // ACT
-    const files = generateDocs(service, {
-      sorbet: {
-        typesModule: 'types',
-        enumsModule: 'enums',
-      },
-    });
-
-    // ASSERT
-    for (const file of [...files]) {
-      const path = join('src', 'snapshot', ...file.path);
-      const snapshot = readFileSync(path)
-        .toString()
-        .replace(withoutVersion, withVersion);
+  it('recreates a valid snapshot using the Engine', async () => {
+    for await (const file of await generateFiles()) {
+      const snapshot = readFileSync(join(...file.path)).toString();
       expect(file.contents).toStrictEqual(snapshot);
     }
   });