feat: Rename SparseOptions to Options.

BREAKING CHANGE:

Now that all the other options types are named after Configuration, we
can rename SparseOptions to just Options.

Author: chriseppstein

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

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

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

@@ -7,7 +7,7 @@ import { RawSourceMap } from "source-map";
 import { Block } from "../Block";
 import { FileIdentifier, ImportedFile, Importer } from "../importing";
 import { normalizeOptions } from "../normalizeOptions";
-import { ResolvedConfiguration, SparseOptions } from "../options";
+import { Options, ResolvedConfiguration } from "../options";
 import { PromiseQueue } from "../util/PromiseQueue";
 
 import { BlockParser, ParsedSource } from "./BlockParser";
@@ -46,7 +46,7 @@ export class BlockFactory {
   private paths: ObjectDictionary<string>;
   private preprocessQueue: PromiseQueue<PreprocessJob, ProcessedFile>;
 
-  constructor(options: SparseOptions, postcssImpl = postcss) {
+  constructor(options: Options, postcssImpl = postcss) {
     this.postcssImpl = postcssImpl;
     this.configuration = normalizeOptions(options);
     this.importer = this.configuration.importer;

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

@@ -4,7 +4,7 @@ import { Block } from "../Block";
 import * as errors from "../errors";
 import { FileIdentifier } from "../importing";
 import { normalizeOptions } from "../normalizeOptions";
-import { ResolvedConfiguration, SparseOptions } from "../options";
+import { Options, ResolvedConfiguration } from "../options";
 
 import { assertForeignGlobalAttribute } from "./features/assert-foreign-global-attribute";
 import { constructBlock } from "./features/construct-block";
@@ -35,7 +35,7 @@ export class BlockParser {
   private config: ResolvedConfiguration;
   private factory: BlockFactory;
 
-  constructor(opts: SparseOptions, factory: BlockFactory) {
+  constructor(opts: Options, factory: BlockFactory) {
     this.config = normalizeOptions(opts);
     this.factory = factory;
   }

packages/css-blocks/src/Plugin.ts

@@ -4,8 +4,8 @@ import { BlockCompiler } from "./BlockCompiler";
 import { BlockFactory } from "./BlockParser";
 import * as errors from "./errors";
 import { normalizeOptions } from "./normalizeOptions";
-import { ResolvedConfiguration, SparseOptions } from "./options";
-export { SparseOptions } from "./options";
+import { Options, ResolvedConfiguration } from "./options";
+export { Options } from "./options";
 
 /**
  * CSS Blocks PostCSS plugin.
@@ -18,7 +18,7 @@ export class Plugin {
    * @param  postcssImpl  PostCSS instance to use
    * @param  opts  Optional plugin config options
    */
-  constructor(postcssImpl: typeof postcss, opts?: SparseOptions) {
+  constructor(postcssImpl: typeof postcss, opts?: Options) {
     this.config = normalizeOptions(opts);
     this.postcss = postcssImpl;
   }

packages/css-blocks/src/normalizeOptions.ts

@@ -1,6 +1,6 @@
 import {
+  Options,
   ResolvedConfiguration,
-  SparseOptions,
 } from "./options";
 
 import { OutputMode } from "./OutputMode";
@@ -30,7 +30,7 @@ const DEFAULTS: ResolvedConfiguration = {
 class OptionsReader implements ResolvedConfiguration {
   private _opts: ResolvedConfiguration;
 
-  constructor(options: SparseOptions = {}, defaults: SparseOptions = {}) {
+  constructor(options: Options = {}, defaults: Options = {}) {
     this._opts = {...DEFAULTS};
     for (let k of Object.keys(defaults)) {
       if (defaults[k] !== undefined) {
@@ -66,7 +66,7 @@ class OptionsReader implements ResolvedConfiguration {
   }
 }
 
-export function normalizeOptions(options: SparseOptions | undefined, defaults?: SparseOptions): ResolvedConfiguration {
+export function normalizeOptions(options: Options | undefined, defaults?: Options): ResolvedConfiguration {
   if (options instanceof OptionsReader) {
     return options;
   } else {

packages/css-blocks/src/options.ts

@@ -27,7 +27,7 @@ export interface Configuration {
 /**
  * Valid user-provided options for the CSS Blocks plugin.
  */
-export type SparseOptions = Partial<Readonly<Configuration>>;
+export type Options = Partial<Readonly<Configuration>>;
 
 /**
  * Options that can/will be read but not changed. Default

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

@@ -13,15 +13,15 @@ import {
   normalizeOptions,
 } from "../src/normalizeOptions";
 import {
+  Options,
   ResolvedConfiguration,
-  SparseOptions,
 } from "../src/options";
 
 const FIXTURES = path.resolve(__dirname, "..", "..", "test", "fixtures");
 const FSI_FIXTURES = path.resolve(FIXTURES, "filesystemImporter");
 const ALIAS_FIXTURES = path.resolve(FIXTURES, "pathAliasImporter");
 
-function getOptions(options?: SparseOptions): ResolvedConfiguration {
+function getOptions(options?: Options): ResolvedConfiguration {
   return normalizeOptions(options, {rootDir: path.join(FSI_FIXTURES)});
 }
 

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

@@ -21,15 +21,15 @@ import { TemplateAnalysis } from "../src/TemplateAnalysis";
 import { ElementAnalysis } from "../src/TemplateAnalysis/ElementAnalysis";
 import { StyleMapping } from "../src/TemplateRewriter/StyleMapping";
 import { normalizeOptions } from "../src/normalizeOptions";
-import { SparseOptions } from "../src/options";
+import { Options } from "../src/options";
 
 type BlockAndRoot = [Block, postcss.Container];
 
 type Analysis = TemplateAnalysis<"Opticss.Template">;
 
 @suite("Optimization")
 export class TemplateAnalysisTests {
-  private parseBlock(css: string, filename: string, opts?: SparseOptions, blockName = "optimized"): Promise<BlockAndRoot> {
+  private parseBlock(css: string, filename: string, opts?: Options, blockName = "optimized"): Promise<BlockAndRoot> {
     let options = normalizeOptions(opts);
     let factory = new BlockFactory(options, postcss);
     let root = postcss.parse(css, {from: filename});

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

@@ -5,14 +5,14 @@ import * as postcss from "postcss";
 import { Block } from "../src/Block";
 import { BlockFactory } from "../src/BlockParser";
 import { normalizeOptions } from "../src/normalizeOptions";
-import { SparseOptions } from "../src/options";
+import { Options } from "../src/options";
 import { QueryKeySelector } from "../src/query";
 
 type BlockAndRoot = [Block, postcss.Container];
 
 @suite("Querying")
 export class KeyQueryTests {
-  private parseBlock(css: string, filename: string, opts?: SparseOptions): Promise<BlockAndRoot> {
+  private parseBlock(css: string, filename: string, opts?: Options): Promise<BlockAndRoot> {
     let options = normalizeOptions(opts);
     let factory = new BlockFactory(options, postcss);
     let root = postcss.parse(css, {from: filename});

packages/css-blocks/test/template-analysis-test.ts

@@ -9,7 +9,7 @@ import { BlockFactory } from "../src/BlockParser";
 import { ElementAnalysis, SerializedTemplateAnalysis, TemplateAnalysis } from "../src/TemplateAnalysis";
 import * as cssBlocks from "../src/errors";
 import { normalizeOptions } from "../src/normalizeOptions";
-import { SparseOptions } from "../src/options";
+import { Options } from "../src/options";
 
 import { MockImportRegistry } from "./util/MockImportRegistry";
 import { assertParseError } from "./util/assertError";
@@ -20,7 +20,7 @@ type BlockAndRoot = [Block, postcss.Container];
 
 @suite("Template Analysis")
 export class TemplateAnalysisTests {
-  private parseBlock(css: string, filename: string, opts?: SparseOptions, blockName = "analysis"): Promise<BlockAndRoot> {
+  private parseBlock(css: string, filename: string, opts?: Options, blockName = "analysis"): Promise<BlockAndRoot> {
     let options = normalizeOptions(opts);
     let factory = new BlockFactory(options, postcss);
     let root = postcss.parse(css, {from: filename});

packages/css-blocks/test/util/BEMProcessor.ts

@@ -2,10 +2,10 @@ import * as perfectionist from "perfectionist";
 import * as postcss from "postcss";
 
 import cssBlocks = require("../../src/cssBlocks");
-import { SparseOptions } from "../../src/options";
+import { Options } from "../../src/options";
 
 export class BEMProcessor {
-  process(filename: string, contents: string, cssBlocksOpts?: SparseOptions) {
+  process(filename: string, contents: string, cssBlocksOpts?: Options) {
     let processOpts = { from: filename };
     let cssBlocksProcessor = cssBlocks(postcss);
     return postcss([

packages/css-blocks/test/validations/attribute-group-validator-test.ts

@@ -8,7 +8,7 @@ import { BlockFactory } from "../../src/BlockParser";
 import { TemplateAnalysis } from "../../src/TemplateAnalysis";
 import * as cssBlocks from "../../src/errors";
 import { normalizeOptions } from "../../src/normalizeOptions";
-import { SparseOptions } from "../../src/options";
+import { Options } from "../../src/options";
 
 import { MockImportRegistry } from "./../util/MockImportRegistry";
 import { assertParseError } from "./../util/assertError";
@@ -17,7 +17,7 @@ type BlockAndRoot = [Block, postcss.Container];
 
 @suite("Attribute Group Validator")
 export class TemplateAnalysisTests {
-  private parseBlock(css: string, filename: string, opts?: SparseOptions, blockName = "analysis"): Promise<BlockAndRoot> {
+  private parseBlock(css: string, filename: string, opts?: Options, blockName = "analysis"): Promise<BlockAndRoot> {
     let options = normalizeOptions(opts);
     let factory = new BlockFactory(options, postcss);
     let root = postcss.parse(css, { from: filename });

packages/css-blocks/test/validations/attribute-parent-validator-test.ts

@@ -8,7 +8,7 @@ import { BlockFactory } from "../../src/BlockParser";
 import { TemplateAnalysis } from "../../src/TemplateAnalysis";
 import * as cssBlocks from "../../src/errors";
 import { normalizeOptions } from "../../src/normalizeOptions";
-import { SparseOptions } from "../../src/options";
+import { Options } from "../../src/options";
 
 import { MockImportRegistry } from "./../util/MockImportRegistry";
 import { assertParseError } from "./../util/assertError";
@@ -17,7 +17,7 @@ type BlockAndRoot = [Block, postcss.Container];
 
 @suite("State Parent Validator")
 export class TemplateAnalysisTests {
-  private parseBlock(css: string, filename: string, opts?: SparseOptions, blockName = "analysis"): Promise<BlockAndRoot> {
+  private parseBlock(css: string, filename: string, opts?: Options, blockName = "analysis"): Promise<BlockAndRoot> {
     let options = normalizeOptions(opts);
     let factory = new BlockFactory(options, postcss);
     let root = postcss.parse(css, { from: filename });

packages/css-blocks/test/validations/class-pairs-validator-test.ts

@@ -7,14 +7,14 @@ import { BlockFactory } from "../../src/BlockParser";
 import { TemplateAnalysis } from "../../src/TemplateAnalysis";
 import * as cssBlocks from "../../src/errors";
 import { normalizeOptions } from "../../src/normalizeOptions";
-import { SparseOptions } from "../../src/options";
+import { Options } from "../../src/options";
 import { assertParseError } from "../util/assertError";
 
 type BlockAndRoot = [Block, postcss.Container];
 
 @suite("Class Pairs Validator")
 export class TemplateAnalysisTests {
-  private parseBlock(css: string, filename: string, opts?: SparseOptions, blockName = "analysis"): Promise<BlockAndRoot> {
+  private parseBlock(css: string, filename: string, opts?: Options, blockName = "analysis"): Promise<BlockAndRoot> {
     let options = normalizeOptions(opts);
     let factory = new BlockFactory(options, postcss);
     let root = postcss.parse(css, { from: filename });