refactor(plugin): update LoaderPlugin interface

Author: Wenjie Xia

plugins/sass.ts

@@ -3,10 +3,9 @@ import type { LoaderPlugin } from '../types.ts'
 
 const pluginFactory = (opts: Options = {}): LoaderPlugin => ({
     type: 'loader',
-    loader: 'css',
     test: /.(sass|scss)$/,
     acceptHMR: true,
-    precompile(content: Uint8Array, path: string) {
+    transform(content: Uint8Array, path: string) {
         const ret = renderSync({
             indentedSyntax: path.endsWith('.sass'),
             ...opts,
@@ -17,15 +16,15 @@ const pluginFactory = (opts: Options = {}): LoaderPlugin => ({
         return {
             code: (new TextDecoder).decode(ret.css),
             map: ret.map ? (new TextDecoder).decode(ret.map) : undefined,
+            format: 'css',
         }
     }
 })
 
 // make the `pluginFactory` function as a plugin
 const defaultPlugin = pluginFactory()
-pluginFactory.loader = defaultPlugin.loader
 pluginFactory.test = defaultPlugin.test
 pluginFactory.acceptHMR = defaultPlugin.acceptHMR
-pluginFactory.precompile = defaultPlugin.precompile
+pluginFactory.transform = defaultPlugin.transform
 
 export default pluginFactory

plugins/sass_test.ts

@@ -2,26 +2,27 @@ import { assertEquals } from 'https://deno.land/[email protected]/testing/asserts.ts'
 import plugin from './sass.ts'
 
 Deno.test('project scss loader plugin', async () => {
-    const { code } = await plugin.precompile!(
+    const { code, format } = await plugin.transform(
         (new TextEncoder).encode('$someVar: 123px; .some-selector { width: $someVar; }'),
         'test.scss'
     )
     assertEquals(plugin.test.test('test.sass'), true)
     assertEquals(plugin.test.test('test.scss'), true)
-    assertEquals(plugin.loader, 'css')
     assertEquals(plugin.acceptHMR, true)
     assertEquals(code, '.some-selector {\n  width: 123px;\n}')
+    assertEquals(format, 'css')
 })
 
 Deno.test('project sass loader plugin', async () => {
-    let ret = await plugin.precompile!(
+    let ret = await plugin.transform(
         (new TextEncoder).encode('$someVar: 123px\n.some-selector\n  width: 123px'),
         'test.sass'
     )
     assertEquals(ret.code, '.some-selector {\n  width: 123px;\n}')
-    ret = await plugin({ indentType: 'tab', indentWidth: 2 }).precompile!(
+    ret = await plugin({ indentType: 'tab', indentWidth: 2 }).transform(
         (new TextEncoder).encode('$someVar: 123px\n.some-selector\n  width: 123px'),
         'test.sass'
     )
     assertEquals(ret.code, '.some-selector {\n\t\twidth: 123px;\n}')
+    assertEquals(ret.format, 'css')
 })

plugins/wasm.ts

@@ -2,15 +2,15 @@ import type { LoaderPlugin } from '../types.ts'
 
 const wasmLoader: LoaderPlugin = {
     type: 'loader',
-    loader: 'js',
     test: /.wasm$/,
-    precompile: (content: Uint8Array, path: string) => ({
+    transform: (content: Uint8Array, path: string) => ({
         code: `
             const wasmBytes = new Uint8Array([${content.join(',')}])
             const wasmModule = new WebAssembly.Module(wasmBytes)
             const { exports } = new WebAssembly.Instance(wasmModule)
             export default exports
         `,
+        format: 'js'
     })
 }
 

plugins/wasm_test.ts

@@ -10,11 +10,11 @@ Deno.test('project wasm loader plugin', async () => {
         105, 110, 0, 0, 10, 138, 128, 128, 128, 0, 1, 132, 128, 128, 128, 0, 0,
         65, 42, 11
     ])
-    const { code } = await plugin.precompile!(wasmBytes, '42.wasm')
+    const { code, format } = await plugin.transform!(wasmBytes, '42.wasm')
     const jsfile = (await Deno.makeTempFile()) + '.js'
     await Deno.writeTextFile(jsfile, code)
     const { default: wasm } = await import('file://' + jsfile)
     assertEquals(plugin.test.test('test.wasm'), true)
-    assertEquals(plugin.loader, 'js')
+    assertEquals(format, 'js')
     assertEquals(wasm.main(), 42)
 })

types.ts

@@ -6,6 +6,7 @@ import type { AcceptedPlugin, bufio } from './deps.ts'
 export type TransformResult = {
     code: string,
     map?: string,
+    format?: 'js' | 'ts' | 'jsx' | 'tsx' | 'css',
 }
 
 /**
@@ -14,14 +15,12 @@ export type TransformResult = {
 export type LoaderPlugin = {
     /** `type` specifies the plugin type. */
     type: 'loader'
-    /** `loader` specifies the loader. */
-    loader: 'js' | 'ts' | 'jsx' | 'tsx' | 'css'
     /** `test` matches the import url. */
     test: RegExp
     /** `acceptHMR` enables the HMR. */
     acceptHMR?: boolean
     /** `transform` transforms the source content. */
-    precompile?(content: Uint8Array, url: string): TransformResult | Promise<TransformResult>
+    transform(content: Uint8Array, url: string): TransformResult | Promise<TransformResult>
 }
 
 /**