fix: transform function types

bennypowers · Oct 21, 2021 · d4ff2ca · d4ff2ca
1 parent ffa5e22
commit d4ff2ca
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/.changeset/eighty-ducks-live.md b/.changeset/eighty-ducks-live.md
@@ -0,0 +1,5 @@
+---
+"@pwrs/lit-css": patch
+---
+
+Fixed the `transform` function signature's types.
diff --git a/packages/lit-css-loader/lit-css-loader.ts b/packages/lit-css-loader/lit-css-loader.ts
@@ -6,7 +6,7 @@ export type LitCSSOptions = Omit<Options, 'css'>;
 
 type Context = LoaderContext<LitCSSOptions>;
 
-const loader: LoaderDefinitionFunction = function loader(this: Context, css, map, meta): void {
+const loader: LoaderDefinitionFunction = function loader(this: Context, css): void {
   const callback = this.async();
   const filePath = this.resourcePath;
   const options = this.getOptions();

diff --git a/packages/lit-css/lit-css.ts b/packages/lit-css/lit-css.ts
@@ -2,6 +2,19 @@ import stringToTemplateLiteral from 'string-to-template-literal';
 
 import { processString, UglifyCSSOptions } from 'uglifycss';
 
+export interface Meta {
+  /**
+   * Path to the source file being transformed
+   * Typically passed to transform functions e.g.
+   * @example
+   * ```js
+   * (data, { filePath }) =>
+   *   Sass.renderSync(data, { file: filePath }).css.toString()
+   * ```
+   */
+  filePath: string;
+}
+
 export interface Options {
   /** CSS to transform */
   css: string;
@@ -28,7 +41,7 @@ export interface Options {
    * @param  meta           Source file absolute (i.e. resolved) path
    * @return                Transformed, standard CSS
    */
-  transform?(source: string, meta?: { filePath: string }): string|Promise<string>;
+  transform?(source: string, meta: Meta): string|Promise<string>;
 }
 
 export async function transform({