feat: Enable root-level typedoc generation for the project.

 - All local types have been pulled out to the project directory.
 - Packages moved to /packages/@css-blocks for module name generation.
 - typedoc.js configuration file added.
 - packages/css-blocks => packages/@css-blocks/core
 - packages/webpack-plugin => packages/@css-blocks/webpack.
 - packages/glimmer-templates => packages/@css-blocks/glimmer.
 - packages/runtime/src/runtime.ts => packages/@css-blocks/runtime/src/index.ts.
 - yarn run docs will generate a typedoc site at /docs.
 - TODO: Uses pre-built forked version of typedoc-plugin-external-module-map. Remove when merged.

Author: amiller-gh

CHANGELOG.md

@@ -1,22 +1,25 @@
 {
 	"folders": [
 		{
-			"path": "packages/css-blocks"
+			"path": "packages/@css-blocks/broccoli"
 		},
 		{
-			"path": "packages/glimmer-templates"
+			"path": "packages/@css-blocks/code-style"
 		},
 		{
-			"path": "packages/jsx"
+			"path": "packages/@css-blocks/core"
 		},
 		{
-			"path": "packages/runtime"
+			"path": "packages/@css-blocks/glimmer"
 		},
 		{
-			"path": "packages/webpack-plugin"
+			"path": "packages/@css-blocks/jsx"
 		},
 		{
-			"path": "packages/code-style"
+			"path": "packages/@css-blocks/runtime"
+		},
+		{
+			"path": "packages/@css-blocks/webpack"
 		},
 		{
 			"path": ".",

css-blocks.code-workspace

@@ -2,7 +2,8 @@
   "private": true,
   "scripts": {
     "commitmsg": "commitlint --edit $GIT_PARAMS",
-    "ci": "lerna run test"
+    "ci": "lerna run test",
+    "docs": "typedoc"
   },
   "devDependencies": {
     "@commitlint/cli": "^6.1.0",
@@ -16,10 +17,12 @@
     "@types/babylon": "^6.16.1",
     "@types/chai": "^3.5.2",
     "@types/debug": "0.0.29",
+    "@types/loader-utils": "^1.1.3",
     "@types/minimatch": "^2.0.29",
     "@types/mocha": "^2.2.41",
     "@types/node": "^8.0.0",
     "@types/prettier": "^1.8.0",
+    "@types/tapable": "0.2.4",
     "chai": "^3.5.0",
     "husky": "^0.14.3",
     "istanbul": "^0.4.5",
@@ -38,11 +41,12 @@
     "test-console": "^1.1.0",
     "ts-node": "^3.0.4",
     "tslint": "^5.9.1",
-    "typedoc": "^0.7.1",
+    "typedoc": "^0.11.0",
     "typescript": "^2.8.1",
+    "typedoc-plugin-external-module-map": "amiller-gh/typedoc-plugin-external-module-map#prebuilt",
     "watch": "^1.0.2"
   },
   "workspaces": [
-    "packages/*"
+    "packages/@css-blocks/*"
   ]
 }

package.json

@@ -5,7 +5,11 @@
   "main": "dist/src/index.js",
   "author": "Adam Miller <[email protected]>",
   "license": "MIT",
-  "keywords": ["css-blocks", "css blocks", "broccoli-plugin"],
+  "keywords": [
+    "css-blocks",
+    "css blocks",
+    "broccoli-plugin"
+  ],
   "scripts": {
     "test": "mocha --opts test/mocha.opts dist/test",
     "compile": "rm -rf dist && tsc -p tsconfig.json",
@@ -15,32 +19,31 @@
     "lint": "tslint -t msbuild --project . -c tslint.cli.json",
     "lintall": "tslint -t msbuild --project . -c tslint.release.json",
     "lintfix": "tslint -t msbuild --project . -c tslint.cli.json --fix",
-    "coverage":
-      "istanbul cover -i dist/src/**/*.js --dir ./build/coverage node_modules/mocha/bin/_mocha -- dist/test --opts test/mocha.opts",
-    "remap":
-      "remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
+    "coverage": "istanbul cover -i dist/src/**/*.js --dir ./build/coverage node_modules/mocha/bin/_mocha -- dist/test --opts test/mocha.opts",
+    "remap": "remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
     "docs": "typedoc --out ./docs .",
     "watch": "watch 'yarn run test' src test types-local --wait=1"
   },
   "devDependencies": {
     "@css-blocks/code-style": "^0.17.0",
-    "@css-blocks/glimmer-templates": "^0.17.0"
+    "@css-blocks/glimmer": "^0.17.0"
   },
   "dependencies": {
+    "@css-blocks/core": "^0.17.0",
     "@glimmer/compiler": "^0.33.0",
     "@glimmer/syntax": "^0.33.0",
+    "@opticss/template-api": "file:../../../../opticss/packages/template-api",
     "@types/recursive-readdir": "^2.2.0",
     "broccoli-funnel": "^2.0.1",
     "broccoli-merge-trees": "^3.0.0",
     "broccoli-plugin": "^1.3.0",
     "broccoli-test-helper": "^1.2.0",
     "colors": "^1.2.1",
-    "css-blocks": "^0.17.0",
     "debug": "^3.1.0",
     "fs-extra": "^5.0.0",
-    "opticss": "file:../../../opticss/packages/opticss",
+    "opticss": "file:../../../../opticss/packages/opticss",
     "postcss": "^6.0.21",
     "recursive-readdir": "^2.2.2",
     "walk-sync": "^0.3.2"
   }
-}
+}

