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

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

@@ -6,7 +6,7 @@
   "author": "Adam Miller <[email protected]>",
   "license": "MIT",
   "keywords": [
-    "css-blocks",
+    "@css-blocks/core",
     "css blocks",
     "broccoli-plugin"
   ],
@@ -46,4 +46,4 @@
     "recursive-readdir": "^2.2.2",
     "walk-sync": "^0.3.2"
   }
-}
+}

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

@@ -92,7 +92,7 @@ class BroccoliCSSBlocks extends BroccoliPlugin {
 
     // Run optimization and compute StyleMapping.
     let optimized = await optimizer.optimize(this.output);
-    let styleMapping = new StyleMapping(optimized.styleMapping, blocks, options, this.analyzer.analyses());
+    let styleMapping = new StyleMapping<keyof TemplateTypes>(optimized.styleMapping, blocks, options, this.analyzer.analyses());
 
     // Attach all computed data to our magic shared memory transport object...
     this.transport.mapping = styleMapping;

packages/@css-blocks/core/src/Analyzer/Analysis.ts

@@ -1,9 +1,9 @@
 // tslint:disable-next-line:no-unused-variable Imported for Documentation link
 import {
+  isSourcePosition,
   POSITION_UNKNOWN,
   SourceLocation,
   SourcePosition,
-  isSourcePosition,
 } from "@opticss/element-analysis";
 import {
   SerializedTemplateInfo,

packages/@css-blocks/core/src/Analyzer/Analyzer.ts

@@ -10,8 +10,8 @@ import { BlockFactory } from "../BlockParser";
 import { Block, Style } from "../BlockTree";
 import {
   Options,
-  ResolvedConfiguration,
   resolveConfiguration,
+  ResolvedConfiguration,
 } from "../configuration";
 
 import { Analysis, SerializedAnalysis } from "./Analysis";

packages/@css-blocks/core/src/Analyzer/ElementAnalysis.ts

@@ -4,14 +4,14 @@ import {
   AttributeValueChoiceOption,
   AttributeValueSet,
   AttributeValueSetItem,
+  attrValues,
   Element,
+  isConstant,
   POSITION_UNKNOWN,
   SourceLocation,
   Tagname,
   ValueAbsent,
   ValueConstant,
-  attrValues,
-  isConstant,
 } from "@opticss/element-analysis";
 import {
   MultiMap,
@@ -21,13 +21,13 @@ import {
 } from "@opticss/util";
 
 import {
-  AttrValue,
   Attribute,
+  AttrValue,
   Block,
   BlockClass,
-  Style,
   isAttrValue,
   isBlockClass,
+  Style,
 } from "../BlockTree";
 import {
   ResolvedConfiguration,

packages/@css-blocks/core/src/Analyzer/validations/index.ts

@@ -5,12 +5,12 @@ import * as errors from "../../errors";
 import { Analysis } from "../Analysis";
 import { ElementAnalysis } from "../ElementAnalysis";
 
+import { Validator } from "./Validator";
 import { attributeGroupValidator } from "./attribute-group-validator";
 import { attributeParentValidator } from "./attribute-parent-validator";
 import { classPairsValidator } from "./class-pairs-validator";
 import { propertyConflictValidator } from "./property-conflict-validator";
 import { rootClassValidator } from "./root-class-validator";
-import { Validator } from "./Validator";
 
 export * from "./class-pairs-validator";
 export * from "./root-class-validator";

packages/@css-blocks/core/src/Analyzer/validations/property-conflict-validator.ts

@@ -1,4 +1,4 @@
-import { MultiMap, TwoKeyMultiMap, objectValues } from "@opticss/util";
+import { MultiMap, objectValues, TwoKeyMultiMap } from "@opticss/util";
 import * as propParser from "css-property-parser";
 import { postcss } from "opticss";
 

packages/@css-blocks/core/src/BlockCompiler/ConflictResolver.ts

@@ -4,10 +4,10 @@ import { CompoundSelector, ParsedSelector, parseSelector, postcss, postcssSelect
 import { getBlockNode } from "../BlockParser";
 import { RESOLVE_RE } from "../BlockSyntax";
 import { Block, Style } from "../BlockTree";
+import { SourceLocation, sourceLocation } from "../SourceLocation";
 import { ResolvedConfiguration } from "../configuration";
 import * as errors from "../errors";
 import { QueryKeySelector } from "../query";
-import { SourceLocation, sourceLocation } from "../SourceLocation";
 
 import { Conflicts, detectConflicts } from "./conflictDetection";
 

packages/@css-blocks/core/src/BlockCompiler/index.ts

@@ -6,14 +6,14 @@ import {
   BLOCK_DEBUG,
   BLOCK_PROP_NAMES_RE,
   BLOCK_REFERENCE,
-  ROOT_CLASS,
   parseBlockDebug,
+  ROOT_CLASS,
 } from "../BlockSyntax";
 import { Block } from "../BlockTree";
 import {
   Options,
-  ResolvedConfiguration,
   resolveConfiguration,
+  ResolvedConfiguration,
 } from "../configuration";
 
 import { ConflictResolver } from "./ConflictResolver";

packages/@css-blocks/core/src/BlockParser/BlockFactory.ts

@@ -5,12 +5,12 @@ import * as path from "path";
 import { RawSourceMap } from "source-map";
 
 import { Block } from "../BlockTree";
-import { Options, ResolvedConfiguration, resolveConfiguration } from "../configuration";
+import { Options, resolveConfiguration, ResolvedConfiguration } from "../configuration";
 import { FileIdentifier, ImportedFile, Importer } from "../importing";
 import { PromiseQueue } from "../util/PromiseQueue";
 
 import { BlockParser, ParsedSource } from "./BlockParser";
-import { Preprocessor, Preprocessors, ProcessedFile, Syntax, annotateCssContentWithSourceMap, syntaxName } from "./preprocessing";
+import { annotateCssContentWithSourceMap, Preprocessor, Preprocessors, ProcessedFile, Syntax, syntaxName } from "./preprocessing";
 
 const debug = debugGenerator("css-blocks:BlockFactory");
 

packages/@css-blocks/core/src/BlockParser/BlockParser.ts

@@ -1,7 +1,7 @@
 import { postcss } from "opticss";
 
 import { Block } from "../BlockTree";
-import { Options, ResolvedConfiguration, resolveConfiguration } from "../configuration";
+import { Options, resolveConfiguration, ResolvedConfiguration } from "../configuration";
 import * as errors from "../errors";
 import { FileIdentifier } from "../importing";
 

packages/@css-blocks/core/src/BlockParser/features/assert-foreign-global-attribute.ts

@@ -1,8 +1,8 @@
 import { postcss } from "opticss";
 
 import { Block } from "../../BlockTree";
-import * as errors from "../../errors";
 import { selectorSourceLocation as loc } from "../../SourceLocation";
+import * as errors from "../../errors";
 import {
   BlockType,
   getBlockNode,

packages/@css-blocks/core/src/BlockParser/features/construct-block.ts

@@ -2,19 +2,19 @@ import { assertNever } from "@opticss/util";
 import { CompoundSelector, ParsedSelector, postcss, postcssSelectorParser as selectorParser } from "opticss";
 
 import { Block, Style } from "../../BlockTree";
-import * as errors from "../../errors";
 import { selectorSourceLocation as loc, sourceLocation } from "../../SourceLocation";
+import * as errors from "../../errors";
 import {
   BlockNodeAndType,
   BlockType,
-  NodeAndType,
   blockTypeName,
   getBlockNode,
   isAttributeNode,
   isClassLevelObject,
   isClassNode,
   isRootLevelObject,
   isRootNode,
+  NodeAndType,
   toAttrToken,
 } from "../block-intermediates";
 

packages/@css-blocks/core/src/BlockParser/features/disallow-important.ts

@@ -1,7 +1,7 @@
 import { postcss } from "opticss";
 
-import * as errors from "../../errors";
 import { sourceLocation as loc } from "../../SourceLocation";
+import * as errors from "../../errors";
 
 export async function disallowImportant(root: postcss.Root, file: string): Promise<postcss.Root> {
   root.walkDecls((decl) => {

packages/@css-blocks/core/src/BlockParser/features/discover-name.ts

@@ -1,8 +1,8 @@
 import { postcss } from "opticss";
 
 import { BLOCK_NAME, CLASS_NAME_IDENT } from "../../BlockSyntax";
-import * as errors from "../../errors";
 import { sourceLocation } from "../../SourceLocation";
+import * as errors from "../../errors";
 
 export async function discoverName(root: postcss.Root, defaultName: string, file: string): Promise<string> {
 

packages/@css-blocks/core/src/BlockParser/features/extend-block.ts

@@ -2,8 +2,8 @@ import { postcss } from "opticss";
 
 import { EXTENDS } from "../../BlockSyntax";
 import { Block } from "../../BlockTree";
-import * as errors from "../../errors";
 import { sourceLocation } from "../../SourceLocation";
+import * as errors from "../../errors";
 
 /**
  * For each `extends` property found in the passed ruleset, set the block's base

packages/@css-blocks/core/src/BlockParser/features/global-attributes.ts

@@ -2,8 +2,8 @@ import { parseSelector, postcss, postcssSelectorParser as selectorParser } from
 
 import { BLOCK_GLOBAL } from "../../BlockSyntax";
 import { Block } from "../../BlockTree";
-import * as errors from "../../errors";
 import { sourceLocation as loc } from "../../SourceLocation";
+import * as errors from "../../errors";
 import { toAttrToken } from "../block-intermediates";
 
 export async function globalAttributes(root: postcss.Root, block: Block, file: string): Promise<Block> {

packages/@css-blocks/core/src/BlockParser/features/implement-block.ts

@@ -2,8 +2,8 @@ import { postcss } from "opticss";
 
 import { IMPLEMENTS } from "../../BlockSyntax";
 import { Block } from "../../BlockTree";
-import * as errors from "../../errors";
 import { sourceLocation } from "../../SourceLocation";
+import * as errors from "../../errors";
 
 /**
  * For each `implements` property found in the passed ruleset, track the foreign

packages/@css-blocks/core/src/BlockParser/features/resolve-references.ts

@@ -3,8 +3,8 @@ import { postcss } from "opticss";
 
 import { BLOCK_REFERENCE, CLASS_NAME_IDENT } from "../../BlockSyntax";
 import { Block } from "../../BlockTree";
-import * as errors from "../../errors";
 import { sourceLocation } from "../../SourceLocation";
+import * as errors from "../../errors";
 import { BlockFactory } from "../index";
 
 /**

packages/@css-blocks/core/src/BlockSyntax/parseBlockDebug.ts

@@ -1,8 +1,8 @@
 import { postcss } from "opticss";
 
 import { Block } from "../BlockTree";
-import * as errors from "../errors";
 import { sourceLocation } from "../SourceLocation";
+import * as errors from "../errors";
 
 export type DebugChannel = "comment" | "stderr" | "stdout";
 

packages/@css-blocks/core/src/BlockTree/Attribute.ts

@@ -6,7 +6,7 @@ import {
   ValueAbsent,
   ValueConstant,
 } from "@opticss/element-analysis";
-import { ObjectDictionary, assertNever } from "@opticss/util";
+import { assertNever, ObjectDictionary } from "@opticss/util";
 
 import { ATTR_PRESENT, IAttrToken as AttrToken } from "../BlockSyntax";
 import { OutputMode, ResolvedConfiguration } from "../configuration";

packages/@css-blocks/core/src/BlockTree/Block.ts

@@ -1,4 +1,4 @@
-import { MultiMap, ObjectDictionary, assertNever } from "@opticss/util";
+import { assertNever, MultiMap, ObjectDictionary } from "@opticss/util";
 import { whatever } from "@opticss/util";
 import {
   CompoundSelector,
@@ -10,16 +10,16 @@ import {
 
 import {
   BlockType,
-  NodeAndType,
   isAttributeNode,
   isClassNode,
+  NodeAndType,
 } from "../BlockParser";
 import { isRootNode, toAttrToken } from "../BlockParser";
 import { BlockPath, CLASS_NAME_IDENT, ROOT_CLASS } from "../BlockSyntax";
+import { SourceLocation } from "../SourceLocation";
 import { ResolvedConfiguration } from "../configuration";
 import { CssBlockError, InvalidBlockSyntax } from "../errors";
 import { FileIdentifier } from "../importing";
-import { SourceLocation } from "../SourceLocation";
 
 import { BlockClass } from "./BlockClass";
 import { Inheritable } from "./Inheritable";

packages/@css-blocks/core/src/BlockTree/BlockClass.ts

@@ -6,8 +6,8 @@ import { ATTR_PRESENT, IAttrToken as AttrToken, ROOT_CLASS } from "../BlockSynta
 import { BlockPath } from "../BlockSyntax";
 import { OutputMode, ResolvedConfiguration } from "../configuration";
 
-import { Attribute } from "./Attribute";
 import { AttrValue } from "./AttrValue";
+import { Attribute } from "./Attribute";
 import { Block } from "./Block";
 import { RulesetContainer } from "./RulesetContainer";
 import { Style } from "./Style";

packages/@css-blocks/core/src/BlockTree/RulesetContainer.ts

@@ -11,10 +11,10 @@ import * as propParser from "css-property-parser";
 import { ParsedSelector, postcss } from "opticss";
 
 import { BLOCK_PROP_NAMES, RESOLVE_RE, SELF_SELECTOR } from "../BlockSyntax";
-import { InvalidBlockSyntax } from "../errors";
 import { sourceLocation } from "../SourceLocation";
+import { InvalidBlockSyntax } from "../errors";
 
-import { Styles, isStyle } from "./Styles";
+import { isStyle, Styles } from "./Styles";
 export { Styles, BlockClass, AttrValue } from "./Styles";
 
 // Convenience types to help our code read better.

packages/@css-blocks/core/src/Plugin.ts

@@ -0,0 +1,50 @@
+import { postcss } from "opticss";
+
+import { BlockCompiler } from "./BlockCompiler";
+import { BlockFactory } from "./BlockParser";
+import { Options, resolveConfiguration, ResolvedConfiguration } from "./configuration";
+import * as errors from "./errors";
+
+/**
+ * CSS Blocks PostCSS plugin.
+ */
+export class Plugin {
+  private config: ResolvedConfiguration;
+  private postcss: typeof postcss;
+
+  /**
+   * @param  postcssImpl  PostCSS instance to use
+   * @param  opts  Optional plugin config options
+   */
+  constructor(postcssImpl: typeof postcss, opts?: Options) {
+    this.config = resolveConfiguration(opts);
+    this.postcss = postcssImpl;
+  }
+
+  /**
+   * Main processing entrypoint for PostCSS Plugin
+   * @param  root  PostCSS AST
+   * @param  result  Provides the result of the PostCSS transformations
+   */
+  public process(root: postcss.Root, result: postcss.Result) {
+
+    // Fetch the CSS source file path. Throw if not present.
+    let sourceFile: string;
+    if (result && result.opts && result.opts.from) {
+      sourceFile = result.opts.from;
+    } else {
+      throw new errors.MissingSourcePath();
+    }
+
+    // Fetch block name from importer
+    let identifier = this.config.importer.identifier(null, sourceFile, this.config);
+    let defaultName: string = this.config.importer.defaultName(identifier, this.config);
+    let factory = new BlockFactory(this.config, this.postcss);
+
+    return factory.parse(root, sourceFile, defaultName).then((block) => {
+      let compiler = new BlockCompiler(postcss, this.config);
+      compiler.compile(block, root);
+    });
+  }
+
+}

packages/@css-blocks/core/src/TemplateRewriter/RewriteMapping.ts

@@ -1,15 +1,15 @@
 import {
   BooleanExpression,
-  RewriteMapping as OptimizedMapping,
-  SimpleAttribute,
-  SimpleTagname,
   isAndExpression,
   isBooleanExpression,
   isNotExpression,
   isOrExpression,
   isSimpleTagname,
+  RewriteMapping as OptimizedMapping,
+  SimpleAttribute,
+  SimpleTagname,
 } from "@opticss/template-api";
-import { Maybe, ObjectDictionary, assertNever, maybe, objectValues } from "@opticss/util";
+import { assertNever, Maybe, maybe, ObjectDictionary, objectValues } from "@opticss/util";
 import { inspect } from "util";
 
 import { Style } from "../BlockTree";

packages/@css-blocks/core/src/configuration/resolver.ts

@@ -1,8 +1,8 @@
 import { Preprocessors } from "../BlockParser";
 import {
+  filesystemImporter,
   Importer,
   ImporterData,
-  filesystemImporter,
 } from "../importing";
 
 import { OutputMode } from "./OutputMode";