46

.eslintrc

@@ -26,7 +26,7 @@
       }
     },
     {
-      "files": ["**/src/**/*.ts", "**/test/**/*.ts", "_examples/*/**/*.ts"],
+      "files": ["**/src/**/*.ts", "**/test/**/*.ts", "_examples/*/**/*.ts", "util/typedoc/typedoc-plugin-module-name-by-package/**/*.js"],
       "parserOptions": {
         "sourceType": "module"
       },

.gitignore

@@ -10,3 +10,4 @@ dist
 .env
 .aws-docker
 .tsconfig.*
+docs

builder/src/builder-project.ts

@@ -129,13 +129,29 @@ export class BuilderProject implements BuilderConfig, BuilderProjectOptions {
           relative(this.projectPath, resolve(pkg.path, 'index.ts')),
           relative(this.projectPath, resolve(pkg.path, 'src/**/*.ts')),
         )
+        if (pkg.subPackages) {
+          pkg.subPackages.forEach(subPkg => {
+            result.push(
+              relative(this.projectPath, resolve(pkg.path, subPkg, 'index.ts')),
+              relative(this.projectPath, resolve(pkg.path, subPkg, 'src/**/*.ts')),
+            )
+          })
+        }
         return result
       }, []),
       exclude: packages.reduce((result, pkg) => {
         result.push(
           relative(this.projectPath, resolve(pkg.path, 'node_modules')),
           relative(this.projectPath, resolve(pkg.path, '**/*.spec.ts')),
         )
+        if (pkg.subPackages) {
+          pkg.subPackages.forEach(subPkg => {
+            result.push(
+              relative(this.projectPath, resolve(pkg.path, subPkg, 'node_modules')),
+              relative(this.projectPath, resolve(pkg.path, subPkg, '**/*.spec.ts')),
+            )
+          })
+        }
         return result
       }, []),
       references: packages.map(pkg => ({

package.json

@@ -16,7 +16,9 @@
     "precoverage": "rimraf .coverage .nyc_output",
     "coverage": "nyc mocha",
     "coverage-report": "nyc report --reporter=text-lcov | coveralls",
-    "coverage:watch": "nyc npm test -- --watch"
+    "coverage:watch": "nyc npm test -- --watch",
+    "prebuild-docs": "rimraf ./docs && builder update-configs",
+    "build-docs": "typedoc --options ./typedoc.json"
   },
   "repository": {
     "type": "git",
@@ -42,6 +44,7 @@
     "chai-as-promised": "^7.1.1",
     "colors": "^1.3.3",
     "coveralls": "^3.0.2",
+    "docfx": "^1.0.5",
     "eslint": "^5.12.0",
     "eslint-plugin-import": "^2.14.0",
     "eslint-plugin-mocha": "^5.2.0",
@@ -57,6 +60,7 @@
     "ts-custom-error-shim": "^1.0.0",
     "ts-node": "^7.0.1",
     "tsconfig-paths": "^3.7.0",
+    "typedoc": "^0.14.2",
     "typescript": "^3.2.2",
     "typescript-eslint-parser": "^21.0.2",
     "uuid": "^3.3.2"

tsconfig.docs.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./.tsconfig.builder.json"
+}

typedoc.json

@@ -0,0 +1,13 @@
+{
+  "name": "@dandi",
+  "mode": "modules",
+  "out": "docs",
+  "tsconfig": "./.tsconfig.builder.json",
+  "exclude": "_examples",
+  "includeDeclarations": true,
+  "excludeExternals": true,
+  "excludePrivate": true,
+  "excludeNotExported": true,
+  "listInvalidSymbolLinks": true,
+  "readme": "./README.md"
+}

util/typedoc/typedoc-plugin-module-name-by-package/.gitignore

@@ -0,0 +1,3 @@
+src/*.js
+src/*.d.ts
+src/*.map

util/typedoc/typedoc-plugin-module-name-by-package/index.js

@@ -0,0 +1,6 @@
+const plugin = require('./src/plugin')
+
+module.exports = function(PluginHost) {
+  const app = PluginHost.owner
+  app.converter.addComponent(plugin.PLUGIN_NAME, plugin.ModuleNameByPackagePlugin)
+}