packages/broccoli-css-blocks/package.json packages/@css-blocks/broccoli/package.json

@@ -1,13 +1,12 @@
 import * as fs from "fs-extra";
 import * as path from "path";
 
-import { Analyzer, BlockCompiler, StyleMapping } from "css-blocks";
+import { Analyzer, BlockCompiler, StyleMapping } from "@css-blocks/core";
+import { TemplateTypes } from "@opticss/template-api";
 import { Optimizer } from "opticss";
 import * as postcss from "postcss";
 import * as readdir from "recursive-readdir";
 
-import { TemplateTypes } from "@opticss/template-api";
-
 import { BroccoliPlugin } from "./utils";
 
 export interface BroccoliOptions {

packages/broccoli-css-blocks/src/index.ts packages/@css-blocks/broccoli/src/index.ts

@@ -1,10 +1,10 @@
-import { GlimmerAnalyzer } from "@css-blocks/glimmer-templates";
+import { GlimmerAnalyzer } from "@css-blocks/glimmer";
 import * as assert from "assert";
 import { TempDir, buildOutput, createTempDir } from "broccoli-test-helper";
 
 import { BroccoliCSSBlocks } from "../src/index";
 
-describe("Broccoli Plugin Test", function() {
+describe("Broccoli Plugin Test", function () {
   let input: TempDir;
 
   beforeEach(async () => {

packages/broccoli-css-blocks/src/utils.ts packages/@css-blocks/broccoli/src/utils.ts

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
     "outDir": "dist",
     "baseUrl": "dist"

packages/broccoli-css-blocks/test/plugin-test.ts packages/@css-blocks/broccoli/test/plugin-test.ts

@@ -1,3 +1,3 @@
 {
   "extends": "@css-blocks/code-style/configs/tslint.cli.json"
-}
+}

packages/broccoli-css-blocks/tsconfig.build.json packages/@css-blocks/broccoli/tsconfig.build.json

@@ -28,7 +28,7 @@
   },
   "homepage": "https://github.com/css-blocks/css-blocks/tree/master/packages/code-style",
   "dependencies": {
-    "@opticss/code-style": "file:../../../opticss/packages/code-style"
+    "@opticss/code-style": "file:../../../../opticss/packages/code-style"
   },
   "engines": {
     "node": ">=8"

packages/broccoli-css-blocks/tsconfig.json packages/@css-blocks/broccoli/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../../tsconfig.json",
   "include": [
     "src"
   ],

packages/broccoli-css-blocks/tslint.cli.json packages/@css-blocks/broccoli/tslint.cli.json

@@ -1,20 +1,20 @@
 {
-  "name": "css-blocks",
+  "name": "@css-blocks/core",
   "version": "0.17.0",
   "description": "Fast, maintainable, optimal, component-oriented CSS.",
   "main": "dist/src/index.js",
   "scripts": {
-    "compile": "../../node_modules/.bin/tsc --version && rm -rf dist && ../../node_modules/.bin/tsc",
+    "compile": "tsc --version && rm -rf dist && tsc",
     "pretest": "yarn run compile",
-    "test": "../../node_modules/.bin/mocha dist/test --opts test/mocha.opts",
+    "test": "mocha dist/test --opts test/mocha.opts",
     "posttest": "yarn run lint",
     "prepublish": "yarn run compile && yarn run lintall",
-    "lint": "../../node_modules/.bin/tslint -t msbuild --project . -c tslint.cli.json",
-    "lintall": "../../node_modules/.bin/tslint -t msbuild --project . -c tslint.release.json",
-    "lintfix": "../../node_modules/.bin/tslint -t msbuild --project . -c tslint.cli.json --fix",
-    "coverage": "../../node_modules/.bin/istanbul cover -i \"dist/src/**/*.js\" --dir ./build/coverage node_modules/.bin/_mocha -- dist/test --opts test/mocha.opts",
-    "remap": "../../node_modules/.bin/remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
-    "docs": "../../node_modules/.bin/typedoc --out ./docs .",
+    "lint": "tslint -t msbuild --project . -c tslint.cli.json",
+    "lintall": "tslint -t msbuild --project . -c tslint.release.json",
+    "lintfix": "tslint -t msbuild --project . -c tslint.cli.json --fix",
+    "coverage": "istanbul cover -i \"dist/src/**/*.js\" --dir ./build/coverage node_modules/.bin/_mocha -- dist/test --opts test/mocha.opts",
+    "remap": "remap-istanbul -i build/coverage/coverage.json -o coverage -t html",
+    "docs": "typedoc --out ./docs .",
     "watch": "watch 'yarn run test' './src' './test' --wait=3"
   },
   "repository": {
@@ -41,10 +41,10 @@
     "@css-blocks/code-style": "^0.17.0"
   },
   "dependencies": {
-    "@opticss/element-analysis": "file:../../../opticss/packages/element-analysis",
-    "opticss": "file:../../../opticss/packages/opticss",
-    "@opticss/template-api": "file:../../../opticss/packages/template-api",
-    "@opticss/util": "file:../../../opticss/packages/util",
+    "@opticss/element-analysis": "file:../../../../opticss/packages/element-analysis",
+    "opticss": "file:../../../../opticss/packages/opticss",
+    "@opticss/template-api": "file:../../../../opticss/packages/template-api",
+    "@opticss/util": "file:../../../../opticss/packages/util",
     "@types/async": "^2.0.40",
     "@types/debug": "0.0.29",
     "async": "^2.5.0",

packages/broccoli-css-blocks/tslint.json packages/@css-blocks/broccoli/tslint.json

@@ -1,6 +1,5 @@
 import {
   TemplateAnalysis as OptimizationAnalysis,
-  TemplateInfo,
   TemplateIntegrationOptions,
   TemplateTypes,
  } from "@opticss/template-api";
@@ -64,7 +63,7 @@ export abstract class Analyzer<K extends keyof TemplateTypes> {
     this.blockFactory.reset();
   }
 
-  newAnalysis(info: TemplateInfo<K>): Analysis<K> {
+  newAnalysis(info: TemplateTypes[K]): Analysis<K> {
     let analysis = new Analysis<K>(this, info, this.validatorOptions);
     this.analysisMap.set(info.identifier, analysis);
     return analysis;

packages/broccoli-css-blocks/tslint.release.json packages/@css-blocks/broccoli/tslint.release.json

@@ -8,8 +8,6 @@
  * generics they are forced to provide when extending. By the time this abstract class
  * is exposed to the outside world, all typing holes have been plugged and we are left
  * with a fully typed tree structure.
- *
- * @module Block/BlockTree/Inheritable
  */
 import { ObjectDictionary } from "@opticss/util";
 import { ParsedSelector, SelectorFactory, parseSelector, postcss } from "opticss";

packages/code-style/.vscode/settings.json packages/@css-blocks/code-style/.vscode/settings.json

@@ -5,8 +5,6 @@
  * Every `Style` object has a `RulesetContainer`. A `Style` object's behavior may be defined
  * by multiple rulesets, and may have multiple stylable targets (ex: `::self`, `::before`,
  * `::after`). Every ruleset may provide resolution guidance against another `Style` object.
- *
- * @module Block/BlockTree/RulesetContainer
  */
 import { MultiMap, TwoKeyMultiMap } from "@opticss/util";
 import * as propParser from "css-property-parser";

packages/code-style/configs/tslint.cli.json packages/@css-blocks/code-style/configs/tslint.cli.json

@@ -1,4 +1,3 @@
-
 export interface ErrorLocation {
   filename?: string;
   line?: number;

packages/code-style/configs/tslint.interactive.json packages/@css-blocks/code-style/configs/tslint.interactive.json

@@ -1,18 +1,17 @@
 {
-  "extends": "../../tsconfig.json",
+  "extends": "../../../tsconfig.json",
   "compilerOptions": {
-    // output options
     "outDir": "dist",
     "baseUrl": "dist",
     "paths": {
       "perfectionist": [
-        "../types-local/perfectionist"
+        "../../../../types-local/perfectionist"
       ],
       "regexpu-core": [
-        "../types-local/regexpu-core"
+        "../../../../types-local/regexpu-core"
       ],
       "inline-source-map-comment": [
-        "../types-local/inline-source-map-comment"
+        "../../../../types-local/inline-source-map-comment"
       ]
     }
   },

packages/code-style/configs/tslint.release.json packages/@css-blocks/code-style/configs/tslint.release.json

@@ -1,5 +1,5 @@
 {
-  "name": "@css-blocks/glimmer-templates",
+  "name": "@css-blocks/glimmer",
   "version": "0.17.0",
   "description": "Statically analyze & rewrite the css-block styles in Handlebars templates.",
   "main": "dist/src/index.js",
@@ -32,7 +32,7 @@
     "static",
     "analysis",
     "handlebars",
-    "css-blocks",
+    "@css-blocks/core",
     "css",
     "optimizer"
   ],
@@ -47,7 +47,7 @@
   "engines": {
     "node": ">=8"
   },
-  "homepage": "https://github.com/css-blocks/css-blocks/tree/master/packages/glimmer-templates#readme",
+  "homepage": "https://github.com/css-blocks/css-blocks/tree/master/packages/@css-blocks/glimmer#readme",
   "devDependencies": {
     "@css-blocks/code-style": "^0.17.0"
   },
@@ -56,11 +56,11 @@
     "@glimmer/resolution-map-builder": "0.5.1",
     "@glimmer/resolver": "^0.4.3",
     "@glimmer/syntax": "^0.33.0",
-    "@opticss/element-analysis": "file:../../../opticss/packages/element-analysis",
-    "@opticss/template-api": "file:../../../opticss/packages/template-api",
-    "@opticss/util": "file:../../../opticss/packages/util",
+    "@opticss/element-analysis": "file:../../../../opticss/packages/element-analysis",
+    "@opticss/template-api": "file:../../../../opticss/packages/template-api",
+    "@opticss/util": "file:../../../../opticss/packages/util",
     "@types/glob": "^5.0.30",
-    "css-blocks": "^0.17.0",
+    "@css-blocks/core": "^0.17.0",
     "debug": "^2.6.8",
     "glimmer-analyzer": "^0.2.0",
     "glob": "^7.1.2",