feat: Rename normalizeOptions to resolveConfiguration.

BREAKING CHANGE:

To bring naming inline with the new ResolvedConfiguration type, the
normalizeOptions function is now named resolveConfiguration.  The module
named normalizeOptions has been renamed to resolver in the configuration
module folder.

Author: chriseppstein

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

@@ -10,8 +10,8 @@ import {
 } from "../BlockSyntax";
 import { StyleAnalysis } from "../TemplateAnalysis/StyleAnalysis";
 import {
-  normalizeOptions,
   Options,
+  resolveConfiguration,
   ResolvedConfiguration,
 } from "../configuration";
 
@@ -25,7 +25,7 @@ export class BlockCompiler {
   private postcss: typeof postcss;
 
   constructor(postcssImpl: typeof postcss, opts?: Options) {
-    this.config = normalizeOptions(opts);
+    this.config = resolveConfiguration(opts);
     this.postcss = postcssImpl;
   }
 

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

@@ -5,8 +5,7 @@ import * as postcss from "postcss";
 import { RawSourceMap } from "source-map";
 
 import { Block } from "../Block";
-import { normalizeOptions } from "../configuration/normalizeOptions";
-import { Options, ResolvedConfiguration } from "../configuration/types";
+import { Options, resolveConfiguration, ResolvedConfiguration } from "../configuration";
 import { FileIdentifier, ImportedFile, Importer } from "../importing";
 import { PromiseQueue } from "../util/PromiseQueue";
 
@@ -48,7 +47,7 @@ export class BlockFactory {
 
   constructor(options: Options, postcssImpl = postcss) {
     this.postcssImpl = postcssImpl;
-    this.configuration = normalizeOptions(options);
+    this.configuration = resolveConfiguration(options);
     this.importer = this.configuration.importer;
     this.preprocessors = this.configuration.preprocessors;
     this.parser = new BlockParser(options, this);

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

@@ -1,8 +1,7 @@
 import * as postcss from "postcss";
 
 import { Block } from "../Block";
-import { normalizeOptions } from "../configuration/normalizeOptions";
-import { Options, ResolvedConfiguration } from "../configuration/types";
+import { Options, resolveConfiguration, ResolvedConfiguration } from "../configuration";
 import * as errors from "../errors";
 import { FileIdentifier } from "../importing";
 
@@ -36,7 +35,7 @@ export class BlockParser {
   private factory: BlockFactory;
 
   constructor(opts: Options, factory: BlockFactory) {
-    this.config = normalizeOptions(opts);
+    this.config = resolveConfiguration(opts);
     this.factory = factory;
   }
 

packages/css-blocks/src/Plugin.ts

@@ -2,8 +2,7 @@ import * as postcss from "postcss";
 
 import { BlockCompiler } from "./BlockCompiler";
 import { BlockFactory } from "./BlockParser";
-import { Options, ResolvedConfiguration } from "./configuration";
-import { normalizeOptions } from "./configuration/normalizeOptions";
+import { Options, resolveConfiguration, ResolvedConfiguration } from "./configuration";
 import * as errors from "./errors";
 
 /**
@@ -18,7 +17,7 @@ export class Plugin {
    * @param  opts  Optional plugin config options
    */
   constructor(postcssImpl: typeof postcss, opts?: Options) {
-    this.config = normalizeOptions(opts);
+    this.config = resolveConfiguration(opts);
     this.postcss = postcssImpl;
   }
 

packages/css-blocks/src/configuration/index.ts

@@ -1,3 +1,3 @@
 export * from "./types";
 export * from "./OutputMode";
-export * from "./normalizeOptions";
+export * from "./resolver";

…ks/src/configuration/normalizeOptions.ts …css-blocks/src/configuration/resolver.tspackages/css-blocks/src/configuration/normalizeOptions.ts renamed to packages/css-blocks/src/configuration/resolver.ts packages/css-blocks/src/configuration/normalizeOptions.ts renamed to packages/css-blocks/src/configuration/resolver.ts

@@ -16,11 +16,11 @@ import {
   ResolvedConfiguration,
 } from "./types";
 
-const CONFIG_OBJECT_KEYS: Array<ConfigurationObjectKeys> = [
+const OBJECT_KEYS: Array<ConfigurationObjectKeys> = [
   "importerData",
   "preprocessors",
 ];
-const CONFIG_SIMPLE_KEYS: Array<ConfigurationSimpleKeys> = [
+const SIMPLE_KEYS: Array<ConfigurationSimpleKeys> = [
   "outputMode",
   "importer",
   "rootDir",
@@ -36,31 +36,30 @@ const DEFAULTS: ResolvedConfiguration = {
   disablePreprocessChaining: false,
   maxConcurrentCompiles: 4,
 };
-
 /**
- * Provides read-only access to options values. Provides default values if none
- * passed.
+ * Provides read-only access to resolved configuration values.
+ * Provides default values for any unspecified configuration values.
  */
-class OptionsReader implements ResolvedConfiguration {
+class Resolver implements ResolvedConfiguration {
   private _opts: Configuration;
 
   constructor(options?: Options, defaults?: Options) {
-    this._opts = {...DEFAULTS};
+    this._opts = { ...DEFAULTS };
     this.setAll(defaults);
     this.setAll(options);
   }
   private setAll(opts: Options | undefined) {
     if (opts === undefined) return;
-    for (let k of CONFIG_SIMPLE_KEYS) {
+    for (let k of SIMPLE_KEYS) {
       let v = opts[k];
       if (v !== undefined) {
         this._opts[k] = v;
       }
     }
-    for (let k of CONFIG_OBJECT_KEYS) {
+    for (let k of OBJECT_KEYS) {
       let v = opts[k];
       if (v !== undefined) {
-        this._opts[k] = {...v};
+        this._opts[k] = { ...v };
       }
     }
   }
@@ -87,10 +86,14 @@ class OptionsReader implements ResolvedConfiguration {
   }
 }
 
-export function normalizeOptions(options: Options | undefined, defaults?: Options): ResolvedConfiguration {
-  if (options instanceof OptionsReader) {
+export function resolveConfiguration(
+  options: Options | undefined,
+  defaults?: Options,
+
+): ResolvedConfiguration {
+  if (options instanceof Resolver) {
     return options;
   } else {
-    return new OptionsReader(options, defaults);
+    return new Resolver(options, defaults);
   }
 }

packages/css-blocks/test/attribute-container-test.ts

@@ -7,8 +7,8 @@ import {
   BlockFactory,
 } from "../src/BlockParser";
 import {
-  normalizeOptions,
-} from "../src/configuration/normalizeOptions";
+  resolveConfiguration,
+} from "../src/configuration";
 import cssBlocks = require("../src/cssBlocks");
 import { AttrValue } from "../src/index";
 
@@ -39,7 +39,7 @@ export class AttributeContainerTest extends BEMProcessor {
     );
 
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
 
     return factory.getBlock(importer.identifier(null, filename, options)).then(block => {
@@ -70,7 +70,7 @@ export class AttributeContainerTest extends BEMProcessor {
     );
 
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
 
     return factory.getBlock(importer.identifier(null, filename, options)).then(block => {
@@ -112,7 +112,7 @@ export class AttributeContainerTest extends BEMProcessor {
     );
 
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
 
     return factory.getBlock(importer.identifier(null, filename, options)).then(block => {

packages/css-blocks/test/block-factory-test.ts

@@ -4,7 +4,7 @@ import * as postcss from "postcss";
 
 import cssBlocks, {
   BlockFactory,
-  normalizeOptions,
+  resolveConfiguration,
 } from "../src";
 
 import { BEMProcessor } from "./util/BEMProcessor";
@@ -41,7 +41,7 @@ export class BlockFactoryTests extends BEMProcessor {
        :scope { extends: base; color: red; }`,
     );
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
     let extendsBlockPromise = factory.getBlock(importer.identifier(null, extendsFilename, options));
     let baseBlockPromise = factory.getBlock(importer.identifier(null, baseFilename, options));
@@ -73,7 +73,7 @@ export class BlockFactoryTests extends BEMProcessor {
     `);
 
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
 
     let blockPromise1 = factory.getBlock(importer.identifier(null, blockFilename1, options));

packages/css-blocks/test/importing-test.ts

@@ -4,13 +4,11 @@ import { IHookCallbackContext } from "mocha";
 import * as path from "path";
 
 import { Syntax } from "../src/BlockParser";
-import {
-  normalizeOptions,
-} from "../src/configuration/normalizeOptions";
 import {
   Options,
+  resolveConfiguration,
   ResolvedConfiguration,
-} from "../src/configuration/types";
+} from "../src/configuration";
 import {
   filesystemImporter,
   Importer,
@@ -22,7 +20,7 @@ const FSI_FIXTURES = path.resolve(FIXTURES, "filesystemImporter");
 const ALIAS_FIXTURES = path.resolve(FIXTURES, "pathAliasImporter");
 
 function getOptions(options?: Options): ResolvedConfiguration {
-  return normalizeOptions(options, {rootDir: path.join(FSI_FIXTURES)});
+  return resolveConfiguration(options, {rootDir: path.join(FSI_FIXTURES)});
 }
 
 function testFSImporter(name: string, importer: Importer) {

packages/css-blocks/test/local-scope-test.ts

@@ -4,7 +4,7 @@ import * as postcss from "postcss";
 
 import {
   BlockFactory,
-  normalizeOptions,
+  resolveConfiguration,
 } from "../src";
 import cssBlocks = require("../src/cssBlocks");
 
@@ -36,7 +36,7 @@ export class LocalScopeLookupTest extends BEMProcessor {
     );
 
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
 
     return factory.getBlock(importer.identifier(null, filename, options)).then(block => {
@@ -72,7 +72,7 @@ export class LocalScopeLookupTest extends BEMProcessor {
     );
 
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
 
     return factory.getBlock(importer.identifier(null, filename, options)).then(refblock => {
@@ -113,7 +113,7 @@ export class LocalScopeLookupTest extends BEMProcessor {
     );
 
     let importer = imports.importer();
-    let options = normalizeOptions({importer});
+    let options = resolveConfiguration({importer});
     let factory = new BlockFactory(options, postcss);
 
     return factory.getBlock(importer.identifier(null, filename, options)).then(refblock => {