https://github.com/webpack/loader-runner

Runs (webpack) loaders
https://github.com/webpack/loader-runner

Last synced: 29 days ago
JSON representation

Runs (webpack) loaders

• Host: GitHub
• URL: https://github.com/webpack/loader-runner
• Owner: webpack
• License: mit
• Created: 2016-01-03T17:15:29.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T23:20:26.000Z (8 months ago)
• Last Synced: 2024-04-08T13:31:48.971Z (7 months ago)
• Language: JavaScript
• Size: 226 KB
• Stars: 294
• Watchers: 10
• Forks: 59
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - loader-runner

README

        
# loader-runner

``` js

import { runLoaders } from "loader-runner";

runLoaders({

	resource: "/abs/path/to/file.txt?query",

	// String: Absolute path to the resource (optionally including query string)

	loaders: ["/abs/path/to/loader.js?query"],

	// String[]: Absolute paths to the loaders (optionally including query string)

	// {loader, options}[]: Absolute paths to the loaders with options object

	context: { minimize: true },

	// Additional loader context which is used as base context

	processResource: (loaderContext, resourcePath, callback) => { ... },

	// Optional: A function to process the resource

	// Must have signature function(context, path, function(err, buffer))

	// By default readResource is used and the resource is added a fileDependency

	readResource: fs.readFile.bind(fs)

	// Optional: A function to read the resource

	// Only used when 'processResource' is not provided

	// Must have signature function(path, function(err, buffer))

	// By default fs.readFile is used

}, function(err, result) {

	// err: Error?

	// result.result: Buffer | String

	// The result

	// only available when no error occurred

	// result.resourceBuffer: Buffer

	// The raw resource as Buffer (useful for SourceMaps)

	// only available when no error occurred

	// result.cacheable: Bool

	// Is the result cacheable or do it require reexecution?

	// result.fileDependencies: String[]

	// An array of paths (existing files) on which the result depends on

	// result.missingDependencies: String[]

	// An array of paths (not existing files) on which the result depends on

	// result.contextDependencies: String[]

	// An array of paths (directories) on which the result depends on

})

```

More documentation following...