chore: Use ObjectDictionary where possible.

Author: chriseppstein

Diff for: css-blocks.code-workspace

@@ -34,7 +34,9 @@
 			"pseudoclass",
 			"pseudoclasses",
 			"pseudoelement",
-			"rulesets"
+			"rulesets",
+			"preprocessor",
+			"preprocessors"
 		],
 		"cSpell.ignorePaths": [
 			"**/node_modules/**",

Diff for: packages/css-blocks/src/BlockParser/BlockFactory.ts

@@ -1,3 +1,4 @@
+import { ObjectDictionary } from "@opticss/util";
 import * as debugGenerator from "debug";
 import * as path from "path";
 import * as postcss from "postcss";
@@ -35,13 +36,13 @@ export class BlockFactory {
   postcssImpl: typeof postcss;
   importer: Importer;
   options: CssBlockOptionsReadonly;
-  blockNames: { [name: string]: number };
+  blockNames: ObjectDictionary<number>;
   parser: BlockParser;
   preprocessors: Preprocessors;
 
-  private promises: { [identifier: string]: Promise<Block> };
-  private blocks: { [identifier: string]: Block };
-  private paths: { [path: string]: string };
+  private promises: ObjectDictionary<Promise<Block>>;
+  private blocks: ObjectDictionary<Block>;
+  private paths: ObjectDictionary<string>;
   private preprocessQueue: PromiseQueue<PreprocessJob, ProcessedFile>;
 
   constructor(options: CssBlockOptionsReadonly, postcssImpl = postcss) {

Diff for: packages/css-blocks/src/BlockParser/features/resolve-references.ts

@@ -1,3 +1,4 @@
+import { ObjectDictionary } from "@opticss/util";
 import * as postcss from "postcss";
 
 import { Block } from "../../Block";
@@ -51,7 +52,7 @@ export async function resolveReferences(block: Block, factory: BlockFactory, fil
 
   // When all import promises have resolved, save the block references and resolve.
   return Promise.all(namedBlockReferences).then((results) => {
-    let localNames: {[name: string]: string} = {};
+    let localNames: ObjectDictionary<string> = {};
     results.forEach(([localName, importPath, atRule, otherBlock]) => {
       if (localNames[localName]) {
         throw new errors.InvalidBlockSyntax(

Diff for: packages/css-blocks/src/TemplateAnalysis/ElementAnalysis.ts

@@ -829,7 +829,7 @@ function serializeDynamicAttrs(c: DynamicAttrs<whatever, whatever>, styleIndexes
     stringExpression: true,
     condition: true,
     value: 0,
-    group: {} as {[n: string]: number},
+    group: {} as ObjectDictionary<number>,
     container: 0,
     disallowFalsy: false,
   };

Diff for: packages/css-blocks/src/TemplateAnalysis/TemplateAnalysis.ts

@@ -279,7 +279,7 @@ export class TemplateAnalysis<K extends keyof TemplateTypes> implements StyleAna
   serialize(): SerializedTemplateAnalysis<K> {
     let blocks = {};
     let stylesFound: string[] = [];
-    let elements: { [id: string]: SerializedElementAnalysis } = {};
+    let elements: ObjectDictionary<SerializedElementAnalysis> = {};
     let template = this.template.serialize();
     let styleNameMap = new Map<Style, string>();
     let styleIndexes = new Map<Style, number>();

Diff for: packages/css-blocks/src/TemplateAnalysis/validations/index.ts

@@ -1,9 +1,10 @@
+import { ObjectDictionary } from "@opticss/util";
+
 import * as errors from "../../errors";
 import { ElementAnalysis } from "../ElementAnalysis";
 import { StyleAnalysis } from "../StyleAnalysis";
 
 import { Validator } from "./Validator";
-
 import { attributeGroupValidator } from "./attribute-group-validator";
 import { attributeParentValidator } from "./attribute-parent-validator";
 import { classPairsValidator } from "./class-pairs-validator";
@@ -15,13 +16,12 @@ export * from "./root-class-validator";
 export * from "./attribute-parent-validator";
 export * from "./property-conflict-validator";
 
-export interface TemplateValidators {
+export interface TemplateValidators extends ObjectDictionary<Validator> {
   "no-root-classes": Validator;
   "no-class-pairs": Validator;
   "no-attribute-orphans": Validator;
   "no-duplicate-attribute-groups": Validator;
   "no-required-resolution": Validator;
-  [name: string]: Validator;
 }
 
 export type TemplateValidatorOptions = {

Diff for: packages/css-blocks/src/TemplateRewriter/RewriteMapping.ts

@@ -9,19 +9,20 @@ import {
   SimpleAttribute,
   SimpleTagname,
 } from "@opticss/template-api";
-import { assertNever, Maybe, maybe, objectValues } from "@opticss/util";
+import { assertNever, Maybe, maybe, ObjectDictionary, objectValues } from "@opticss/util";
 import { inspect } from "util";
 
 import { Style } from "../Block";
 
 import { ClassRewrite, IndexedClassRewrite } from "./ClassRewrite";
 
+export type ClassExpressionMap = ObjectDictionary<BooleanExpression<number> | undefined>;
 export class IndexedClassMapping implements IndexedClassRewrite<Style> {
   inputs: Style[];
   staticClasses: string[];
-  private map: { [k: string]: BooleanExpression<number> | undefined };
+  private map: ClassExpressionMap;
   private _inputMap: Map<Style, number>;
-  constructor(inputs: Style[], staticClasses: string[], map: {[k: string]: BooleanExpression<number> | undefined}) {
+  constructor(inputs: Style[], staticClasses: string[], map: ClassExpressionMap) {
     this.inputs = inputs;
     this.staticClasses = staticClasses;
     this._inputMap = new Map<Style, number>();

Diff for: packages/css-blocks/src/importing.ts

@@ -1,4 +1,4 @@
-import { whatever } from "@opticss/util";
+import { ObjectDictionary, whatever } from "@opticss/util";
 import * as fs from "fs";
 import * as path from "path";
 
@@ -12,9 +12,7 @@ declare module "./options" {
   }
 }
 
-export interface ImporterData {
-  [key: string]: whatever;
-}
+export type ImporterData = ObjectDictionary<whatever>;
 
 /**
  * A FileIdentifier is a string with a whatever internal encoding is needed to uniquely resolve
@@ -179,12 +177,7 @@ export interface Alias {
   path: string;
 }
 
-export type PathAliases = Alias[] | {
-  /**
-   * map of alias prefixes to absolute paths.
-   */
-  [alias: string]: string;
-};
+export type PathAliases = Alias[] | ObjectDictionary<string>;
 
 /**
  * The PathAliasImporter is a replacement for the fileystem importer. Relative import paths

Diff for: packages/css-blocks/test/util/MockImportRegistry.ts

@@ -1,3 +1,4 @@
+import { ObjectDictionary } from "@opticss/util";
 import { assert } from "chai";
 import * as path from "path";
 
@@ -6,17 +7,12 @@ import { OptionsReader } from "../../src/OptionsReader";
 import { ImportedFile, Importer, PathBasedImporter } from "../../src/importing";
 
 const PROJECT_DIR = path.resolve(__dirname, "../../..");
-
-export interface SourceRegistry {
-  [sourcePath: string]: {
-    contents: string;
-    syntax: Syntax;
-  };
-}
-
-export interface ImportedFiles {
-  [sourcePath: string]: boolean;
+export interface SourceWithSyntax {
+  contents: string;
+  syntax: Syntax;
 }
+export type SourceRegistry = ObjectDictionary<SourceWithSyntax>;
+export type ImportedFiles = ObjectDictionary<boolean>;
 
 export class MockImporter extends PathBasedImporter {
   registry: MockImportRegistry;

Diff for: packages/jsx/src/analyzer/types.ts

@@ -1,4 +1,5 @@
 import { SourceLocation } from "@opticss/element-analysis";
+import { ObjectDictionary } from "@opticss/util";
 import { Expression } from "babel-types";
 import { ElementAnalysis } from "css-blocks";
 
@@ -7,10 +8,7 @@ export type StringExpression = Expression;
 export type TernaryExpression = Expression;
 
 export type JSXElementAnalysis = ElementAnalysis<BooleanExpression, StringExpression, TernaryExpression>;
-
-export interface Flags {
-  [flag: string]: boolean;
-}
+export type Flags = ObjectDictionary<boolean>;
 
 export function newJSXElementAnalysis(location: SourceLocation, tagName?: string, id?: string): JSXElementAnalysis {
   return new ElementAnalysis<BooleanExpression, StringExpression, TernaryExpression>(location, tagName, id);

Diff for: packages/jsx/src/importer/index.ts

@@ -1,3 +1,4 @@
+import { ObjectDictionary } from "@opticss/util";
 import { NodePath } from "babel-traverse";
 import {
   ClassDeclaration,
@@ -27,16 +28,12 @@ const VALID_FILE_EXTENSIONS = {
   ".jsx": 1, ".tsx": 1,
 };
 
-interface BlockRegistry {
-  [key: string]: number;
-}
-
 /**
- * If a given block name is in the passed BlockRegistry, throw.
+ * If a given block name is in the passed registry, throw.
  * @param name The Block name in question.
  * @param registry The registry to check.
  */
-function throwIfRegistered(name: string, blockRegistry: BlockRegistry, loc: ErrorLocation) {
+function throwIfRegistered(name: string, blockRegistry: ObjectDictionary<number>, loc: ErrorLocation) {
   // TODO: Location reporting in errors.
   if (blockRegistry[name]) {
     throw new TemplateImportError(`Block identifier "${name}" cannot be re-defined in any scope once imported.`, loc);
@@ -57,7 +54,7 @@ export function importer(file: JSXTemplate, analysis: Analysis, blockFactory: Bl
 
   // Keep a running record of local block names while traversing so we can check
   // for name conflicts elsewhere in the file.
-  let _localBlocks: BlockRegistry = {};
+  let _localBlocks: ObjectDictionary<number> = {};
   let dirname = path.dirname(file.identifier);
   let aliases = options.aliases || {};
 

Diff for: packages/jsx/src/index.ts

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import * as path from "path";
 
 import {
-  some, unwrap,
+  ObjectDictionary, some, unwrap,
 } from "@opticss/util";
 import traverse from "babel-traverse";
 import * as babylon from "babylon";
@@ -43,7 +43,7 @@ function readFile(filename: string, encoding?: string | null): Promise<string |
 export interface JSXAnalyzerOptions {
    baseDir: string;
    parserOptions?: object;
-   aliases?: { [alias: string]: string };
+   aliases?: ObjectDictionary<string>;
    compilationOptions?: CssBlocksOptions;
  }
 

Diff for: packages/jsx/src/transformer/index.ts

@@ -1,8 +1,8 @@
-import { whatever } from "@opticss/util";
+import { ObjectDictionary, whatever } from "@opticss/util";
 import { CssBlockOptionsReadonly, PluginOptions, PluginOptionsReader, StyleMapping } from "css-blocks";
 
 export interface RewriterOptions {
-  meta?: { [metaProp: string]: whatever };
+  meta?: ObjectDictionary<whatever>;
   cssBlocks: {
     styleMapping: StyleMapping | null;
     compilationOptions: PluginOptions;
@@ -18,7 +18,7 @@ export class CSSBlocksJSXTransformer {
 
   styleMapping: StyleMapping | null;
   cssBlockOptions: CssBlockOptionsReadonly;
-  blocks: { [path: string]: StyleMapping } = {};
+  blocks: ObjectDictionary<StyleMapping> = {};
 
   constructor(opts?: RewriterOptions) {
     this.cssBlockOptions = new PluginOptionsReader(opts && opts.cssBlocks && opts.cssBlocks.compilationOptions);

Diff for: packages/jsx/src/utils/Analysis.ts

@@ -3,7 +3,7 @@ import {
   TemplateInfo,
   TemplateInfoFactory,
 } from "@opticss/template-api";
-import { Maybe, none, whatever } from "@opticss/util";
+import { Maybe, none, ObjectDictionary, whatever } from "@opticss/util";
 import { File } from "babel-types";
 import {
   Block,
@@ -69,7 +69,7 @@ export class MetaAnalysis extends MetaTemplateAnalysis {
 
   files: JSXTemplate[] = [];
   analysisPromises: Promise<Analysis>[] = [];
-  blockPromises: { [path: string]: Promise<Block> } = {};
+  blockPromises: ObjectDictionary<Promise<Block>> = {};
 
   fileCount(): number {
     return this.analyses.length;

Diff for: packages/webpack-plugin/src/CssAssets.ts

@@ -1,3 +1,4 @@
+import { ObjectDictionary } from "@opticss/util";
 import * as  async from "async";
 import * as convertSourceMap from "convert-source-map";
 import * as debugGenerator from "debug";
@@ -82,17 +83,13 @@ export interface ConcatenationOptions {
  */
 export interface CssAssetsOptions {
     /** Maps css files from a source location to a webpack asset location. */
-    cssFiles: {
-        [assetPath: string]: string | CssSourceOptions;
-    };
+    cssFiles: ObjectDictionary<string | CssSourceOptions>;
     /**
      * Maps several webpack assets to a new concatenated asset and manages their
      * sourcemaps. The concatenated asset will belong to all the chunks to which
      * the assets belonged.
      */
-    concat: {
-        [concatAssetPath: string]: string[] | ConcatenationOptions;
-    };
+    concat: ObjectDictionary<string[] | ConcatenationOptions>;
 
     /**
      * When true, any source maps related to the assets are written out as

Diff for: packages/webpack-plugin/src/LoaderOptions.ts

@@ -1,4 +1,4 @@
+import { ObjectDictionary } from "@opticss/util";
+
 import { WebpackAny } from "./Plugin";
-export interface LoaderOptions {
-    [opt: string]: WebpackAny;
-}
+export type LoaderOptions = ObjectDictionary<WebpackAny>;

Diff for: packages/webpack-plugin/src/Plugin.ts

@@ -9,6 +9,7 @@ import { RawSource, Source, SourceMapSource } from "webpack-sources";
 import {
   TemplateTypes,
 } from "@opticss/template-api";
+import { ObjectDictionary } from "@opticss/util";
 import {
   Block,
   BlockCompiler,
@@ -58,9 +59,7 @@ export interface BlockCompilationComplete {
   optimizerActions: Actions;
 }
 
-interface Assets {
-  [key: string]: Source;
-}
+type Assets = ObjectDictionary<Source>;
 
 interface CompilationResult {
   optimizationResult: OptimizationResult;

Diff for: packages/webpack-plugin/test/configs/templateConfig.ts

@@ -6,7 +6,7 @@ import {
   TemplateInfo,
   TemplateInfoFactory,
 } from "@opticss/template-api";
-import { whatever } from "@opticss/util";
+import { ObjectDictionary, whatever } from "@opticss/util";
 import {
   Block,
   BlockFactory,
@@ -56,7 +56,7 @@ export class TestTemplateInfo implements TemplateInfo<"WebpackPlugin.TestTemplat
 TemplateInfoFactory.constructors["WebpackPlugin.TestTemplate"] = TestTemplateInfo.deserialize;
 
 class TestAnalysis extends TemplateAnalysis<"WebpackPlugin.TestTemplate"> {
-  blocks: { [name: string]: Block } = {};
+  blocks: ObjectDictionary<Block> = {};
   constructor(template: TestTemplateInfo) {
     super(template);
   }

Diff for: packages/webpack-plugin/test/util/MockImportRegistry.ts

@@ -1,17 +1,13 @@
 import { assert } from "chai";
 import * as path from "path";
 
+import { ObjectDictionary } from "@opticss/util";
 import { ImportedFile, Importer, PathBasedImporter, PluginOptionsReader, Syntax } from "css-blocks";
 
 const PROJECT_DIR = path.resolve(__dirname, "../../..");
 
-export interface SourceRegistry {
-  [sourcePath: string]: string;
-}
-
-export interface ImportedFiles {
-  [sourcePath: string]: boolean;
-}
+export type SourceRegistry = ObjectDictionary<string>;
+export type ImportedFiles = ObjectDictionary<boolean>;
 
 export class MockImporter extends PathBasedImporter {
   registry: MockImportRegistry;