draft: refactor project so it sits on top of a standalone app
This commit is contained in:
+106
@@ -0,0 +1,106 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
||||
|
||||
### [3.7.2](https://github.com/webpack/webpack-dev-middleware/compare/v3.7.1...v3.7.2) (2019-09-28)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* compatibility with webpack@5 ([#473](https://github.com/webpack/webpack-dev-middleware/issues/473)) ([63da9ae](https://github.com/webpack/webpack-dev-middleware/commit/63da9ae))
|
||||
* memory leak when `writeToDisk` used ([#472](https://github.com/webpack/webpack-dev-middleware/issues/472)) ([6730076](https://github.com/webpack/webpack-dev-middleware/commit/6730076))
|
||||
|
||||
### [3.7.1](https://github.com/webpack/webpack-dev-middleware/compare/v3.7.0...v3.7.1) (2019-09-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* directly used mkdirp instead of through Webpack ([#436](https://github.com/webpack/webpack-dev-middleware/issues/436)) ([dff39a1](https://github.com/webpack/webpack-dev-middleware/commit/dff39a1))
|
||||
* displayStats only logged ([#427](https://github.com/webpack/webpack-dev-middleware/issues/427)) ([98deaf4](https://github.com/webpack/webpack-dev-middleware/commit/98deaf4))
|
||||
* the `writeToFile` option has compatibility with webpack@5 ([#459](https://github.com/webpack/webpack-dev-middleware/issues/459)) ([5c90e1e](https://github.com/webpack/webpack-dev-middleware/commit/5c90e1e))
|
||||
|
||||
## [3.7.0](https://github.com/webpack/webpack-dev-middleware/compare/v3.6.2...v3.7.0) (2019-05-15)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* support `HEAD` method by default ([#398](https://github.com/webpack/webpack-dev-middleware/issues/398)) ([ec3d5eb](https://github.com/webpack/webpack-dev-middleware/commit/ec3d5eb))
|
||||
|
||||
|
||||
|
||||
<a name="3.6.2"></a>
|
||||
## [3.6.2](https://github.com/webpack/webpack-dev-middleware/compare/v3.6.1...v3.6.2) (2019-04-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* check existence of `res.getHeader` and set the correct Content-Type ([#385](https://github.com/webpack/webpack-dev-middleware/issues/385)) ([56dc705](https://github.com/webpack/webpack-dev-middleware/commit/56dc705))
|
||||
|
||||
|
||||
|
||||
## [3.6.1](https://github.com/webpack/webpack-dev-middleware/compare/v3.6.0...v3.6.1) (2019-03-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* do not overwrite Content-Type if header already exists ([#377](https://github.com/webpack/webpack-dev-middleware/issues/377)) ([b2a6fed](https://github.com/webpack/webpack-dev-middleware/commit/b2a6fed))
|
||||
|
||||
|
||||
|
||||
<a name="3.5.2"></a>
|
||||
## [3.5.2](https://github.com/webpack/webpack-dev-middleware/compare/v3.5.1...v3.5.2) (2019-02-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* don't add charset to `usdz` file type ([#357](https://github.com/webpack/webpack-dev-middleware/issues/357)) ([b135b3d](https://github.com/webpack/webpack-dev-middleware/commit/b135b3d))
|
||||
|
||||
|
||||
|
||||
<a name="3.5.1"></a>
|
||||
## [3.5.1](https://github.com/webpack/webpack-dev-middleware/compare/v3.5.0...v3.5.1) (2019-01-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove querystring from filenames when writing to disk ([#361](https://github.com/webpack/webpack-dev-middleware/issues/361)) ([90d0d94](https://github.com/webpack/webpack-dev-middleware/commit/90d0d94))
|
||||
|
||||
|
||||
|
||||
<a name="3.5.0"></a>
|
||||
# [3.5.0](https://github.com/webpack/webpack-dev-middleware/compare/v3.4.0...v3.5.0) (2019-01-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **middleware:** do not add 'null' to Content-Type ([#355](https://github.com/webpack/webpack-dev-middleware/issues/355)) ([cf4d7a9](https://github.com/webpack/webpack-dev-middleware/commit/cf4d7a9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* allow to redefine `mimeTypes` (possible to use `force` option) ([#349](https://github.com/webpack/webpack-dev-middleware/issues/349)) ([e56a181](https://github.com/webpack/webpack-dev-middleware/commit/e56a181))
|
||||
|
||||
|
||||
|
||||
<a name="3.3.0"></a>
|
||||
# [3.3.0](https://github.com/webpack/webpack-dev-middleware/compare/v3.2.0...v3.3.0) (2018-09-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **middleware:** expose the memory filesystem (`response.locals.fs`) ([#337](https://github.com/webpack/webpack-dev-middleware/issues/337)) ([f9a138e](https://github.com/webpack/webpack-dev-middleware/commit/f9a138e))
|
||||
|
||||
|
||||
|
||||
<a name="3.2.0"></a>
|
||||
# [3.2.0](https://github.com/webpack/webpack-dev-middleware/compare/v3.1.3...v3.2.0) (2018-08-23)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **package:** 18 security vulnerabilities ([#329](https://github.com/webpack/webpack-dev-middleware/issues/329)) ([5951de9](https://github.com/webpack/webpack-dev-middleware/commit/5951de9))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **middleware:** add `methods` option (`options.methods`) ([#319](https://github.com/webpack/webpack-dev-middleware/issues/319)) ([fe6bb86](https://github.com/webpack/webpack-dev-middleware/commit/fe6bb86))
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
Copyright JS Foundation and other contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
'Software'), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
+451
@@ -0,0 +1,451 @@
|
||||
<div align="center">
|
||||
<a href="https://github.com/webpack/webpack">
|
||||
<img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg">
|
||||
</a>
|
||||
</div>
|
||||
|
||||
[![npm][npm]][npm-url]
|
||||
[![node][node]][node-url]
|
||||
[![deps][deps]][deps-url]
|
||||
[![tests][tests]][tests-url]
|
||||
[![coverage][cover]][cover-url]
|
||||
[![chat][chat]][chat-url]
|
||||
[![size][size]][size-url]
|
||||
|
||||
# webpack-dev-middleware
|
||||
|
||||
An express-style development middleware for use with [webpack](https://webpack.js.org)
|
||||
bundles and allows for serving of the files emitted from webpack.
|
||||
This should be used for **development only**.
|
||||
|
||||
Some of the benefits of using this middleware include:
|
||||
|
||||
- No files are written to disk, rather it handles files in memory
|
||||
- If files changed in watch mode, the middleware delays requests until compiling
|
||||
has completed.
|
||||
- Supports hot module reload (HMR).
|
||||
|
||||
## Requirements
|
||||
|
||||
This module requires a minimum of Node v6.9.0 and Webpack v4.0.0, and must be used with a
|
||||
server that accepts express-style middleware.
|
||||
|
||||
## Getting Started
|
||||
|
||||
First thing's first, install the module:
|
||||
|
||||
```console
|
||||
npm install webpack-dev-middleware --save-dev
|
||||
```
|
||||
|
||||
_Note: We do not recommend installing this module globally._
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const webpack = require('webpack');
|
||||
const middleware = require('webpack-dev-middleware');
|
||||
const compiler = webpack({
|
||||
// webpack options
|
||||
});
|
||||
const express = require('express');
|
||||
const app = express();
|
||||
|
||||
app.use(
|
||||
middleware(compiler, {
|
||||
// webpack-dev-middleware options
|
||||
})
|
||||
);
|
||||
|
||||
app.listen(3000, () => console.log('Example app listening on port 3000!'));
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
The middleware accepts an `options` Object. The following is a property reference
|
||||
for the Object.
|
||||
|
||||
_Note: The `publicPath` property is required, whereas all other options are optional_
|
||||
|
||||
### methods
|
||||
|
||||
Type: `Array`
|
||||
Default: `[ 'GET', 'HEAD' ]`
|
||||
|
||||
This property allows a user to pass the list of HTTP request methods accepted by the server.
|
||||
|
||||
### headers
|
||||
|
||||
Type: `Object`
|
||||
Default: `undefined`
|
||||
|
||||
This property allows a user to pass custom HTTP headers on each request. eg.
|
||||
`{ "X-Custom-Header": "yes" }`
|
||||
|
||||
### index
|
||||
|
||||
Type: `String`
|
||||
Default: `undefined`
|
||||
|
||||
"index.html",
|
||||
// The index path for web server, defaults to "index.html".
|
||||
// If falsy (but not undefined), the server will not respond to requests to the root URL.
|
||||
|
||||
### lazy
|
||||
|
||||
Type: `Boolean`
|
||||
Default: `undefined`
|
||||
|
||||
This option instructs the module to operate in 'lazy' mode, meaning that it won't
|
||||
recompile when files change, but rather on each request.
|
||||
|
||||
### logger
|
||||
|
||||
Type: `Object`
|
||||
Default: [`webpack-log`](https://github.com/webpack-contrib/webpack-log/blob/master/index.js)
|
||||
|
||||
In the rare event that a user would like to provide a custom logging interface,
|
||||
this property allows the user to assign one. The module leverages
|
||||
[`webpack-log`](https://github.com/webpack-contrib/webpack-log#readme)
|
||||
for creating the [`loglevelnext`](https://github.com/shellscape/loglevelnext#readme)
|
||||
logging management by default. Any custom logger must adhere to the same
|
||||
exports for compatibility. Specifically, all custom loggers must have the
|
||||
following exported methods at a minimum:
|
||||
|
||||
- `log.trace`
|
||||
- `log.debug`
|
||||
- `log.info`
|
||||
- `log.warn`
|
||||
- `log.error`
|
||||
|
||||
Please see the documentation for `loglevel` for more information.
|
||||
|
||||
### logLevel
|
||||
|
||||
Type: `String`
|
||||
Default: `'info'`
|
||||
|
||||
This property defines the level of messages that the module will log. Valid levels
|
||||
include:
|
||||
|
||||
- `trace`
|
||||
- `debug`
|
||||
- `info`
|
||||
- `warn`
|
||||
- `error`
|
||||
- `silent`
|
||||
|
||||
Setting a log level means that all other levels below it will be visible in the
|
||||
console. Setting `logLevel: 'silent'` will hide all console output. The module
|
||||
leverages [`webpack-log`](https://github.com/webpack-contrib/webpack-log#readme)
|
||||
for logging management, and more information can be found on its page.
|
||||
|
||||
### logTime
|
||||
|
||||
Type: `Boolean`
|
||||
Default: `false`
|
||||
|
||||
If `true` the log output of the module will be prefixed by a timestamp in the
|
||||
`HH:mm:ss` format.
|
||||
|
||||
### mimeTypes
|
||||
|
||||
Type: `Object`
|
||||
Default: `null`
|
||||
|
||||
This property allows a user to register custom mime types or extension mappings.
|
||||
eg. `mimeTypes: { 'text/html': [ 'phtml' ] }`.
|
||||
|
||||
By default node-mime will throw an error if you try to map a type to an extension
|
||||
that is already assigned to another type. Passing `force: true` will suppress this behavior
|
||||
(overriding any previous mapping).
|
||||
eg. `mimeTypes: { typeMap: { 'text/html': [ 'phtml' ] } }, force: true }`.
|
||||
|
||||
Please see the documentation for
|
||||
[`node-mime`](https://github.com/broofa/node-mime#mimedefinetypemap-force--false) for more information.
|
||||
|
||||
### publicPath
|
||||
|
||||
Type: `String`
|
||||
_Required_
|
||||
|
||||
The public path that the middleware is bound to. _Best Practice: use the same
|
||||
`publicPath` defined in your webpack config. For more information about
|
||||
`publicPath`, please see
|
||||
[the webpack documentation](https://webpack.js.org/guides/public-path)._
|
||||
|
||||
### reporter
|
||||
|
||||
Type: `Object`
|
||||
Default: `undefined`
|
||||
|
||||
Allows users to provide a custom reporter to handle logging within the module.
|
||||
Please see the [default reporter](/lib/reporter.js)
|
||||
for an example.
|
||||
|
||||
### serverSideRender
|
||||
|
||||
Type: `Boolean`
|
||||
Default: `undefined`
|
||||
|
||||
Instructs the module to enable or disable the server-side rendering mode. Please
|
||||
see [Server-Side Rendering](#server-side-rendering) for more information.
|
||||
|
||||
### stats
|
||||
|
||||
Type: `Object`
|
||||
Default: `{ context: process.cwd() }`
|
||||
|
||||
Options for formatting statistics displayed during and after compile. For more
|
||||
information and property details, please see the
|
||||
[webpack documentation](https://webpack.js.org/configuration/stats/#stats).
|
||||
|
||||
### watchOptions
|
||||
|
||||
Type: `Object`
|
||||
Default: `{ aggregateTimeout: 200 }`
|
||||
|
||||
The module accepts an `Object` containing options for file watching, which is
|
||||
passed directly to the compiler provided. For more information on watch options
|
||||
please see the [webpack documentation](https://webpack.js.org/configuration/watch/#watchoptions)
|
||||
|
||||
### writeToDisk
|
||||
|
||||
Type: `Boolean|Function`
|
||||
Default: `false`
|
||||
|
||||
If `true`, the option will instruct the module to write files to the configured
|
||||
location on disk as specified in your `webpack` config file. _Setting
|
||||
`writeToDisk: true` won't change the behavior of the `webpack-dev-middleware`,
|
||||
and bundle files accessed through the browser will still be served from memory._
|
||||
This option provides the same capabilities as the
|
||||
[`WriteFilePlugin`](https://github.com/gajus/write-file-webpack-plugin/pulls).
|
||||
|
||||
This option also accepts a `Function` value, which can be used to filter which
|
||||
files are written to disk. The function follows the same premise as
|
||||
[`Array#filter`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter)
|
||||
in which a return value of `false` _will not_ write the file, and a return value
|
||||
of `true` _will_ write the file to disk. eg.
|
||||
|
||||
```js
|
||||
{
|
||||
writeToDisk: (filePath) => {
|
||||
return /superman\.css$/.test(filePath);
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### fs
|
||||
|
||||
Type: `Object`
|
||||
Default: `MemoryFileSystem`
|
||||
|
||||
Set the default file system which will be used by webpack as primary destination of generated files. Default is set to webpack's default file system: [memory-fs](https://github.com/webpack/memory-fs). This option isn't affected by the [writeToDisk](#writeToDisk) option.
|
||||
|
||||
**Note:** As of 3.5.x version of the middleware you have to provide `.join()` method to the `fs` instance manually. This can be done simply by using `path.join`:
|
||||
|
||||
```js
|
||||
fs.join = path.join; // no need to bind
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
`webpack-dev-middleware` also provides convenience methods that can be use to
|
||||
interact with the middleware at runtime:
|
||||
|
||||
### `close(callback)`
|
||||
|
||||
Instructs a webpack-dev-middleware instance to stop watching for file changes.
|
||||
|
||||
### Parameters
|
||||
|
||||
#### callback
|
||||
|
||||
Type: `Function`
|
||||
|
||||
A function executed once the middleware has stopped watching.
|
||||
|
||||
### `invalidate()`
|
||||
|
||||
Instructs a webpack-dev-middleware instance to recompile the bundle.
|
||||
e.g. after a change to the configuration.
|
||||
|
||||
```js
|
||||
const webpack = require('webpack');
|
||||
const compiler = webpack({ ... });
|
||||
const middleware = require('webpack-dev-middleware');
|
||||
const instance = middleware(compiler);
|
||||
|
||||
app.use(instance);
|
||||
|
||||
setTimeout(() => {
|
||||
// After a short delay the configuration is changed and a banner plugin is added
|
||||
// to the config
|
||||
compiler.apply(new webpack.BannerPlugin('A new banner'));
|
||||
|
||||
// Recompile the bundle with the banner plugin:
|
||||
instance.invalidate();
|
||||
}, 1000);
|
||||
```
|
||||
|
||||
### `waitUntilValid(callback)`
|
||||
|
||||
Executes a callback function when the compiler bundle is valid, typically after
|
||||
compilation.
|
||||
|
||||
### Parameters
|
||||
|
||||
#### callback
|
||||
|
||||
Type: `Function`
|
||||
|
||||
A function executed when the bundle becomes valid. If the bundle is
|
||||
valid at the time of calling, the callback is executed immediately.
|
||||
|
||||
```js
|
||||
const webpack = require('webpack');
|
||||
const compiler = webpack({ ... });
|
||||
const middleware = require('webpack-dev-middleware');
|
||||
const instance = middleware(compiler);
|
||||
|
||||
app.use(instance);
|
||||
|
||||
instance.waitUntilValid(() => {
|
||||
console.log('Package is in a valid state');
|
||||
});
|
||||
```
|
||||
|
||||
## Known Issues
|
||||
|
||||
### Multiple Successive Builds
|
||||
|
||||
Watching (by means of `lazy: false`) will frequently cause multiple compilations
|
||||
as the bundle changes during compilation. This is due in part to cross-platform
|
||||
differences in file watchers, so that webpack doesn't loose file changes when
|
||||
watched files change rapidly. If you run into this situation, please make use of
|
||||
the [`TimeFixPlugin`](https://github.com/egoist/time-fix-plugin).
|
||||
|
||||
## Server-Side Rendering
|
||||
|
||||
_Note: this feature is experimental and may be removed or changed completely in the future._
|
||||
|
||||
In order to develop an app using server-side rendering, we need access to the
|
||||
[`stats`](https://github.com/webpack/docs/wiki/node.js-api#stats), which is
|
||||
generated with each build.
|
||||
|
||||
With server-side rendering enabled, `webpack-dev-middleware` sets the `stat` to
|
||||
`res.locals.webpackStats` and the memory filesystem to `res.locals.fs` before invoking the next middleware, allowing a
|
||||
developer to render the page body and manage the response to clients.
|
||||
|
||||
_Note: Requests for bundle files will still be handled by
|
||||
`webpack-dev-middleware` and all requests will be pending until the build
|
||||
process is finished with server-side rendering enabled._
|
||||
|
||||
Example Implementation:
|
||||
|
||||
```js
|
||||
const webpack = require('webpack');
|
||||
const compiler = webpack({
|
||||
// webpack options
|
||||
});
|
||||
const isObject = require('is-object');
|
||||
const middleware = require('webpack-dev-middleware');
|
||||
|
||||
// This function makes server rendering of asset references consistent with different webpack chunk/entry configurations
|
||||
function normalizeAssets(assets) {
|
||||
if (isObject(assets)) {
|
||||
return Object.values(assets);
|
||||
}
|
||||
|
||||
return Array.isArray(assets) ? assets : [assets];
|
||||
}
|
||||
|
||||
app.use(middleware(compiler, { serverSideRender: true }));
|
||||
|
||||
// The following middleware would not be invoked until the latest build is finished.
|
||||
app.use((req, res) => {
|
||||
const assetsByChunkName = res.locals.webpackStats.toJson().assetsByChunkName;
|
||||
const fs = res.locals.fs;
|
||||
const outputPath = res.locals.webpackStats.toJson().outputPath;
|
||||
|
||||
// then use `assetsByChunkName` for server-sider rendering
|
||||
// For example, if you have only one main chunk:
|
||||
res.send(`
|
||||
<html>
|
||||
<head>
|
||||
<title>My App</title>
|
||||
<style>
|
||||
${normalizeAssets(assetsByChunkName.main)
|
||||
.filter((path) => path.endsWith('.css'))
|
||||
.map((path) => fs.readFileSync(outputPath + '/' + path))
|
||||
.join('\n')}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div id="root"></div>
|
||||
${normalizeAssets(assetsByChunkName.main)
|
||||
.filter((path) => path.endsWith('.js'))
|
||||
.map((path) => `<script src="${path}"></script>`)
|
||||
.join('\n')}
|
||||
</body>
|
||||
</html>
|
||||
`);
|
||||
});
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
We do our best to keep Issues in the repository focused on bugs, features, and
|
||||
needed modifications to the code for the module. Because of that, we ask users
|
||||
with general support, "how-to", or "why isn't this working" questions to try one
|
||||
of the other support channels that are available.
|
||||
|
||||
Your first-stop-shop for support for webpack-dev-server should by the excellent
|
||||
[documentation][docs-url] for the module. If you see an opportunity for improvement
|
||||
of those docs, please head over to the [webpack.js.org repo][wjo-url] and open a
|
||||
pull request.
|
||||
|
||||
From there, we encourage users to visit the [webpack Gitter chat][chat-url] and
|
||||
talk to the fine folks there. If your quest for answers comes up dry in chat,
|
||||
head over to [StackOverflow][stack-url] and do a quick search or open a new
|
||||
question. Remember; It's always much easier to answer questions that include your
|
||||
`webpack.config.js` and relevant files!
|
||||
|
||||
If you're twitter-savvy you can tweet [#webpack][hash-url] with your question
|
||||
and someone should be able to reach out and lend a hand.
|
||||
|
||||
If you have discovered a :bug:, have a feature suggestion, or would like to see
|
||||
a modification, please feel free to create an issue on Github. _Note: The issue
|
||||
template isn't optional, so please be sure not to remove it, and please fill it
|
||||
out completely._
|
||||
|
||||
## Contributing
|
||||
|
||||
Please take a moment to read our contributing guidelines if you haven't yet done so.
|
||||
|
||||
[CONTRIBUTING](./.github/CONTRIBUTING.md)
|
||||
|
||||
## License
|
||||
|
||||
[MIT](./LICENSE)
|
||||
|
||||
[npm]: https://img.shields.io/npm/v/webpack-dev-middleware.svg
|
||||
[npm-url]: https://npmjs.com/package/webpack-dev-middleware
|
||||
[node]: https://img.shields.io/node/v/webpack-dev-middleware.svg
|
||||
[node-url]: https://nodejs.org
|
||||
[deps]: https://david-dm.org/webpack/webpack-dev-middleware.svg
|
||||
[deps-url]: https://david-dm.org/webpack/webpack-dev-middleware
|
||||
[tests]: https://dev.azure.com/webpack/webpack-dev-middleware/_apis/build/status/webpack.webpack-dev-middleware?branchName=master
|
||||
[tests-url]: https://dev.azure.com/webpack/webpack-dev-middleware/_build/latest?definitionId=8&branchName=master
|
||||
[cover]: https://codecov.io/gh/webpack/webpack-dev-middleware/branch/master/graph/badge.svg
|
||||
[cover-url]: https://codecov.io/gh/webpack/webpack-dev-middleware
|
||||
[chat]: https://badges.gitter.im/webpack/webpack.svg
|
||||
[chat-url]: https://gitter.im/webpack/webpack
|
||||
[size]: https://packagephobia.now.sh/badge?p=webpack-dev-middleware
|
||||
[size-url]: https://packagephobia.now.sh/result?p=webpack-dev-middleware
|
||||
[docs-url]: https://webpack.js.org/guides/development/#using-webpack-dev-middleware
|
||||
[hash-url]: https://twitter.com/search?q=webpack
|
||||
[middleware-url]: https://github.com/webpack/webpack-dev-middleware
|
||||
[stack-url]: https://stackoverflow.com/questions/tagged/webpack-dev-middleware
|
||||
[uglify-url]: https://github.com/webpack-contrib/uglifyjs-webpack-plugin
|
||||
[wjo-url]: https://github.com/webpack/webpack.js.org
|
||||
+108
@@ -0,0 +1,108 @@
|
||||
'use strict';
|
||||
|
||||
const mime = require('mime');
|
||||
|
||||
const createContext = require('./lib/context');
|
||||
const middleware = require('./lib/middleware');
|
||||
const reporter = require('./lib/reporter');
|
||||
const { setFs, toDisk } = require('./lib/fs');
|
||||
const { getFilenameFromUrl, noop, ready } = require('./lib/util');
|
||||
|
||||
const defaults = {
|
||||
logLevel: 'info',
|
||||
logTime: false,
|
||||
logger: null,
|
||||
mimeTypes: null,
|
||||
reporter,
|
||||
stats: {
|
||||
colors: true,
|
||||
context: process.cwd(),
|
||||
},
|
||||
watchOptions: {
|
||||
aggregateTimeout: 200,
|
||||
},
|
||||
writeToDisk: false,
|
||||
};
|
||||
|
||||
module.exports = function wdm(compiler, opts) {
|
||||
const options = Object.assign({}, defaults, opts);
|
||||
|
||||
// defining custom MIME type
|
||||
if (options.mimeTypes) {
|
||||
const typeMap = options.mimeTypes.typeMap || options.mimeTypes;
|
||||
const force = !!options.mimeTypes.force;
|
||||
mime.define(typeMap, force);
|
||||
}
|
||||
|
||||
const context = createContext(compiler, options);
|
||||
|
||||
// start watching
|
||||
if (!options.lazy) {
|
||||
context.watching = compiler.watch(options.watchOptions, (err) => {
|
||||
if (err) {
|
||||
context.log.error(err.stack || err);
|
||||
if (err.details) {
|
||||
context.log.error(err.details);
|
||||
}
|
||||
}
|
||||
});
|
||||
} else {
|
||||
if (typeof options.filename === 'string') {
|
||||
const filename = options.filename
|
||||
.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&') // eslint-disable-line no-useless-escape
|
||||
.replace(/\\\[[a-z]+\\\]/gi, '.+');
|
||||
|
||||
options.filename = new RegExp(`^[/]{0,1}${filename}$`);
|
||||
}
|
||||
|
||||
context.state = true;
|
||||
}
|
||||
|
||||
if (options.writeToDisk) {
|
||||
toDisk(context);
|
||||
}
|
||||
|
||||
setFs(context, compiler);
|
||||
|
||||
return Object.assign(middleware(context), {
|
||||
close(callback) {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
callback = callback || noop;
|
||||
|
||||
if (context.watching) {
|
||||
context.watching.close(callback);
|
||||
} else {
|
||||
callback();
|
||||
}
|
||||
},
|
||||
|
||||
context,
|
||||
|
||||
fileSystem: context.fs,
|
||||
|
||||
getFilenameFromUrl: getFilenameFromUrl.bind(
|
||||
this,
|
||||
context.options.publicPath,
|
||||
context.compiler
|
||||
),
|
||||
|
||||
invalidate(callback) {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
callback = callback || noop;
|
||||
|
||||
if (context.watching) {
|
||||
ready(context, callback, {});
|
||||
context.watching.invalidate();
|
||||
} else {
|
||||
callback();
|
||||
}
|
||||
},
|
||||
|
||||
waitUntilValid(callback) {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
callback = callback || noop;
|
||||
|
||||
ready(context, callback, {});
|
||||
},
|
||||
});
|
||||
};
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
'use strict';
|
||||
|
||||
module.exports = class DevMiddlewareError extends Error {};
|
||||
+106
@@ -0,0 +1,106 @@
|
||||
'use strict';
|
||||
|
||||
const weblog = require('webpack-log');
|
||||
|
||||
module.exports = function ctx(compiler, options) {
|
||||
const context = {
|
||||
state: false,
|
||||
webpackStats: null,
|
||||
callbacks: [],
|
||||
options,
|
||||
compiler,
|
||||
watching: null,
|
||||
forceRebuild: false,
|
||||
};
|
||||
|
||||
if (options.logger) {
|
||||
context.log = options.logger;
|
||||
} else {
|
||||
context.log = weblog({
|
||||
level: options.logLevel || 'info',
|
||||
name: 'wdm',
|
||||
timestamp: options.logTime,
|
||||
});
|
||||
}
|
||||
|
||||
const { log } = context;
|
||||
|
||||
function done(stats) {
|
||||
// We are now on valid state
|
||||
context.state = true;
|
||||
context.webpackStats = stats;
|
||||
|
||||
// Do the stuff in nextTick, because bundle may be invalidated
|
||||
// if a change happened while compiling
|
||||
process.nextTick(() => {
|
||||
// check if still in valid state
|
||||
if (!context.state) {
|
||||
return;
|
||||
}
|
||||
|
||||
// print webpack output
|
||||
context.options.reporter(context.options, {
|
||||
log,
|
||||
state: true,
|
||||
stats,
|
||||
});
|
||||
|
||||
// execute callback that are delayed
|
||||
const cbs = context.callbacks;
|
||||
context.callbacks = [];
|
||||
cbs.forEach((cb) => {
|
||||
cb(stats);
|
||||
});
|
||||
});
|
||||
|
||||
// In lazy mode, we may issue another rebuild
|
||||
if (context.forceRebuild) {
|
||||
context.forceRebuild = false;
|
||||
rebuild();
|
||||
}
|
||||
}
|
||||
|
||||
function invalid(callback) {
|
||||
if (context.state) {
|
||||
context.options.reporter(context.options, {
|
||||
log,
|
||||
state: false,
|
||||
});
|
||||
}
|
||||
|
||||
// We are now in invalid state
|
||||
context.state = false;
|
||||
if (typeof callback === 'function') {
|
||||
callback();
|
||||
}
|
||||
}
|
||||
|
||||
function rebuild() {
|
||||
if (context.state) {
|
||||
context.state = false;
|
||||
context.compiler.run((err) => {
|
||||
if (err) {
|
||||
log.error(err.stack || err);
|
||||
if (err.details) {
|
||||
log.error(err.details);
|
||||
}
|
||||
}
|
||||
});
|
||||
} else {
|
||||
context.forceRebuild = true;
|
||||
}
|
||||
}
|
||||
|
||||
context.rebuild = rebuild;
|
||||
context.compiler.hooks.invalid.tap('WebpackDevMiddleware', invalid);
|
||||
context.compiler.hooks.run.tap('WebpackDevMiddleware', invalid);
|
||||
context.compiler.hooks.done.tap('WebpackDevMiddleware', done);
|
||||
context.compiler.hooks.watchRun.tap(
|
||||
'WebpackDevMiddleware',
|
||||
(comp, callback) => {
|
||||
invalid(callback);
|
||||
}
|
||||
);
|
||||
|
||||
return context;
|
||||
};
|
||||
+140
@@ -0,0 +1,140 @@
|
||||
'use strict';
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
const MemoryFileSystem = require('memory-fs');
|
||||
const mkdirp = require('mkdirp');
|
||||
const { colors } = require('webpack-log');
|
||||
|
||||
const DevMiddlewareError = require('./DevMiddlewareError');
|
||||
|
||||
module.exports = {
|
||||
toDisk(context) {
|
||||
const compilers = context.compiler.compilers || [context.compiler];
|
||||
|
||||
for (const compiler of compilers) {
|
||||
compiler.hooks.emit.tap('WebpackDevMiddleware', (compilation) => {
|
||||
if (compiler.hasWebpackDevMiddlewareAssetEmittedCallback) {
|
||||
return;
|
||||
}
|
||||
|
||||
compiler.hooks.assetEmitted.tapAsync(
|
||||
'WebpackDevMiddleware',
|
||||
(file, info, callback) => {
|
||||
let targetPath = null;
|
||||
let content = null;
|
||||
|
||||
// webpack@5
|
||||
if (info.compilation) {
|
||||
({ targetPath, content } = info);
|
||||
} else {
|
||||
let targetFile = file;
|
||||
|
||||
const queryStringIdx = targetFile.indexOf('?');
|
||||
|
||||
if (queryStringIdx >= 0) {
|
||||
targetFile = targetFile.substr(0, queryStringIdx);
|
||||
}
|
||||
|
||||
let { outputPath } = compiler;
|
||||
|
||||
// TODO Why? Need remove in future major release
|
||||
if (outputPath === '/') {
|
||||
outputPath = compiler.context;
|
||||
}
|
||||
|
||||
outputPath = compilation.getPath(outputPath, {});
|
||||
content = info;
|
||||
targetPath = path.join(outputPath, targetFile);
|
||||
}
|
||||
|
||||
const { writeToDisk: filter } = context.options;
|
||||
const allowWrite =
|
||||
filter && typeof filter === 'function'
|
||||
? filter(targetPath)
|
||||
: true;
|
||||
|
||||
if (!allowWrite) {
|
||||
return callback();
|
||||
}
|
||||
|
||||
const { log } = context;
|
||||
const dir = path.dirname(targetPath);
|
||||
|
||||
return mkdirp(dir, (mkdirpError) => {
|
||||
if (mkdirpError) {
|
||||
return callback(mkdirpError);
|
||||
}
|
||||
|
||||
return fs.writeFile(targetPath, content, (writeFileError) => {
|
||||
if (writeFileError) {
|
||||
return callback(writeFileError);
|
||||
}
|
||||
|
||||
log.debug(
|
||||
colors.cyan(
|
||||
`Asset written to disk: ${path.relative(
|
||||
process.cwd(),
|
||||
targetPath
|
||||
)}`
|
||||
)
|
||||
);
|
||||
|
||||
return callback();
|
||||
});
|
||||
});
|
||||
}
|
||||
);
|
||||
compiler.hasWebpackDevMiddlewareAssetEmittedCallback = true;
|
||||
});
|
||||
}
|
||||
},
|
||||
|
||||
setFs(context, compiler) {
|
||||
if (
|
||||
typeof compiler.outputPath === 'string' &&
|
||||
!path.posix.isAbsolute(compiler.outputPath) &&
|
||||
!path.win32.isAbsolute(compiler.outputPath)
|
||||
) {
|
||||
throw new DevMiddlewareError(
|
||||
'`output.path` needs to be an absolute path or `/`.'
|
||||
);
|
||||
}
|
||||
|
||||
let fileSystem;
|
||||
|
||||
// store our files in memory
|
||||
const isConfiguredFs = context.options.fs;
|
||||
const isMemoryFs =
|
||||
!isConfiguredFs &&
|
||||
!compiler.compilers &&
|
||||
compiler.outputFileSystem instanceof MemoryFileSystem;
|
||||
|
||||
if (isConfiguredFs) {
|
||||
// eslint-disable-next-line no-shadow
|
||||
const { fs } = context.options;
|
||||
|
||||
if (typeof fs.join !== 'function') {
|
||||
// very shallow check
|
||||
throw new Error(
|
||||
'Invalid options: options.fs.join() method is expected'
|
||||
);
|
||||
}
|
||||
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
compiler.outputFileSystem = fs;
|
||||
fileSystem = fs;
|
||||
} else if (isMemoryFs) {
|
||||
fileSystem = compiler.outputFileSystem;
|
||||
} else {
|
||||
fileSystem = new MemoryFileSystem();
|
||||
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
compiler.outputFileSystem = fileSystem;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
context.fs = fileSystem;
|
||||
},
|
||||
};
|
||||
+136
@@ -0,0 +1,136 @@
|
||||
'use strict';
|
||||
|
||||
const path = require('path');
|
||||
|
||||
const mime = require('mime');
|
||||
|
||||
const DevMiddlewareError = require('./DevMiddlewareError');
|
||||
const {
|
||||
getFilenameFromUrl,
|
||||
handleRangeHeaders,
|
||||
handleRequest,
|
||||
ready,
|
||||
} = require('./util');
|
||||
|
||||
// Do not add a charset to the Content-Type header of these file types
|
||||
// otherwise the client will fail to render them correctly.
|
||||
const NonCharsetFileTypes = /\.(wasm|usdz)$/;
|
||||
|
||||
module.exports = function wrapper(context) {
|
||||
return function middleware(req, res, next) {
|
||||
// fixes #282. credit @cexoso. in certain edge situations res.locals is
|
||||
// undefined.
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
res.locals = res.locals || {};
|
||||
|
||||
function goNext() {
|
||||
if (!context.options.serverSideRender) {
|
||||
return next();
|
||||
}
|
||||
|
||||
return new Promise((resolve) => {
|
||||
ready(
|
||||
context,
|
||||
() => {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
res.locals.webpackStats = context.webpackStats;
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
res.locals.fs = context.fs;
|
||||
|
||||
resolve(next());
|
||||
},
|
||||
req
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
const acceptedMethods = context.options.methods || ['GET', 'HEAD'];
|
||||
|
||||
if (acceptedMethods.indexOf(req.method) === -1) {
|
||||
return goNext();
|
||||
}
|
||||
|
||||
let filename = getFilenameFromUrl(
|
||||
context.options.publicPath,
|
||||
context.compiler,
|
||||
req.url
|
||||
);
|
||||
|
||||
if (filename === false) {
|
||||
return goNext();
|
||||
}
|
||||
|
||||
return new Promise((resolve) => {
|
||||
handleRequest(context, filename, processRequest, req);
|
||||
// eslint-disable-next-line consistent-return
|
||||
function processRequest() {
|
||||
try {
|
||||
let stat = context.fs.statSync(filename);
|
||||
|
||||
if (!stat.isFile()) {
|
||||
if (stat.isDirectory()) {
|
||||
let { index } = context.options;
|
||||
|
||||
// eslint-disable-next-line no-undefined
|
||||
if (index === undefined || index === true) {
|
||||
index = 'index.html';
|
||||
} else if (!index) {
|
||||
throw new DevMiddlewareError('next');
|
||||
}
|
||||
|
||||
filename = path.posix.join(filename, index);
|
||||
stat = context.fs.statSync(filename);
|
||||
|
||||
if (!stat.isFile()) {
|
||||
throw new DevMiddlewareError('next');
|
||||
}
|
||||
} else {
|
||||
throw new DevMiddlewareError('next');
|
||||
}
|
||||
}
|
||||
} catch (e) {
|
||||
return resolve(goNext());
|
||||
}
|
||||
|
||||
// server content
|
||||
let content = context.fs.readFileSync(filename);
|
||||
|
||||
content = handleRangeHeaders(content, req, res);
|
||||
|
||||
let contentType = mime.getType(filename) || '';
|
||||
|
||||
if (!NonCharsetFileTypes.test(filename)) {
|
||||
contentType += '; charset=UTF-8';
|
||||
}
|
||||
|
||||
if (!res.getHeader || !res.getHeader('Content-Type')) {
|
||||
res.setHeader('Content-Type', contentType);
|
||||
}
|
||||
|
||||
res.setHeader('Content-Length', content.length);
|
||||
|
||||
const { headers } = context.options;
|
||||
|
||||
if (headers) {
|
||||
for (const name in headers) {
|
||||
if ({}.hasOwnProperty.call(headers, name)) {
|
||||
res.setHeader(name, context.options.headers[name]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Express automatically sets the statusCode to 200, but not all servers do (Koa).
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
res.statusCode = res.statusCode || 200;
|
||||
|
||||
if (res.send) {
|
||||
res.send(content);
|
||||
} else {
|
||||
res.end(content);
|
||||
}
|
||||
|
||||
resolve();
|
||||
}
|
||||
});
|
||||
};
|
||||
};
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
'use strict';
|
||||
|
||||
module.exports = function reporter(middlewareOptions, options) {
|
||||
const { log, state, stats } = options;
|
||||
|
||||
if (state) {
|
||||
const displayStats = middlewareOptions.stats !== false;
|
||||
const statsString = stats.toString(middlewareOptions.stats);
|
||||
|
||||
// displayStats only logged
|
||||
if (displayStats && statsString.trim().length) {
|
||||
if (stats.hasErrors()) {
|
||||
log.error(statsString);
|
||||
} else if (stats.hasWarnings()) {
|
||||
log.warn(statsString);
|
||||
} else {
|
||||
log.info(statsString);
|
||||
}
|
||||
}
|
||||
|
||||
let message = 'Compiled successfully.';
|
||||
|
||||
if (stats.hasErrors()) {
|
||||
message = 'Failed to compile.';
|
||||
} else if (stats.hasWarnings()) {
|
||||
message = 'Compiled with warnings.';
|
||||
}
|
||||
log.info(message);
|
||||
} else {
|
||||
log.info('Compiling...');
|
||||
}
|
||||
};
|
||||
+188
@@ -0,0 +1,188 @@
|
||||
'use strict';
|
||||
|
||||
const path = require('path');
|
||||
const { parse } = require('url');
|
||||
const querystring = require('querystring');
|
||||
|
||||
const parseRange = require('range-parser');
|
||||
|
||||
const HASH_REGEXP = /[0-9a-f]{10,}/;
|
||||
|
||||
// support for multi-compiler configuration
|
||||
// see: https://github.com/webpack/webpack-dev-server/issues/641
|
||||
function getPaths(publicPath, compiler, url) {
|
||||
const compilers = compiler && compiler.compilers;
|
||||
if (Array.isArray(compilers)) {
|
||||
let compilerPublicPath;
|
||||
|
||||
// the path portion of compilerPublicPath
|
||||
let compilerPublicPathBase;
|
||||
|
||||
for (let i = 0; i < compilers.length; i++) {
|
||||
compilerPublicPath =
|
||||
compilers[i].options &&
|
||||
compilers[i].options.output &&
|
||||
compilers[i].options.output.publicPath;
|
||||
|
||||
if (compilerPublicPath) {
|
||||
compilerPublicPathBase =
|
||||
compilerPublicPath.indexOf('/') === 0
|
||||
? compilerPublicPath // eslint-disable-next-line
|
||||
: // handle the case where compilerPublicPath is a URL with hostname
|
||||
parse(compilerPublicPath).pathname;
|
||||
|
||||
// check the url vs the path part of the compilerPublicPath
|
||||
if (url.indexOf(compilerPublicPathBase) === 0) {
|
||||
return {
|
||||
publicPath: compilerPublicPath,
|
||||
outputPath: compilers[i].outputPath,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return {
|
||||
publicPath,
|
||||
outputPath: compiler.outputPath,
|
||||
};
|
||||
}
|
||||
|
||||
// eslint-disable-next-line consistent-return
|
||||
function ready(context, fn, req) {
|
||||
if (context.state) {
|
||||
return fn(context.webpackStats);
|
||||
}
|
||||
|
||||
context.log.info(`wait until bundle finished: ${req.url || fn.name}`);
|
||||
context.callbacks.push(fn);
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
getFilenameFromUrl(pubPath, compiler, url) {
|
||||
const { outputPath, publicPath } = getPaths(pubPath, compiler, url);
|
||||
// localPrefix is the folder our bundle should be in
|
||||
const localPrefix = parse(publicPath || '/', false, true);
|
||||
const urlObject = parse(url);
|
||||
let filename;
|
||||
|
||||
const hostNameIsTheSame = localPrefix.hostname === urlObject.hostname;
|
||||
|
||||
// publicPath has the hostname that is not the same as request url's, should fail
|
||||
if (
|
||||
localPrefix.hostname !== null &&
|
||||
urlObject.hostname !== null &&
|
||||
!hostNameIsTheSame
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// publicPath is not in url, so it should fail
|
||||
if (publicPath && hostNameIsTheSame && url.indexOf(publicPath) !== 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// strip localPrefix from the start of url
|
||||
if (urlObject.pathname.indexOf(localPrefix.pathname) === 0) {
|
||||
filename = urlObject.pathname.substr(localPrefix.pathname.length);
|
||||
}
|
||||
|
||||
if (
|
||||
!urlObject.hostname &&
|
||||
localPrefix.hostname &&
|
||||
url.indexOf(localPrefix.path) !== 0
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
let uri = outputPath;
|
||||
|
||||
/* istanbul ignore if */
|
||||
if (process.platform === 'win32') {
|
||||
// Path Handling for Microsoft Windows
|
||||
if (filename) {
|
||||
uri = path.posix.join(outputPath || '', querystring.unescape(filename));
|
||||
|
||||
if (!path.win32.isAbsolute(uri)) {
|
||||
uri = `/${uri}`;
|
||||
}
|
||||
}
|
||||
|
||||
return uri;
|
||||
}
|
||||
|
||||
// Path Handling for all other operating systems
|
||||
if (filename) {
|
||||
uri = path.posix.join(outputPath || '', filename);
|
||||
|
||||
if (!path.posix.isAbsolute(uri)) {
|
||||
uri = `/${uri}`;
|
||||
}
|
||||
}
|
||||
|
||||
// if no matches, use outputPath as filename
|
||||
return querystring.unescape(uri);
|
||||
},
|
||||
|
||||
handleRangeHeaders(content, req, res) {
|
||||
// assumes express API. For other servers, need to add logic to access
|
||||
// alternative header APIs
|
||||
res.setHeader('Accept-Ranges', 'bytes');
|
||||
|
||||
if (req.headers.range) {
|
||||
const ranges = parseRange(content.length, req.headers.range);
|
||||
|
||||
// unsatisfiable
|
||||
if (ranges === -1) {
|
||||
res.setHeader('Content-Range', `bytes */${content.length}`);
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
res.statusCode = 416;
|
||||
}
|
||||
|
||||
// valid (syntactically invalid/multiple ranges are treated as a
|
||||
// regular response)
|
||||
if (ranges !== -2 && ranges.length === 1) {
|
||||
const { length } = content;
|
||||
|
||||
// Content-Range
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
res.statusCode = 206;
|
||||
res.setHeader(
|
||||
'Content-Range',
|
||||
`bytes ${ranges[0].start}-${ranges[0].end}/${length}`
|
||||
);
|
||||
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
content = content.slice(ranges[0].start, ranges[0].end + 1);
|
||||
}
|
||||
}
|
||||
|
||||
return content;
|
||||
},
|
||||
|
||||
handleRequest(context, filename, processRequest, req) {
|
||||
// in lazy mode, rebuild on bundle request
|
||||
if (
|
||||
context.options.lazy &&
|
||||
(!context.options.filename || context.options.filename.test(filename))
|
||||
) {
|
||||
context.rebuild();
|
||||
}
|
||||
|
||||
if (HASH_REGEXP.test(filename)) {
|
||||
try {
|
||||
if (context.fs.statSync(filename).isFile()) {
|
||||
processRequest();
|
||||
return;
|
||||
}
|
||||
} catch (e) {
|
||||
// eslint-disable-line
|
||||
}
|
||||
}
|
||||
|
||||
ready(context, processRequest, req);
|
||||
},
|
||||
|
||||
noop: () => {},
|
||||
|
||||
ready,
|
||||
};
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
#!/bin/sh
|
||||
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*|*MINGW*|*MSYS*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
if [ -x "$basedir/node" ]; then
|
||||
"$basedir/node" "$basedir/../mime/cli.js" "$@"
|
||||
ret=$?
|
||||
else
|
||||
node "$basedir/../mime/cli.js" "$@"
|
||||
ret=$?
|
||||
fi
|
||||
exit $ret
|
||||
+17
@@ -0,0 +1,17 @@
|
||||
@ECHO off
|
||||
SETLOCAL
|
||||
CALL :find_dp0
|
||||
|
||||
IF EXIST "%dp0%\node.exe" (
|
||||
SET "_prog=%dp0%\node.exe"
|
||||
) ELSE (
|
||||
SET "_prog=node"
|
||||
SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||
)
|
||||
|
||||
"%_prog%" "%dp0%\..\mime\cli.js" %*
|
||||
ENDLOCAL
|
||||
EXIT /b %errorlevel%
|
||||
:find_dp0
|
||||
SET dp0=%~dp0
|
||||
EXIT /b
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env pwsh
|
||||
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||
|
||||
$exe=""
|
||||
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||
# Fix case when both the Windows and Linux builds of Node
|
||||
# are installed in the same directory
|
||||
$exe=".exe"
|
||||
}
|
||||
$ret=0
|
||||
if (Test-Path "$basedir/node$exe") {
|
||||
& "$basedir/node$exe" "$basedir/../mime/cli.js" $args
|
||||
$ret=$LASTEXITCODE
|
||||
} else {
|
||||
& "node$exe" "$basedir/../mime/cli.js" $args
|
||||
$ret=$LASTEXITCODE
|
||||
}
|
||||
exit $ret
|
||||
+29
@@ -0,0 +1,29 @@
|
||||
# memory-fs
|
||||
|
||||
A simple in-memory filesystem. Holds data in a javascript object.
|
||||
|
||||
``` javascript
|
||||
var MemoryFileSystem = require("memory-fs");
|
||||
var fs = new MemoryFileSystem(); // Optionally pass a javascript object
|
||||
|
||||
fs.mkdirpSync("/a/test/dir");
|
||||
fs.writeFileSync("/a/test/dir/file.txt", "Hello World");
|
||||
fs.readFileSync("/a/test/dir/file.txt"); // returns Buffer("Hello World")
|
||||
|
||||
// Async variants too
|
||||
fs.unlink("/a/test/dir/file.txt", function(err) {
|
||||
// ...
|
||||
});
|
||||
|
||||
fs.readdirSync("/a/test"); // returns ["dir"]
|
||||
fs.statSync("/a/test/dir").isDirectory(); // returns true
|
||||
fs.rmdirSync("/a/test/dir");
|
||||
|
||||
fs.mkdirpSync("C:\\use\\windows\\style\\paths");
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2012-2014 Tobias Koppers
|
||||
|
||||
MIT (http://www.opensource.org/licenses/mit-license.php)
|
||||
Generated
Vendored
+329
@@ -0,0 +1,329 @@
|
||||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
|
||||
var normalize = require("./normalize");
|
||||
var errors = require("errno");
|
||||
var stream = require("readable-stream");
|
||||
|
||||
var ReadableStream = stream.Readable;
|
||||
var WritableStream = stream.Writable;
|
||||
|
||||
function MemoryFileSystemError(err, path) {
|
||||
Error.call(this)
|
||||
if (Error.captureStackTrace)
|
||||
Error.captureStackTrace(this, arguments.callee)
|
||||
this.code = err.code;
|
||||
this.errno = err.errno;
|
||||
this.message = err.description;
|
||||
this.path = path;
|
||||
}
|
||||
MemoryFileSystemError.prototype = new Error();
|
||||
|
||||
function MemoryFileSystem(data) {
|
||||
this.data = data || {};
|
||||
}
|
||||
module.exports = MemoryFileSystem;
|
||||
|
||||
function isDir(item) {
|
||||
if(typeof item !== "object") return false;
|
||||
return item[""] === true;
|
||||
}
|
||||
|
||||
function isFile(item) {
|
||||
if(typeof item !== "object") return false;
|
||||
return !item[""];
|
||||
}
|
||||
|
||||
function pathToArray(path) {
|
||||
path = normalize(path);
|
||||
var nix = /^\//.test(path);
|
||||
if(!nix) {
|
||||
if(!/^[A-Za-z]:/.test(path)) {
|
||||
throw new MemoryFileSystemError(errors.code.EINVAL, path);
|
||||
}
|
||||
path = path.replace(/[\\\/]+/g, "\\"); // multi slashs
|
||||
path = path.split(/[\\\/]/);
|
||||
path[0] = path[0].toUpperCase();
|
||||
} else {
|
||||
path = path.replace(/\/+/g, "/"); // multi slashs
|
||||
path = path.substr(1).split("/");
|
||||
}
|
||||
if(!path[path.length-1]) path.pop();
|
||||
return path;
|
||||
}
|
||||
|
||||
function trueFn() { return true; }
|
||||
function falseFn() { return false; }
|
||||
|
||||
MemoryFileSystem.prototype.meta = function(_path) {
|
||||
var path = pathToArray(_path);
|
||||
var current = this.data;
|
||||
for(var i = 0; i < path.length - 1; i++) {
|
||||
if(!isDir(current[path[i]]))
|
||||
return;
|
||||
current = current[path[i]];
|
||||
}
|
||||
return current[path[i]];
|
||||
}
|
||||
|
||||
MemoryFileSystem.prototype.existsSync = function(_path) {
|
||||
return !!this.meta(_path);
|
||||
}
|
||||
|
||||
MemoryFileSystem.prototype.statSync = function(_path) {
|
||||
var current = this.meta(_path);
|
||||
if(_path === "/" || isDir(current)) {
|
||||
return {
|
||||
isFile: falseFn,
|
||||
isDirectory: trueFn,
|
||||
isBlockDevice: falseFn,
|
||||
isCharacterDevice: falseFn,
|
||||
isSymbolicLink: falseFn,
|
||||
isFIFO: falseFn,
|
||||
isSocket: falseFn
|
||||
};
|
||||
} else if(isFile(current)) {
|
||||
return {
|
||||
isFile: trueFn,
|
||||
isDirectory: falseFn,
|
||||
isBlockDevice: falseFn,
|
||||
isCharacterDevice: falseFn,
|
||||
isSymbolicLink: falseFn,
|
||||
isFIFO: falseFn,
|
||||
isSocket: falseFn
|
||||
};
|
||||
} else {
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
}
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.readFileSync = function(_path, encoding) {
|
||||
var path = pathToArray(_path);
|
||||
var current = this.data;
|
||||
for(var i = 0; i < path.length - 1; i++) {
|
||||
if(!isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
current = current[path[i]];
|
||||
}
|
||||
if(!isFile(current[path[i]])) {
|
||||
if(isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.EISDIR, _path);
|
||||
else
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
}
|
||||
current = current[path[i]];
|
||||
return encoding ? current.toString(encoding) : current;
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.readdirSync = function(_path) {
|
||||
if(_path === "/") return Object.keys(this.data).filter(Boolean);
|
||||
var path = pathToArray(_path);
|
||||
var current = this.data;
|
||||
for(var i = 0; i < path.length - 1; i++) {
|
||||
if(!isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
current = current[path[i]];
|
||||
}
|
||||
if(!isDir(current[path[i]])) {
|
||||
if(isFile(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOTDIR, _path);
|
||||
else
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
}
|
||||
return Object.keys(current[path[i]]).filter(Boolean);
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.mkdirpSync = function(_path) {
|
||||
var path = pathToArray(_path);
|
||||
if(path.length === 0) return;
|
||||
var current = this.data;
|
||||
for(var i = 0; i < path.length; i++) {
|
||||
if(isFile(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOTDIR, _path);
|
||||
else if(!isDir(current[path[i]]))
|
||||
current[path[i]] = {"":true};
|
||||
current = current[path[i]];
|
||||
}
|
||||
return;
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.mkdirSync = function(_path) {
|
||||
var path = pathToArray(_path);
|
||||
if(path.length === 0) return;
|
||||
var current = this.data;
|
||||
for(var i = 0; i < path.length - 1; i++) {
|
||||
if(!isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
current = current[path[i]];
|
||||
}
|
||||
if(isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.EEXIST, _path);
|
||||
else if(isFile(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOTDIR, _path);
|
||||
current[path[i]] = {"":true};
|
||||
return;
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype._remove = function(_path, name, testFn) {
|
||||
var path = pathToArray(_path);
|
||||
if(path.length === 0) {
|
||||
throw new MemoryFileSystemError(errors.code.EPERM, _path);
|
||||
}
|
||||
var current = this.data;
|
||||
for(var i = 0; i < path.length - 1; i++) {
|
||||
if(!isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
current = current[path[i]];
|
||||
}
|
||||
if(!testFn(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
delete current[path[i]];
|
||||
return;
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.rmdirSync = function(_path) {
|
||||
return this._remove(_path, "Directory", isDir);
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.unlinkSync = function(_path) {
|
||||
return this._remove(_path, "File", isFile);
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.readlinkSync = function(_path) {
|
||||
throw new MemoryFileSystemError(errors.code.ENOSYS, _path);
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.writeFileSync = function(_path, content, encoding) {
|
||||
if(!content && !encoding) throw new Error("No content");
|
||||
var path = pathToArray(_path);
|
||||
if(path.length === 0) {
|
||||
throw new MemoryFileSystemError(errors.code.EISDIR, _path);
|
||||
}
|
||||
var current = this.data;
|
||||
for(var i = 0; i < path.length - 1; i++) {
|
||||
if(!isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.ENOENT, _path);
|
||||
current = current[path[i]];
|
||||
}
|
||||
if(isDir(current[path[i]]))
|
||||
throw new MemoryFileSystemError(errors.code.EISDIR, _path);
|
||||
current[path[i]] = encoding || typeof content === "string" ? new Buffer(content, encoding) : content;
|
||||
return;
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.join = require("./join");
|
||||
MemoryFileSystem.prototype.pathToArray = pathToArray;
|
||||
MemoryFileSystem.prototype.normalize = normalize;
|
||||
|
||||
// stream functions
|
||||
|
||||
MemoryFileSystem.prototype.createReadStream = function(path, options) {
|
||||
var stream = new ReadableStream();
|
||||
var done = false;
|
||||
var data;
|
||||
try {
|
||||
data = this.readFileSync(path);
|
||||
} catch (e) {
|
||||
stream._read = function() {
|
||||
if (done) {
|
||||
return;
|
||||
}
|
||||
done = true;
|
||||
this.emit('error', e);
|
||||
this.push(null);
|
||||
};
|
||||
return stream;
|
||||
}
|
||||
options = options || { };
|
||||
options.start = options.start || 0;
|
||||
options.end = options.end || data.length;
|
||||
stream._read = function() {
|
||||
if (done) {
|
||||
return;
|
||||
}
|
||||
done = true;
|
||||
this.push(data.slice(options.start, options.end));
|
||||
this.push(null);
|
||||
};
|
||||
return stream;
|
||||
};
|
||||
|
||||
MemoryFileSystem.prototype.createWriteStream = function(path, options) {
|
||||
var stream = new WritableStream(), self = this;
|
||||
try {
|
||||
// Zero the file and make sure it is writable
|
||||
this.writeFileSync(path, new Buffer(0));
|
||||
} catch(e) {
|
||||
// This or setImmediate?
|
||||
stream.once('prefinish', function() {
|
||||
stream.emit('error', e);
|
||||
});
|
||||
return stream;
|
||||
}
|
||||
var bl = [ ], len = 0;
|
||||
stream._write = function(chunk, encoding, callback) {
|
||||
bl.push(chunk);
|
||||
len += chunk.length;
|
||||
self.writeFile(path, Buffer.concat(bl, len), callback);
|
||||
}
|
||||
return stream;
|
||||
};
|
||||
|
||||
// async functions
|
||||
|
||||
["stat", "readdir", "mkdirp", "rmdir", "unlink", "readlink"].forEach(function(fn) {
|
||||
MemoryFileSystem.prototype[fn] = function(path, callback) {
|
||||
try {
|
||||
var result = this[fn + "Sync"](path);
|
||||
} catch(e) {
|
||||
setImmediate(function() {
|
||||
callback(e);
|
||||
});
|
||||
|
||||
return;
|
||||
}
|
||||
setImmediate(function() {
|
||||
callback(null, result);
|
||||
});
|
||||
};
|
||||
});
|
||||
|
||||
["mkdir", "readFile"].forEach(function(fn) {
|
||||
MemoryFileSystem.prototype[fn] = function(path, optArg, callback) {
|
||||
if(!callback) {
|
||||
callback = optArg;
|
||||
optArg = undefined;
|
||||
}
|
||||
try {
|
||||
var result = this[fn + "Sync"](path, optArg);
|
||||
} catch(e) {
|
||||
setImmediate(function() {
|
||||
callback(e);
|
||||
});
|
||||
|
||||
return;
|
||||
}
|
||||
setImmediate(function() {
|
||||
callback(null, result);
|
||||
});
|
||||
};
|
||||
});
|
||||
|
||||
MemoryFileSystem.prototype.exists = function(path, callback) {
|
||||
return callback(this.existsSync(path));
|
||||
}
|
||||
|
||||
MemoryFileSystem.prototype.writeFile = function (path, content, encoding, callback) {
|
||||
if(!callback) {
|
||||
callback = encoding;
|
||||
encoding = undefined;
|
||||
}
|
||||
try {
|
||||
this.writeFileSync(path, content, encoding);
|
||||
} catch(e) {
|
||||
return callback(e);
|
||||
}
|
||||
return callback();
|
||||
};
|
||||
Generated
Vendored
+14
@@ -0,0 +1,14 @@
|
||||
var normalize = require("./normalize");
|
||||
|
||||
var absoluteWinRegExp = /^[A-Z]:([\\\/]|$)/i;
|
||||
var absoluteNixRegExp = /^\//i;
|
||||
|
||||
module.exports = function join(path, request) {
|
||||
if(!request) return normalize(path);
|
||||
if(absoluteWinRegExp.test(request)) return normalize(request.replace(/\//g, "\\"));
|
||||
if(absoluteNixRegExp.test(request)) return normalize(request);
|
||||
if(path == "/") return normalize(path + request);
|
||||
if(absoluteWinRegExp.test(path)) return normalize(path.replace(/\//g, "\\") + "\\" + request.replace(/\//g, "\\"));
|
||||
if(absoluteNixRegExp.test(path)) return normalize(path + "/" + request);
|
||||
return normalize(path + "/" + request);
|
||||
};
|
||||
Generated
Vendored
+86
@@ -0,0 +1,86 @@
|
||||
module.exports = function normalize(path) {
|
||||
var parts = path.split(/(\\+|\/+)/);
|
||||
if(parts.length === 1)
|
||||
return path;
|
||||
var result = [];
|
||||
var absolutePathStart = 0;
|
||||
for(var i = 0, sep = false; i < parts.length; i++, sep = !sep) {
|
||||
var part = parts[i];
|
||||
if(i === 0 && /^([A-Z]:)?$/i.test(part)) {
|
||||
result.push(part);
|
||||
absolutePathStart = 2;
|
||||
} else if(sep) {
|
||||
result.push(part[0]);
|
||||
} else if(part === "..") {
|
||||
switch(result.length) {
|
||||
case 0:
|
||||
// i. e. ".." => ".."
|
||||
// i. e. "../a/b/c" => "../a/b/c"
|
||||
result.push(part);
|
||||
break;
|
||||
case 2:
|
||||
// i. e. "a/.." => ""
|
||||
// i. e. "/.." => "/"
|
||||
// i. e. "C:\.." => "C:\"
|
||||
// i. e. "a/../b/c" => "b/c"
|
||||
// i. e. "/../b/c" => "/b/c"
|
||||
// i. e. "C:\..\a\b\c" => "C:\a\b\c"
|
||||
i++;
|
||||
sep = !sep;
|
||||
result.length = absolutePathStart;
|
||||
break;
|
||||
case 4:
|
||||
// i. e. "a/b/.." => "a"
|
||||
// i. e. "/a/.." => "/"
|
||||
// i. e. "C:\a\.." => "C:\"
|
||||
// i. e. "/a/../b/c" => "/b/c"
|
||||
if(absolutePathStart === 0) {
|
||||
result.length -= 3;
|
||||
} else {
|
||||
i++;
|
||||
sep = !sep;
|
||||
result.length = 2;
|
||||
}
|
||||
break;
|
||||
default:
|
||||
// i. e. "/a/b/.." => "/a"
|
||||
// i. e. "/a/b/../c" => "/a/c"
|
||||
result.length -= 3;
|
||||
break;
|
||||
}
|
||||
} else if(part === ".") {
|
||||
switch(result.length) {
|
||||
case 0:
|
||||
// i. e. "." => "."
|
||||
// i. e. "./a/b/c" => "./a/b/c"
|
||||
result.push(part);
|
||||
break;
|
||||
case 2:
|
||||
// i. e. "a/." => "a"
|
||||
// i. e. "/." => "/"
|
||||
// i. e. "C:\." => "C:\"
|
||||
// i. e. "C:\.\a\b\c" => "C:\a\b\c"
|
||||
if(absolutePathStart === 0) {
|
||||
result.length--;
|
||||
} else {
|
||||
i++;
|
||||
sep = !sep;
|
||||
}
|
||||
break;
|
||||
default:
|
||||
// i. e. "a/b/." => "a/b"
|
||||
// i. e. "/a/." => "/"
|
||||
// i. e. "C:\a\." => "C:\"
|
||||
// i. e. "a/./b/c" => "a/b/c"
|
||||
// i. e. "/a/./b/c" => "/a/b/c"
|
||||
result.length--;
|
||||
break;
|
||||
}
|
||||
} else if(part) {
|
||||
result.push(part);
|
||||
}
|
||||
}
|
||||
if(result.length === 1 && /^[A-Za-z]:$/.test(result))
|
||||
return result[0] + "\\";
|
||||
return result.join("");
|
||||
};
|
||||
Generated
Vendored
+70
@@ -0,0 +1,70 @@
|
||||
{
|
||||
"_from": "memory-fs@^0.4.1",
|
||||
"_id": "memory-fs@0.4.1",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha1-OpoguEYlI+RHz7x+i7gO1me/xVI=",
|
||||
"_location": "/webpack-dev-middleware/memory-fs",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "memory-fs@^0.4.1",
|
||||
"name": "memory-fs",
|
||||
"escapedName": "memory-fs",
|
||||
"rawSpec": "^0.4.1",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^0.4.1"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/webpack-dev-middleware"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/memory-fs/-/memory-fs-0.4.1.tgz",
|
||||
"_shasum": "3a9a20b8462523e447cfbc7e8bb80ed667bfc552",
|
||||
"_spec": "memory-fs@^0.4.1",
|
||||
"_where": "O:\\zero\\zero.Web\\node_modules\\webpack-dev-middleware",
|
||||
"author": {
|
||||
"name": "Tobias Koppers @sokra"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/webpack/memory-fs/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"dependencies": {
|
||||
"errno": "^0.1.3",
|
||||
"readable-stream": "^2.0.1"
|
||||
},
|
||||
"deprecated": false,
|
||||
"description": "A simple in-memory filesystem. Holds data in a javascript object.",
|
||||
"devDependencies": {
|
||||
"bl": "^1.0.0",
|
||||
"codecov.io": "^0.1.4",
|
||||
"coveralls": "^2.11.2",
|
||||
"istanbul": "^0.2.13",
|
||||
"mocha": "^1.20.1",
|
||||
"should": "^4.0.4"
|
||||
},
|
||||
"directories": {
|
||||
"test": "test"
|
||||
},
|
||||
"files": [
|
||||
"lib/"
|
||||
],
|
||||
"homepage": "https://github.com/webpack/memory-fs",
|
||||
"keywords": [
|
||||
"fs",
|
||||
"memory"
|
||||
],
|
||||
"license": "MIT",
|
||||
"main": "lib/MemoryFileSystem.js",
|
||||
"name": "memory-fs",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/webpack/memory-fs.git"
|
||||
},
|
||||
"scripts": {
|
||||
"cover": "istanbul cover node_modules/mocha/bin/_mocha",
|
||||
"test": "mocha",
|
||||
"travis": "npm run cover -- --report lcovonly"
|
||||
},
|
||||
"version": "0.4.1"
|
||||
}
|
||||
+51
@@ -0,0 +1,51 @@
|
||||
{
|
||||
"root": true,
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 6
|
||||
},
|
||||
"env": {
|
||||
"browser": true,
|
||||
"commonjs": true,
|
||||
"node": true,
|
||||
"mocha": true
|
||||
},
|
||||
"extends": ["eslint:recommended"],
|
||||
"rules": {
|
||||
"array-bracket-spacing": ["warn", "never"],
|
||||
"arrow-body-style": ["warn", "as-needed"],
|
||||
"arrow-parens": ["warn", "as-needed"],
|
||||
"arrow-spacing": "warn",
|
||||
"brace-style": ["warn", "1tbs"],
|
||||
"camelcase": "warn",
|
||||
"comma-spacing": ["warn", {"after": true}],
|
||||
"dot-notation": "warn",
|
||||
"eqeqeq": ["warn", "smart"],
|
||||
"indent": ["warn", 2, {
|
||||
"SwitchCase": 1,
|
||||
"FunctionDeclaration": {"parameters": 1},
|
||||
"MemberExpression": 1,
|
||||
"CallExpression": {"arguments": 1}
|
||||
}],
|
||||
"key-spacing": ["warn", {"beforeColon": false, "afterColon": true, "mode": "minimum"}],
|
||||
"keyword-spacing": "warn",
|
||||
"no-console": "off",
|
||||
"no-empty": "off",
|
||||
"no-multi-spaces": "warn",
|
||||
"no-redeclare": "off",
|
||||
"no-restricted-globals": ["warn", "Promise"],
|
||||
"no-trailing-spaces": "warn",
|
||||
"no-undef": "error",
|
||||
"no-unused-vars": ["warn", {"args": "none"}],
|
||||
"one-var": ["warn", "never"],
|
||||
"padded-blocks": ["warn", "never"],
|
||||
"object-curly-spacing": ["warn", "never"],
|
||||
"quotes": ["warn", "single"],
|
||||
"react/prop-types": "off",
|
||||
"react/jsx-no-bind": "off",
|
||||
"semi": ["warn", "always"],
|
||||
"space-before-blocks": ["warn", "always"],
|
||||
"space-before-function-paren": ["warn", "never"],
|
||||
"space-in-parens": ["warn", "never"],
|
||||
"strict": ["warn", "global"]
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+6
@@ -0,0 +1,6 @@
|
||||
### If you have an issue with a specific extension or type
|
||||
|
||||
Locate the definition for your extension/type in the [db.json file](https://github.com/jshttp/mime-db/blob/master/db.json) in the `mime-db` project. Does it look right?
|
||||
|
||||
- [ ] No. [File a `mime-db` issue](https://github.com/jshttp/mime-db/issues/new).
|
||||
- [ ] Yes: Go ahead and submit your issue/PR here and I'll look into it.
|
||||
Generated
Vendored
+6
@@ -0,0 +1,6 @@
|
||||
### If you have an issue with a specific extension or type
|
||||
|
||||
Locate the definition for your extension/type in the [db.json file](https://github.com/jshttp/mime-db/blob/master/db.json) in the `mime-db` project. Does it look right?
|
||||
|
||||
- [ ] No. [File a `mime-db` issue](https://github.com/jshttp/mime-db/issues/new).
|
||||
- [ ] Yes: Go ahead and submit your issue/PR here and I'll look into it.
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- "6"
|
||||
- "8"
|
||||
- "10"
|
||||
+262
@@ -0,0 +1,262 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
||||
|
||||
### [2.4.4](https://github.com/broofa/node-mime/compare/v2.4.3...v2.4.4) (2019-06-07)
|
||||
|
||||
|
||||
|
||||
## [2.4.3](https://github.com/broofa/node-mime/compare/v2.4.2...v2.4.3) (2019-05-15)
|
||||
|
||||
|
||||
|
||||
## [2.4.2](https://github.com/broofa/node-mime/compare/v2.4.1...v2.4.2) (2019-04-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* don't use arrow function introduced in 2.4.1 ([2e00b5c](https://github.com/broofa/node-mime/commit/2e00b5c))
|
||||
|
||||
|
||||
|
||||
## [2.4.1](https://github.com/broofa/node-mime/compare/v2.4.0...v2.4.1) (2019-04-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update MDN and mime-db types ([3e567a9](https://github.com/broofa/node-mime/commit/3e567a9))
|
||||
|
||||
|
||||
|
||||
<a name="2.4.0"></a>
|
||||
# [2.4.0](https://github.com/broofa/node-mime/compare/v2.3.1...v2.4.0) (2018-11-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Bind exported methods ([9d2a7b8](https://github.com/broofa/node-mime/commit/9d2a7b8))
|
||||
* update to mime-db@1.37.0 ([49e6e41](https://github.com/broofa/node-mime/commit/49e6e41))
|
||||
|
||||
|
||||
|
||||
<a name="2.3.1"></a>
|
||||
## [2.3.1](https://github.com/broofa/node-mime/compare/v2.3.0...v2.3.1) (2018-04-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* fix [#198](https://github.com/broofa/node-mime/issues/198) ([25ca180](https://github.com/broofa/node-mime/commit/25ca180))
|
||||
|
||||
|
||||
|
||||
<a name="2.3.0"></a>
|
||||
# [2.3.0](https://github.com/broofa/node-mime/compare/v2.2.2...v2.3.0) (2018-04-11)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* fix [#192](https://github.com/broofa/node-mime/issues/192) ([5c35df6](https://github.com/broofa/node-mime/commit/5c35df6))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add travis-ci testing ([d64160f](https://github.com/broofa/node-mime/commit/d64160f))
|
||||
|
||||
|
||||
|
||||
<a name="2.2.2"></a>
|
||||
## [2.2.2](https://github.com/broofa/node-mime/compare/v2.2.1...v2.2.2) (2018-03-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update types files to mime-db@1.32.0 ([85aac16](https://github.com/broofa/node-mime/commit/85aac16))
|
||||
|
||||
|
||||
|
||||
<a name="2.2.1"></a>
|
||||
## [2.2.1](https://github.com/broofa/node-mime/compare/v2.2.0...v2.2.1) (2018-03-30)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Retain type->extension mappings for non-default types. Fixes [#180](https://github.com/broofa/node-mime/issues/180) ([b5c83fb](https://github.com/broofa/node-mime/commit/b5c83fb))
|
||||
|
||||
|
||||
|
||||
<a name="2.2.0"></a>
|
||||
# [2.2.0](https://github.com/broofa/node-mime/compare/v2.1.0...v2.2.0) (2018-01-04)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Retain type->extension mappings for non-default types. Fixes [#180](https://github.com/broofa/node-mime/issues/180) ([10f82ac](https://github.com/broofa/node-mime/commit/10f82ac))
|
||||
|
||||
|
||||
|
||||
<a name="2.1.0"></a>
|
||||
# [2.1.0](https://github.com/broofa/node-mime/compare/v2.0.5...v2.1.0) (2017-12-22)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Upgrade to mime-db@1.32.0. Fixes [#185](https://github.com/broofa/node-mime/issues/185) ([3f775ba](https://github.com/broofa/node-mime/commit/3f775ba))
|
||||
|
||||
|
||||
|
||||
<a name="2.0.5"></a>
|
||||
## [2.0.5](https://github.com/broofa/node-mime/compare/v2.0.1...v2.0.5) (2017-12-22)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* ES5 support (back to node v0.4) ([f14ccb6](https://github.com/broofa/node-mime/commit/f14ccb6))
|
||||
|
||||
|
||||
|
||||
# Changelog
|
||||
|
||||
## v2.0.4 (24/11/2017)
|
||||
- [**closed**] Switch to mime-score module for resolving extension contention issues. [#182](https://github.com/broofa/node-mime/issues/182)
|
||||
- [**closed**] Update mime-db to 1.31.0 in v1.x branch [#181](https://github.com/broofa/node-mime/issues/181)
|
||||
|
||||
---
|
||||
|
||||
## v1.5.0 (22/11/2017)
|
||||
- [**closed**] need ES5 version ready in npm package [#179](https://github.com/broofa/node-mime/issues/179)
|
||||
- [**closed**] mime-db no trace of iWork - pages / numbers / etc. [#178](https://github.com/broofa/node-mime/issues/178)
|
||||
- [**closed**] How it works in brownser ? [#176](https://github.com/broofa/node-mime/issues/176)
|
||||
- [**closed**] Missing `./Mime` [#175](https://github.com/broofa/node-mime/issues/175)
|
||||
- [**closed**] Vulnerable Regular Expression [#167](https://github.com/broofa/node-mime/issues/167)
|
||||
|
||||
---
|
||||
|
||||
## v2.0.3 (25/09/2017)
|
||||
*No changelog for this release.*
|
||||
|
||||
---
|
||||
|
||||
## v1.4.1 (25/09/2017)
|
||||
- [**closed**] Issue when bundling with webpack [#172](https://github.com/broofa/node-mime/issues/172)
|
||||
|
||||
---
|
||||
|
||||
## v2.0.2 (15/09/2017)
|
||||
- [**V2**] fs.readFileSync is not a function [#165](https://github.com/broofa/node-mime/issues/165)
|
||||
- [**closed**] The extension for video/quicktime should map to .mov, not .qt [#164](https://github.com/broofa/node-mime/issues/164)
|
||||
- [**V2**] [v2 Feedback request] Mime class API [#163](https://github.com/broofa/node-mime/issues/163)
|
||||
- [**V2**] [v2 Feedback request] Resolving conflicts over extensions [#162](https://github.com/broofa/node-mime/issues/162)
|
||||
- [**V2**] Allow callers to load module with official, full, or no defined types. [#161](https://github.com/broofa/node-mime/issues/161)
|
||||
- [**V2**] Use "facets" to resolve extension conflicts [#160](https://github.com/broofa/node-mime/issues/160)
|
||||
- [**V2**] Remove fs and path dependencies [#152](https://github.com/broofa/node-mime/issues/152)
|
||||
- [**V2**] Default content-type should not be application/octet-stream [#139](https://github.com/broofa/node-mime/issues/139)
|
||||
- [**V2**] reset mime-types [#124](https://github.com/broofa/node-mime/issues/124)
|
||||
- [**V2**] Extensionless paths should return null or false [#113](https://github.com/broofa/node-mime/issues/113)
|
||||
|
||||
---
|
||||
|
||||
## v2.0.1 (14/09/2017)
|
||||
- [**closed**] Changelog for v2.0 does not mention breaking changes [#171](https://github.com/broofa/node-mime/issues/171)
|
||||
- [**closed**] MIME breaking with 'class' declaration as it is without 'use strict mode' [#170](https://github.com/broofa/node-mime/issues/170)
|
||||
|
||||
---
|
||||
|
||||
## v2.0.0 (12/09/2017)
|
||||
- [**closed**] woff and woff2 [#168](https://github.com/broofa/node-mime/issues/168)
|
||||
|
||||
---
|
||||
|
||||
## v1.4.0 (28/08/2017)
|
||||
- [**closed**] support for ac3 voc files [#159](https://github.com/broofa/node-mime/issues/159)
|
||||
- [**closed**] Help understanding change from application/xml to text/xml [#158](https://github.com/broofa/node-mime/issues/158)
|
||||
- [**closed**] no longer able to override mimetype [#157](https://github.com/broofa/node-mime/issues/157)
|
||||
- [**closed**] application/vnd.adobe.photoshop [#147](https://github.com/broofa/node-mime/issues/147)
|
||||
- [**closed**] Directories should appear as something other than application/octet-stream [#135](https://github.com/broofa/node-mime/issues/135)
|
||||
- [**closed**] requested features [#131](https://github.com/broofa/node-mime/issues/131)
|
||||
- [**closed**] Make types.json loading optional? [#129](https://github.com/broofa/node-mime/issues/129)
|
||||
- [**closed**] Cannot find module './types.json' [#120](https://github.com/broofa/node-mime/issues/120)
|
||||
- [**V2**] .wav files show up as "audio/x-wav" instead of "audio/x-wave" [#118](https://github.com/broofa/node-mime/issues/118)
|
||||
- [**closed**] Don't be a pain in the ass for node community [#108](https://github.com/broofa/node-mime/issues/108)
|
||||
- [**closed**] don't make default_type global [#78](https://github.com/broofa/node-mime/issues/78)
|
||||
- [**closed**] mime.extension() fails if the content-type is parameterized [#74](https://github.com/broofa/node-mime/issues/74)
|
||||
|
||||
---
|
||||
|
||||
## v1.3.6 (11/05/2017)
|
||||
- [**closed**] .md should be text/markdown as of March 2016 [#154](https://github.com/broofa/node-mime/issues/154)
|
||||
- [**closed**] Error while installing mime [#153](https://github.com/broofa/node-mime/issues/153)
|
||||
- [**closed**] application/manifest+json [#149](https://github.com/broofa/node-mime/issues/149)
|
||||
- [**closed**] Dynamic adaptive streaming over HTTP (DASH) file extension typo [#141](https://github.com/broofa/node-mime/issues/141)
|
||||
- [**closed**] charsets image/png undefined [#140](https://github.com/broofa/node-mime/issues/140)
|
||||
- [**closed**] Mime-db dependency out of date [#130](https://github.com/broofa/node-mime/issues/130)
|
||||
- [**closed**] how to support plist? [#126](https://github.com/broofa/node-mime/issues/126)
|
||||
- [**closed**] how does .types file format look like? [#123](https://github.com/broofa/node-mime/issues/123)
|
||||
- [**closed**] Feature: support for expanding MIME patterns [#121](https://github.com/broofa/node-mime/issues/121)
|
||||
- [**closed**] DEBUG_MIME doesn't work [#117](https://github.com/broofa/node-mime/issues/117)
|
||||
|
||||
---
|
||||
|
||||
## v1.3.4 (06/02/2015)
|
||||
*No changelog for this release.*
|
||||
|
||||
---
|
||||
|
||||
## v1.3.3 (06/02/2015)
|
||||
*No changelog for this release.*
|
||||
|
||||
---
|
||||
|
||||
## v1.3.1 (05/02/2015)
|
||||
- [**closed**] Consider adding support for Handlebars .hbs file ending [#111](https://github.com/broofa/node-mime/issues/111)
|
||||
- [**closed**] Consider adding support for hjson. [#110](https://github.com/broofa/node-mime/issues/110)
|
||||
- [**closed**] Add mime type for Opus audio files [#94](https://github.com/broofa/node-mime/issues/94)
|
||||
- [**closed**] Consider making the `Requesting New Types` information more visible [#77](https://github.com/broofa/node-mime/issues/77)
|
||||
|
||||
---
|
||||
|
||||
## v1.3.0 (05/02/2015)
|
||||
- [**closed**] Add common name? [#114](https://github.com/broofa/node-mime/issues/114)
|
||||
- [**closed**] application/x-yaml [#104](https://github.com/broofa/node-mime/issues/104)
|
||||
- [**closed**] Add mime type for WOFF file format 2.0 [#102](https://github.com/broofa/node-mime/issues/102)
|
||||
- [**closed**] application/x-msi for .msi [#99](https://github.com/broofa/node-mime/issues/99)
|
||||
- [**closed**] Add mimetype for gettext translation files [#98](https://github.com/broofa/node-mime/issues/98)
|
||||
- [**closed**] collaborators [#88](https://github.com/broofa/node-mime/issues/88)
|
||||
- [**closed**] getting errot in installation of mime module...any1 can help? [#87](https://github.com/broofa/node-mime/issues/87)
|
||||
- [**closed**] should application/json's charset be utf8? [#86](https://github.com/broofa/node-mime/issues/86)
|
||||
- [**closed**] Add "license" and "licenses" to package.json [#81](https://github.com/broofa/node-mime/issues/81)
|
||||
- [**closed**] lookup with extension-less file on Windows returns wrong type [#68](https://github.com/broofa/node-mime/issues/68)
|
||||
|
||||
---
|
||||
|
||||
## v1.2.11 (15/08/2013)
|
||||
- [**closed**] Update mime.types [#65](https://github.com/broofa/node-mime/issues/65)
|
||||
- [**closed**] Publish a new version [#63](https://github.com/broofa/node-mime/issues/63)
|
||||
- [**closed**] README should state upfront that "application/octet-stream" is default for unknown extension [#55](https://github.com/broofa/node-mime/issues/55)
|
||||
- [**closed**] Suggested improvement to the charset API [#52](https://github.com/broofa/node-mime/issues/52)
|
||||
|
||||
---
|
||||
|
||||
## v1.2.10 (25/07/2013)
|
||||
- [**closed**] Mime type for woff files should be application/font-woff and not application/x-font-woff [#62](https://github.com/broofa/node-mime/issues/62)
|
||||
- [**closed**] node.types in conflict with mime.types [#51](https://github.com/broofa/node-mime/issues/51)
|
||||
|
||||
---
|
||||
|
||||
## v1.2.9 (17/01/2013)
|
||||
- [**closed**] Please update "mime" NPM [#49](https://github.com/broofa/node-mime/issues/49)
|
||||
- [**closed**] Please add semicolon [#46](https://github.com/broofa/node-mime/issues/46)
|
||||
- [**closed**] parse full mime types [#43](https://github.com/broofa/node-mime/issues/43)
|
||||
|
||||
---
|
||||
|
||||
## v1.2.8 (10/01/2013)
|
||||
- [**closed**] /js directory mime is application/javascript. Is it correct? [#47](https://github.com/broofa/node-mime/issues/47)
|
||||
- [**closed**] Add mime types for lua code. [#45](https://github.com/broofa/node-mime/issues/45)
|
||||
|
||||
---
|
||||
|
||||
## v1.2.7 (19/10/2012)
|
||||
- [**closed**] cannot install 1.2.7 via npm [#41](https://github.com/broofa/node-mime/issues/41)
|
||||
- [**closed**] Transfer ownership to @broofa [#36](https://github.com/broofa/node-mime/issues/36)
|
||||
- [**closed**] it's wrong to set charset to UTF-8 for text [#30](https://github.com/broofa/node-mime/issues/30)
|
||||
- [**closed**] Allow multiple instances of MIME types container [#27](https://github.com/broofa/node-mime/issues/27)
|
||||
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
1. Commit messages should have a [Conventional Commit](https://conventionalcommits.org/) prefix.
|
||||
2. If you're editing the `types/*` files, just stop. These are auto-generated from [mime-db](https://github.com/jshttp/mime-db). Go talk to those folks.
|
||||
3. README edits should be made to [src/README_md.js](src/README_md.js).
|
||||
|
||||
Thanks for helping out with this project. You rock!
|
||||
+21
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2010 Benjamin Thomas, Robert Kieffer
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
+95
@@ -0,0 +1,95 @@
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* @param typeMap [Object] Map of MIME type -> Array[extensions]
|
||||
* @param ...
|
||||
*/
|
||||
function Mime() {
|
||||
this._types = Object.create(null);
|
||||
this._extensions = Object.create(null);
|
||||
|
||||
for (var i = 0; i < arguments.length; i++) {
|
||||
this.define(arguments[i]);
|
||||
}
|
||||
|
||||
this.define = this.define.bind(this);
|
||||
this.getType = this.getType.bind(this);
|
||||
this.getExtension = this.getExtension.bind(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Define mimetype -> extension mappings. Each key is a mime-type that maps
|
||||
* to an array of extensions associated with the type. The first extension is
|
||||
* used as the default extension for the type.
|
||||
*
|
||||
* e.g. mime.define({'audio/ogg', ['oga', 'ogg', 'spx']});
|
||||
*
|
||||
* If a type declares an extension that has already been defined, an error will
|
||||
* be thrown. To suppress this error and force the extension to be associated
|
||||
* with the new type, pass `force`=true. Alternatively, you may prefix the
|
||||
* extension with "*" to map the type to extension, without mapping the
|
||||
* extension to the type.
|
||||
*
|
||||
* e.g. mime.define({'audio/wav', ['wav']}, {'audio/x-wav', ['*wav']});
|
||||
*
|
||||
*
|
||||
* @param map (Object) type definitions
|
||||
* @param force (Boolean) if true, force overriding of existing definitions
|
||||
*/
|
||||
Mime.prototype.define = function(typeMap, force) {
|
||||
for (var type in typeMap) {
|
||||
var extensions = typeMap[type].map(function(t) {return t.toLowerCase()});
|
||||
type = type.toLowerCase();
|
||||
|
||||
for (var i = 0; i < extensions.length; i++) {
|
||||
var ext = extensions[i];
|
||||
|
||||
// '*' prefix = not the preferred type for this extension. So fixup the
|
||||
// extension, and skip it.
|
||||
if (ext[0] == '*') {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!force && (ext in this._types)) {
|
||||
throw new Error(
|
||||
'Attempt to change mapping for "' + ext +
|
||||
'" extension from "' + this._types[ext] + '" to "' + type +
|
||||
'". Pass `force=true` to allow this, otherwise remove "' + ext +
|
||||
'" from the list of extensions for "' + type + '".'
|
||||
);
|
||||
}
|
||||
|
||||
this._types[ext] = type;
|
||||
}
|
||||
|
||||
// Use first extension as default
|
||||
if (force || !this._extensions[type]) {
|
||||
var ext = extensions[0];
|
||||
this._extensions[type] = (ext[0] != '*') ? ext : ext.substr(1)
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Lookup a mime type based on extension
|
||||
*/
|
||||
Mime.prototype.getType = function(path) {
|
||||
path = String(path);
|
||||
var last = path.replace(/^.*[/\\]/, '').toLowerCase();
|
||||
var ext = last.replace(/^.*\./, '').toLowerCase();
|
||||
|
||||
var hasPath = last.length < path.length;
|
||||
var hasDot = ext.length < last.length - 1;
|
||||
|
||||
return (hasDot || !hasPath) && this._types[ext] || null;
|
||||
};
|
||||
|
||||
/**
|
||||
* Return file extension associated with a mime type
|
||||
*/
|
||||
Mime.prototype.getExtension = function(type) {
|
||||
type = /^\s*([^;\s]*)/.test(type) && RegExp.$1;
|
||||
return type && this._extensions[type.toLowerCase()] || null;
|
||||
};
|
||||
|
||||
module.exports = Mime;
|
||||
+193
@@ -0,0 +1,193 @@
|
||||
<!--
|
||||
-- This file is auto-generated from src/README_js.md. Changes should be made there.
|
||||
-->
|
||||
# Mime
|
||||
|
||||
A comprehensive, compact MIME type module.
|
||||
|
||||
[](https://travis-ci.org/broofa/node-mime)
|
||||
|
||||
## Version 2 Notes
|
||||
|
||||
Version 2 is a breaking change from 1.x as the semver implies. Specifically:
|
||||
|
||||
* `lookup()` renamed to `getType()`
|
||||
* `extension()` renamed to `getExtension()`
|
||||
* `charset()` and `load()` methods have been removed
|
||||
|
||||
If you prefer the legacy version of this module please `npm install mime@^1`. Version 1 docs may be found [here](https://github.com/broofa/node-mime/tree/v1.4.0).
|
||||
|
||||
## Install
|
||||
|
||||
### NPM
|
||||
```
|
||||
npm install mime
|
||||
```
|
||||
|
||||
### Browser
|
||||
|
||||
It is recommended that you use a bundler such as
|
||||
[webpack](https://webpack.github.io/) or [browserify](http://browserify.org/) to
|
||||
package your code. However, browser-ready versions are available via wzrd.in.
|
||||
E.g. For the full version:
|
||||
|
||||
<script src="https://wzrd.in/standalone/mime@latest"></script>
|
||||
<script>
|
||||
mime.getType(...); // etc.
|
||||
<script>
|
||||
|
||||
Or, for the `mime/lite` version:
|
||||
|
||||
<script src="https://wzrd.in/standalone/mime%2flite@latest"></script>
|
||||
<script>
|
||||
mimelite.getType(...); // (Note `mimelite` here)
|
||||
<script>
|
||||
|
||||
## Quick Start
|
||||
|
||||
For the full version (800+ MIME types, 1,000+ extensions):
|
||||
|
||||
```javascript
|
||||
const mime = require('mime');
|
||||
|
||||
mime.getType('txt'); // ⇨ 'text/plain'
|
||||
mime.getExtension('text/plain'); // ⇨ 'txt'
|
||||
|
||||
```
|
||||
|
||||
See [Mime API](#mime-api) below for API details.
|
||||
|
||||
## Lite Version
|
||||
|
||||
There is also a "lite" version of this module that omits vendor-specific
|
||||
(`*/vnd.*`) and experimental (`*/x-*`) types. It weighs in at ~2.5KB, compared
|
||||
to 8KB for the full version. To load the lite version:
|
||||
|
||||
```javascript
|
||||
const mime = require('mime/lite');
|
||||
```
|
||||
|
||||
## Mime .vs. mime-types .vs. mime-db modules
|
||||
|
||||
For those of you wondering about the difference between these [popular] NPM modules,
|
||||
here's a brief rundown ...
|
||||
|
||||
[`mime-db`](https://github.com/jshttp/mime-db) is "the source of
|
||||
truth" for MIME type information. It is not an API. Rather, it is a canonical
|
||||
dataset of mime type definitions pulled from IANA, Apache, NGINX, and custom mappings
|
||||
submitted by the Node.js community.
|
||||
|
||||
[`mime-types`](https://github.com/jshttp/mime-types) is a thin
|
||||
wrapper around mime-db that provides an API drop-in compatible(ish) with `mime @ < v1.3.6` API.
|
||||
|
||||
`mime` is, as of v2, a self-contained module bundled with a pre-optimized version
|
||||
of the `mime-db` dataset. It provides a simplified API with the following characteristics:
|
||||
|
||||
* Intelligently resolved type conflicts (See [mime-score](https://github.com/broofa/mime-score) for details)
|
||||
* Method naming consistent with industry best-practices
|
||||
* Compact footprint. E.g. The minified+compressed sizes of the various modules:
|
||||
|
||||
Module | Size
|
||||
--- | ---
|
||||
`mime-db` | 18 KB
|
||||
`mime-types` | same as mime-db
|
||||
`mime` | 8 KB
|
||||
`mime/lite` | 2 KB
|
||||
|
||||
## Mime API
|
||||
|
||||
Both `require('mime')` and `require('mime/lite')` return instances of the MIME
|
||||
class, documented below.
|
||||
|
||||
Note: Inputs to this API are case-insensitive. Outputs (returned values) will
|
||||
be lowercase.
|
||||
|
||||
### new Mime(typeMap, ... more maps)
|
||||
|
||||
Most users of this module will not need to create Mime instances directly.
|
||||
However if you would like to create custom mappings, you may do so as follows
|
||||
...
|
||||
|
||||
```javascript
|
||||
// Require Mime class
|
||||
const Mime = require('mime/Mime');
|
||||
|
||||
// Define mime type -> extensions map
|
||||
const typeMap = {
|
||||
'text/abc': ['abc', 'alpha', 'bet'],
|
||||
'text/def': ['leppard']
|
||||
};
|
||||
|
||||
// Create and use Mime instance
|
||||
const myMime = new Mime(typeMap);
|
||||
myMime.getType('abc'); // ⇨ 'text/abc'
|
||||
myMime.getExtension('text/def'); // ⇨ 'leppard'
|
||||
|
||||
```
|
||||
|
||||
If more than one map argument is provided, each map is `define()`ed (see below), in order.
|
||||
|
||||
### mime.getType(pathOrExtension)
|
||||
|
||||
Get mime type for the given path or extension. E.g.
|
||||
|
||||
```javascript
|
||||
mime.getType('js'); // ⇨ 'application/javascript'
|
||||
mime.getType('json'); // ⇨ 'application/json'
|
||||
|
||||
mime.getType('txt'); // ⇨ 'text/plain'
|
||||
mime.getType('dir/text.txt'); // ⇨ 'text/plain'
|
||||
mime.getType('dir\\text.txt'); // ⇨ 'text/plain'
|
||||
mime.getType('.text.txt'); // ⇨ 'text/plain'
|
||||
mime.getType('.txt'); // ⇨ 'text/plain'
|
||||
|
||||
```
|
||||
|
||||
`null` is returned in cases where an extension is not detected or recognized
|
||||
|
||||
```javascript
|
||||
mime.getType('foo/txt'); // ⇨ null
|
||||
mime.getType('bogus_type'); // ⇨ null
|
||||
|
||||
```
|
||||
|
||||
### mime.getExtension(type)
|
||||
Get extension for the given mime type. Charset options (often included in
|
||||
Content-Type headers) are ignored.
|
||||
|
||||
```javascript
|
||||
mime.getExtension('text/plain'); // ⇨ 'txt'
|
||||
mime.getExtension('application/json'); // ⇨ 'json'
|
||||
mime.getExtension('text/html; charset=utf8'); // ⇨ 'html'
|
||||
|
||||
```
|
||||
|
||||
### mime.define(typeMap[, force = false])
|
||||
|
||||
Define [more] type mappings.
|
||||
|
||||
`typeMap` is a map of type -> extensions, as documented in `new Mime`, above.
|
||||
|
||||
By default this method will throw an error if you try to map a type to an
|
||||
extension that is already assigned to another type. Passing `true` for the
|
||||
`force` argument will suppress this behavior (overriding any previous mapping).
|
||||
|
||||
```javascript
|
||||
mime.define({'text/x-abc': ['abc', 'abcd']});
|
||||
|
||||
mime.getType('abcd'); // ⇨ 'text/x-abc'
|
||||
mime.getExtension('text/x-abc') // ⇨ 'abc'
|
||||
|
||||
```
|
||||
|
||||
## Command Line
|
||||
|
||||
mime [path_or_extension]
|
||||
|
||||
E.g.
|
||||
|
||||
> mime scripts/jquery.js
|
||||
application/javascript
|
||||
|
||||
----
|
||||
Markdown generated from [src/README_js.md](src/README_js.md) by [](https://github.com/broofa/runmd)
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
'use strict';
|
||||
|
||||
var mime = require('.');
|
||||
var file = process.argv[2];
|
||||
var type = mime.getType(file);
|
||||
|
||||
process.stdout.write(type + '\n');
|
||||
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
'use strict';
|
||||
|
||||
var Mime = require('./Mime');
|
||||
module.exports = new Mime(require('./types/standard'), require('./types/other'));
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
'use strict';
|
||||
|
||||
var Mime = require('./Mime');
|
||||
module.exports = new Mime(require('./types/standard'));
|
||||
+74
@@ -0,0 +1,74 @@
|
||||
{
|
||||
"_from": "mime@^2.4.4",
|
||||
"_id": "mime@2.4.4",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-LRxmNwziLPT828z+4YkNzloCFC2YM4wrB99k+AV5ZbEyfGNWfG8SO1FUXLmLDBSo89NrJZ4DIWeLjy1CHGhMGA==",
|
||||
"_location": "/webpack-dev-middleware/mime",
|
||||
"_phantomChildren": {},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "mime@^2.4.4",
|
||||
"name": "mime",
|
||||
"escapedName": "mime",
|
||||
"rawSpec": "^2.4.4",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^2.4.4"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/webpack-dev-middleware"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/mime/-/mime-2.4.4.tgz",
|
||||
"_shasum": "bd7b91135fc6b01cde3e9bae33d659b63d8857e5",
|
||||
"_spec": "mime@^2.4.4",
|
||||
"_where": "O:\\zero\\zero.Web\\node_modules\\webpack-dev-middleware",
|
||||
"author": {
|
||||
"name": "Robert Kieffer",
|
||||
"email": "robert@broofa.com",
|
||||
"url": "http://github.com/broofa"
|
||||
},
|
||||
"bin": {
|
||||
"mime": "cli.js"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/broofa/node-mime/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"contributors": [],
|
||||
"dependencies": {},
|
||||
"deprecated": false,
|
||||
"description": "A comprehensive library for mime-type mapping",
|
||||
"devDependencies": {
|
||||
"benchmark": "*",
|
||||
"chalk": "*",
|
||||
"eslint": "*",
|
||||
"mime-db": "1.40.0",
|
||||
"mime-score": "*",
|
||||
"mime-types": "2.1.24",
|
||||
"mocha": "6.1.4",
|
||||
"runmd": "*",
|
||||
"standard-version": "6.0.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=4.0.0"
|
||||
},
|
||||
"homepage": "https://github.com/broofa/node-mime#readme",
|
||||
"keywords": [
|
||||
"util",
|
||||
"mime"
|
||||
],
|
||||
"license": "MIT",
|
||||
"name": "mime",
|
||||
"repository": {
|
||||
"url": "git+https://github.com/broofa/node-mime.git",
|
||||
"type": "git"
|
||||
},
|
||||
"scripts": {
|
||||
"benchmark": "node src/benchmark.js",
|
||||
"md": "runmd --watch --output README.md src/README_js.md",
|
||||
"prepare": "node src/build.js && runmd --output README.md src/README_js.md",
|
||||
"release": "standard-version",
|
||||
"test": "mocha src/test.js"
|
||||
},
|
||||
"version": "2.4.4"
|
||||
}
|
||||
Generated
Vendored
+184
@@ -0,0 +1,184 @@
|
||||
```javascript --hide
|
||||
runmd.onRequire = path => path.replace(/^mime/, '..');
|
||||
```
|
||||
# Mime
|
||||
|
||||
A comprehensive, compact MIME type module.
|
||||
|
||||
[](https://travis-ci.org/broofa/node-mime)
|
||||
|
||||
## Version 2 Notes
|
||||
|
||||
Version 2 is a breaking change from 1.x as the semver implies. Specifically:
|
||||
|
||||
* `lookup()` renamed to `getType()`
|
||||
* `extension()` renamed to `getExtension()`
|
||||
* `charset()` and `load()` methods have been removed
|
||||
|
||||
If you prefer the legacy version of this module please `npm install mime@^1`. Version 1 docs may be found [here](https://github.com/broofa/node-mime/tree/v1.4.0).
|
||||
|
||||
## Install
|
||||
|
||||
### NPM
|
||||
```
|
||||
npm install mime
|
||||
```
|
||||
|
||||
### Browser
|
||||
|
||||
It is recommended that you use a bundler such as
|
||||
[webpack](https://webpack.github.io/) or [browserify](http://browserify.org/) to
|
||||
package your code. However, browser-ready versions are available via wzrd.in.
|
||||
E.g. For the full version:
|
||||
|
||||
<script src="https://wzrd.in/standalone/mime@latest"></script>
|
||||
<script>
|
||||
mime.getType(...); // etc.
|
||||
<script>
|
||||
|
||||
Or, for the `mime/lite` version:
|
||||
|
||||
<script src="https://wzrd.in/standalone/mime%2flite@latest"></script>
|
||||
<script>
|
||||
mimelite.getType(...); // (Note `mimelite` here)
|
||||
<script>
|
||||
|
||||
## Quick Start
|
||||
|
||||
For the full version (800+ MIME types, 1,000+ extensions):
|
||||
|
||||
```javascript --run default
|
||||
const mime = require('mime');
|
||||
|
||||
mime.getType('txt'); // RESULT
|
||||
mime.getExtension('text/plain'); // RESULT
|
||||
```
|
||||
|
||||
See [Mime API](#mime-api) below for API details.
|
||||
|
||||
## Lite Version
|
||||
|
||||
There is also a "lite" version of this module that omits vendor-specific
|
||||
(`*/vnd.*`) and experimental (`*/x-*`) types. It weighs in at ~2.5KB, compared
|
||||
to 8KB for the full version. To load the lite version:
|
||||
|
||||
```javascript
|
||||
const mime = require('mime/lite');
|
||||
```
|
||||
|
||||
## Mime .vs. mime-types .vs. mime-db modules
|
||||
|
||||
For those of you wondering about the difference between these [popular] NPM modules,
|
||||
here's a brief rundown ...
|
||||
|
||||
[`mime-db`](https://github.com/jshttp/mime-db) is "the source of
|
||||
truth" for MIME type information. It is not an API. Rather, it is a canonical
|
||||
dataset of mime type definitions pulled from IANA, Apache, NGINX, and custom mappings
|
||||
submitted by the Node.js community.
|
||||
|
||||
[`mime-types`](https://github.com/jshttp/mime-types) is a thin
|
||||
wrapper around mime-db that provides an API drop-in compatible(ish) with `mime @ < v1.3.6` API.
|
||||
|
||||
`mime` is, as of v2, a self-contained module bundled with a pre-optimized version
|
||||
of the `mime-db` dataset. It provides a simplified API with the following characteristics:
|
||||
|
||||
* Intelligently resolved type conflicts (See [mime-score](https://github.com/broofa/mime-score) for details)
|
||||
* Method naming consistent with industry best-practices
|
||||
* Compact footprint. E.g. The minified+compressed sizes of the various modules:
|
||||
|
||||
Module | Size
|
||||
--- | ---
|
||||
`mime-db` | 18 KB
|
||||
`mime-types` | same as mime-db
|
||||
`mime` | 8 KB
|
||||
`mime/lite` | 2 KB
|
||||
|
||||
## Mime API
|
||||
|
||||
Both `require('mime')` and `require('mime/lite')` return instances of the MIME
|
||||
class, documented below.
|
||||
|
||||
Note: Inputs to this API are case-insensitive. Outputs (returned values) will
|
||||
be lowercase.
|
||||
|
||||
### new Mime(typeMap, ... more maps)
|
||||
|
||||
Most users of this module will not need to create Mime instances directly.
|
||||
However if you would like to create custom mappings, you may do so as follows
|
||||
...
|
||||
|
||||
```javascript --run default
|
||||
// Require Mime class
|
||||
const Mime = require('mime/Mime');
|
||||
|
||||
// Define mime type -> extensions map
|
||||
const typeMap = {
|
||||
'text/abc': ['abc', 'alpha', 'bet'],
|
||||
'text/def': ['leppard']
|
||||
};
|
||||
|
||||
// Create and use Mime instance
|
||||
const myMime = new Mime(typeMap);
|
||||
myMime.getType('abc'); // RESULT
|
||||
myMime.getExtension('text/def'); // RESULT
|
||||
```
|
||||
|
||||
If more than one map argument is provided, each map is `define()`ed (see below), in order.
|
||||
|
||||
### mime.getType(pathOrExtension)
|
||||
|
||||
Get mime type for the given path or extension. E.g.
|
||||
|
||||
```javascript --run default
|
||||
mime.getType('js'); // RESULT
|
||||
mime.getType('json'); // RESULT
|
||||
|
||||
mime.getType('txt'); // RESULT
|
||||
mime.getType('dir/text.txt'); // RESULT
|
||||
mime.getType('dir\\text.txt'); // RESULT
|
||||
mime.getType('.text.txt'); // RESULT
|
||||
mime.getType('.txt'); // RESULT
|
||||
```
|
||||
|
||||
`null` is returned in cases where an extension is not detected or recognized
|
||||
|
||||
```javascript --run default
|
||||
mime.getType('foo/txt'); // RESULT
|
||||
mime.getType('bogus_type'); // RESULT
|
||||
```
|
||||
|
||||
### mime.getExtension(type)
|
||||
Get extension for the given mime type. Charset options (often included in
|
||||
Content-Type headers) are ignored.
|
||||
|
||||
```javascript --run default
|
||||
mime.getExtension('text/plain'); // RESULT
|
||||
mime.getExtension('application/json'); // RESULT
|
||||
mime.getExtension('text/html; charset=utf8'); // RESULT
|
||||
```
|
||||
|
||||
### mime.define(typeMap[, force = false])
|
||||
|
||||
Define [more] type mappings.
|
||||
|
||||
`typeMap` is a map of type -> extensions, as documented in `new Mime`, above.
|
||||
|
||||
By default this method will throw an error if you try to map a type to an
|
||||
extension that is already assigned to another type. Passing `true` for the
|
||||
`force` argument will suppress this behavior (overriding any previous mapping).
|
||||
|
||||
```javascript --run default
|
||||
mime.define({'text/x-abc': ['abc', 'abcd']});
|
||||
|
||||
mime.getType('abcd'); // RESULT
|
||||
mime.getExtension('text/x-abc') // RESULT
|
||||
```
|
||||
|
||||
## Command Line
|
||||
|
||||
mime [path_or_extension]
|
||||
|
||||
E.g.
|
||||
|
||||
> mime scripts/jquery.js
|
||||
application/javascript
|
||||
Generated
Vendored
+26
@@ -0,0 +1,26 @@
|
||||
const Benchmark = require('benchmark');
|
||||
const mime = require('..');
|
||||
const mimeLite = require('../lite');
|
||||
|
||||
const suite = new Benchmark.Suite();
|
||||
|
||||
const extensions = Object.keys(mime._types);
|
||||
let idx = 0;
|
||||
|
||||
suite
|
||||
.add('mime.getType',
|
||||
function() {
|
||||
mime.getType(extensions[idx++]);
|
||||
if (idx >= extensions.length) idx = 0;
|
||||
}
|
||||
)
|
||||
.add('mimeLite.getType',
|
||||
function() {
|
||||
mimeLite.getType(extensions[idx++]);
|
||||
if (idx >= extensions.length) idx = 0;
|
||||
}
|
||||
)
|
||||
.on('cycle', function(event) {
|
||||
console.log(String(event.target));
|
||||
})
|
||||
.run();
|
||||
+71
@@ -0,0 +1,71 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
'use strict';
|
||||
|
||||
var fs = require('fs');
|
||||
var path = require('path');
|
||||
var mimeScore = require('mime-score');
|
||||
|
||||
var db = require('mime-db');
|
||||
var chalk = require('chalk');
|
||||
|
||||
var STANDARD_FACET_SCORE = 900;
|
||||
|
||||
var byExtension = {};
|
||||
|
||||
// Clear out any conflict extensions in mime-db
|
||||
for (var type in db) {
|
||||
var entry = db[type];
|
||||
entry.type = type;
|
||||
if (!entry.extensions) continue;
|
||||
|
||||
entry.extensions.forEach(function(ext) {
|
||||
var drop;
|
||||
var keep = entry;
|
||||
if (ext in byExtension) {
|
||||
var e0 = entry;
|
||||
var e1 = byExtension[ext];
|
||||
|
||||
e0.pri = mimeScore(e0.type, e0.source);
|
||||
e1.pri = mimeScore(e1.type, e1.source);
|
||||
|
||||
drop = e0.pri < e1.pri ? e0 : e1;
|
||||
keep = e0.pri >= e1.pri ? e0 : e1;
|
||||
|
||||
// Prefix lower-priority extensions with '*'
|
||||
drop.extensions = drop.extensions.map(function(e) {return e == ext ? '*' + e : e});
|
||||
|
||||
console.log(
|
||||
ext + ': Preferring ' + chalk.green(keep.type) + ' (' + keep.pri +
|
||||
') over ' + chalk.red(drop.type) + ' (' + drop.pri + ')' + ' for ' + ext
|
||||
);
|
||||
}
|
||||
|
||||
// Cache the hightest ranking type for this extension
|
||||
if (keep == entry) byExtension[ext] = entry;
|
||||
});
|
||||
}
|
||||
|
||||
function writeTypesFile(types, path) {
|
||||
fs.writeFileSync(path, 'module.exports = ' + JSON.stringify(types) + ';');
|
||||
}
|
||||
|
||||
// Segregate into standard and non-standard types based on facet per
|
||||
// https://tools.ietf.org/html/rfc6838#section-3.1
|
||||
var standard = {};
|
||||
var other = {};
|
||||
|
||||
Object.keys(db).sort().forEach(function(k) {
|
||||
var entry = db[k];
|
||||
|
||||
if (entry.extensions) {
|
||||
if (mimeScore(entry.type, entry.source) >= STANDARD_FACET_SCORE) {
|
||||
standard[entry.type] = entry.extensions;
|
||||
} else {
|
||||
other[entry.type] = entry.extensions;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
writeTypesFile(standard, path.join(__dirname, '../types', 'standard.js'));
|
||||
writeTypesFile(other, path.join(__dirname, '../types', 'other.js'));
|
||||
+256
@@ -0,0 +1,256 @@
|
||||
'use strict';
|
||||
|
||||
var mime = require('..');
|
||||
var mimeTypes = require('../node_modules/mime-types');
|
||||
var assert = require('assert');
|
||||
var chalk = require('chalk');
|
||||
|
||||
describe('class Mime', function() {
|
||||
it('mime and mime/lite coexist', function() {
|
||||
assert.doesNotThrow(function() {
|
||||
require('../lite');
|
||||
});
|
||||
});
|
||||
|
||||
it('new constructor()', function() {
|
||||
var Mime = require('../Mime');
|
||||
|
||||
var mime = new Mime(
|
||||
{'text/a': ['a', 'a1']},
|
||||
{'text/b': ['b', 'b1']}
|
||||
);
|
||||
|
||||
assert.deepEqual(mime._types, {
|
||||
a: 'text/a',
|
||||
a1: 'text/a',
|
||||
b: 'text/b',
|
||||
b1: 'text/b',
|
||||
});
|
||||
|
||||
assert.deepEqual(mime._extensions, {
|
||||
'text/a': 'a',
|
||||
'text/b': 'b',
|
||||
});
|
||||
});
|
||||
|
||||
it('define()', function() {
|
||||
var Mime = require('../Mime');
|
||||
|
||||
var mime = new Mime({'text/a': ['a']}, {'text/b': ['b']});
|
||||
|
||||
assert.throws(function() {
|
||||
mime.define({'text/c': ['b']});
|
||||
});
|
||||
|
||||
assert.doesNotThrow(function() {
|
||||
mime.define({'text/c': ['b']}, true);
|
||||
});
|
||||
|
||||
assert.deepEqual(mime._types, {
|
||||
a: 'text/a',
|
||||
b: 'text/c',
|
||||
});
|
||||
|
||||
assert.deepEqual(mime._extensions, {
|
||||
'text/a': 'a',
|
||||
'text/b': 'b',
|
||||
'text/c': 'b',
|
||||
});
|
||||
});
|
||||
|
||||
it('define() *\'ed types', function() {
|
||||
var Mime = require('../Mime');
|
||||
|
||||
var mime = new Mime(
|
||||
{'text/a': ['*b']},
|
||||
{'text/b': ['b']}
|
||||
);
|
||||
|
||||
assert.deepEqual(mime._types, {
|
||||
b: 'text/b',
|
||||
});
|
||||
|
||||
assert.deepEqual(mime._extensions, {
|
||||
'text/a': 'b',
|
||||
'text/b': 'b',
|
||||
});
|
||||
});
|
||||
|
||||
it ('case-insensitive', function() {
|
||||
var Mime = require('../Mime');
|
||||
const mime = new Mime({
|
||||
'TEXT/UPPER': ['UP'],
|
||||
'text/lower': ['low'],
|
||||
});
|
||||
|
||||
assert.equal(mime.getType('test.up'), 'text/upper');
|
||||
assert.equal(mime.getType('test.UP'), 'text/upper');
|
||||
assert.equal(mime.getType('test.low'), 'text/lower');
|
||||
assert.equal(mime.getType('test.LOW'), 'text/lower');
|
||||
|
||||
assert.equal(mime.getExtension('text/upper'), 'up');
|
||||
assert.equal(mime.getExtension('text/lower'), 'low');
|
||||
assert.equal(mime.getExtension('TEXT/UPPER'), 'up');
|
||||
assert.equal(mime.getExtension('TEXT/LOWER'), 'low');
|
||||
});
|
||||
|
||||
it('getType()', function() {
|
||||
// Upper/lower case
|
||||
assert.equal(mime.getType('text.txt'), 'text/plain');
|
||||
assert.equal(mime.getType('TEXT.TXT'), 'text/plain');
|
||||
|
||||
// Bare extension
|
||||
assert.equal(mime.getType('txt'), 'text/plain');
|
||||
assert.equal(mime.getType('.txt'), 'text/plain');
|
||||
assert.strictEqual(mime.getType('.bogus'), null);
|
||||
assert.strictEqual(mime.getType('bogus'), null);
|
||||
|
||||
// Non-sensical
|
||||
assert.strictEqual(mime.getType(null), null);
|
||||
assert.strictEqual(mime.getType(undefined), null);
|
||||
assert.strictEqual(mime.getType(42), null);
|
||||
assert.strictEqual(mime.getType({}), null);
|
||||
|
||||
// File paths
|
||||
assert.equal(mime.getType('dir/text.txt'), 'text/plain');
|
||||
assert.equal(mime.getType('dir\\text.txt'), 'text/plain');
|
||||
assert.equal(mime.getType('.text.txt'), 'text/plain');
|
||||
assert.equal(mime.getType('.txt'), 'text/plain');
|
||||
assert.equal(mime.getType('txt'), 'text/plain');
|
||||
assert.equal(mime.getType('/path/to/page.html'), 'text/html');
|
||||
assert.equal(mime.getType('c:\\path\\to\\page.html'), 'text/html');
|
||||
assert.equal(mime.getType('page.html'), 'text/html');
|
||||
assert.equal(mime.getType('path/to/page.html'), 'text/html');
|
||||
assert.equal(mime.getType('path\\to\\page.html'), 'text/html');
|
||||
assert.strictEqual(mime.getType('/txt'), null);
|
||||
assert.strictEqual(mime.getType('\\txt'), null);
|
||||
assert.strictEqual(mime.getType('text.nope'), null);
|
||||
assert.strictEqual(mime.getType('/path/to/file.bogus'), null);
|
||||
assert.strictEqual(mime.getType('/path/to/json'), null);
|
||||
assert.strictEqual(mime.getType('/path/to/.json'), null);
|
||||
assert.strictEqual(mime.getType('/path/to/.config.json'), 'application/json');
|
||||
assert.strictEqual(mime.getType('.config.json'), 'application/json');
|
||||
});
|
||||
|
||||
it('getExtension()', function() {
|
||||
assert.equal(mime.getExtension('text/html'), 'html');
|
||||
assert.equal(mime.getExtension(' text/html'), 'html');
|
||||
assert.equal(mime.getExtension('text/html '), 'html');
|
||||
assert.strictEqual(mime.getExtension('application/x-bogus'), null);
|
||||
assert.strictEqual(mime.getExtension('bogus'), null);
|
||||
assert.strictEqual(mime.getExtension(null), null);
|
||||
assert.strictEqual(mime.getExtension(undefined), null);
|
||||
assert.strictEqual(mime.getExtension(42), null);
|
||||
assert.strictEqual(mime.getExtension({}), null);
|
||||
});
|
||||
});
|
||||
|
||||
describe('DB', function() {
|
||||
var diffs = [];
|
||||
|
||||
after(function() {
|
||||
if (diffs.length) {
|
||||
console.log('\n[INFO] The following inconsistencies with MDN (https://goo.gl/lHrFU6) and/or mime-types (https://github.com/jshttp/mime-types) are expected:');
|
||||
diffs.forEach(function(d) {
|
||||
console.warn(
|
||||
' ' + d[0]+ '[' + chalk.blue(d[1]) + '] = ' + chalk.red(d[2]) +
|
||||
', mime[' + d[1] + '] = ' + chalk.green(d[3])
|
||||
);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
it('Consistency', function() {
|
||||
for (var ext in this.types) {
|
||||
assert.equal(ext, this.extensions[this.types[ext]], '${ext} does not have consistent ext->type->ext mapping');
|
||||
}
|
||||
});
|
||||
|
||||
it('MDN types', function() {
|
||||
// MDN types listed at https://goo.gl/lHrFU6
|
||||
var MDN = {
|
||||
aac: 'audio/aac',
|
||||
bin: 'application/octet-stream',
|
||||
css: 'text/css',
|
||||
csv: 'text/csv',
|
||||
doc: 'application/msword',
|
||||
docx: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
|
||||
gif: 'image/gif',
|
||||
html: 'text/html',
|
||||
ico: 'image/vnd.microsoft.icon',
|
||||
jpg: 'image/jpeg',
|
||||
js: 'application/javascript',
|
||||
json: 'application/json',
|
||||
midi: 'audio/midi',
|
||||
mjs: 'application/javascript',
|
||||
mp3: 'audio/mpeg',
|
||||
mpeg: 'video/mpeg',
|
||||
oga: 'audio/ogg',
|
||||
ogv: 'video/ogg',
|
||||
otf: 'font/otf',
|
||||
png: 'image/png',
|
||||
pdf: 'application/pdf',
|
||||
rtf: 'application/rtf',
|
||||
svg: 'image/svg+xml',
|
||||
swf: 'application/x-shockwave-flash',
|
||||
tiff: 'image/tiff',
|
||||
ttf: 'font/ttf',
|
||||
txt: 'text/plain',
|
||||
wav: 'audio/wav',
|
||||
weba: 'audio/webm',
|
||||
webm: 'video/webm',
|
||||
webp: 'image/webp',
|
||||
woff: 'font/woff',
|
||||
xls: 'application/vnd.ms-excel',
|
||||
xlsx: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
|
||||
xml: 'application/xml',
|
||||
zip: 'application/zip',
|
||||
'3gp': 'video/3gpp',
|
||||
};
|
||||
|
||||
for (var ext in MDN) {
|
||||
var expected = MDN[ext];
|
||||
var actual = mime.getType(ext);
|
||||
if (actual !== expected) diffs.push(['MDN', ext, expected, actual]);
|
||||
}
|
||||
|
||||
for (var ext in mimeTypes.types) {
|
||||
var expected = mimeTypes.types[ext];
|
||||
var actual = mime.getType(ext);
|
||||
if (actual !== expected) diffs.push(['mime-types', ext, expected, actual]);
|
||||
}
|
||||
});
|
||||
|
||||
it('Specific types', function() {
|
||||
// Assortment of types we sanity check for good measure
|
||||
assert.equal(mime.getType('html'), 'text/html');
|
||||
assert.equal(mime.getType('js'), 'application/javascript');
|
||||
assert.equal(mime.getType('json'), 'application/json');
|
||||
assert.equal(mime.getType('rtf'), 'application/rtf');
|
||||
assert.equal(mime.getType('txt'), 'text/plain');
|
||||
assert.equal(mime.getType('xml'), 'application/xml');
|
||||
|
||||
assert.equal(mime.getType('wasm'), 'application/wasm');
|
||||
});
|
||||
|
||||
it('Specific extensions', function() {
|
||||
assert.equal(mime.getExtension('text/html;charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('text/HTML; charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('text/html; charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('text/html; charset=UTF-8 '), 'html');
|
||||
assert.equal(mime.getExtension('text/html ; charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension(mime._types.text), 'txt');
|
||||
assert.equal(mime.getExtension(mime._types.htm), 'html');
|
||||
assert.equal(mime.getExtension('application/octet-stream'), 'bin');
|
||||
assert.equal(mime.getExtension('application/octet-stream '), 'bin');
|
||||
assert.equal(mime.getExtension(' text/html; charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('text/html; charset=UTF-8 '), 'html');
|
||||
assert.equal(mime.getExtension('text/html; charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('text/html ; charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('text/html;charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('text/Html;charset=UTF-8'), 'html');
|
||||
assert.equal(mime.getExtension('unrecognized'), null);
|
||||
|
||||
assert.equal(mime.getExtension('text/xml'), 'xml'); // See #180
|
||||
});
|
||||
});
|
||||
+1
File diff suppressed because one or more lines are too long
Generated
Vendored
+1
File diff suppressed because one or more lines are too long
+107
@@ -0,0 +1,107 @@
|
||||
{
|
||||
"_from": "webpack-dev-middleware@^3.7.2",
|
||||
"_id": "webpack-dev-middleware@3.7.2",
|
||||
"_inBundle": false,
|
||||
"_integrity": "sha512-1xC42LxbYoqLNAhV6YzTYacicgMZQTqRd27Sim9wn5hJrX3I5nxYy1SxSd4+gjUFsz1dQFj+yEe6zEVmSkeJjw==",
|
||||
"_location": "/webpack-dev-middleware",
|
||||
"_phantomChildren": {
|
||||
"errno": "0.1.7",
|
||||
"readable-stream": "2.3.7"
|
||||
},
|
||||
"_requested": {
|
||||
"type": "range",
|
||||
"registry": true,
|
||||
"raw": "webpack-dev-middleware@^3.7.2",
|
||||
"name": "webpack-dev-middleware",
|
||||
"escapedName": "webpack-dev-middleware",
|
||||
"rawSpec": "^3.7.2",
|
||||
"saveSpec": null,
|
||||
"fetchSpec": "^3.7.2"
|
||||
},
|
||||
"_requiredBy": [
|
||||
"/webpack-dev-server"
|
||||
],
|
||||
"_resolved": "https://registry.npmjs.org/webpack-dev-middleware/-/webpack-dev-middleware-3.7.2.tgz",
|
||||
"_shasum": "0019c3db716e3fa5cecbf64f2ab88a74bab331f3",
|
||||
"_spec": "webpack-dev-middleware@^3.7.2",
|
||||
"_where": "O:\\zero\\zero.Web\\node_modules\\webpack-dev-server",
|
||||
"author": {
|
||||
"name": "Tobias Koppers @sokra"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/webpack/webpack-dev-middleware/issues"
|
||||
},
|
||||
"bundleDependencies": false,
|
||||
"dependencies": {
|
||||
"memory-fs": "^0.4.1",
|
||||
"mime": "^2.4.4",
|
||||
"mkdirp": "^0.5.1",
|
||||
"range-parser": "^1.2.1",
|
||||
"webpack-log": "^2.0.0"
|
||||
},
|
||||
"deprecated": false,
|
||||
"description": "A development middleware for webpack",
|
||||
"devDependencies": {
|
||||
"@babel/cli": "^7.6.2",
|
||||
"@babel/core": "^7.6.2",
|
||||
"@babel/preset-env": "^7.6.2",
|
||||
"@commitlint/cli": "^8.2.0",
|
||||
"@commitlint/config-conventional": "^8.2.0",
|
||||
"@webpack-contrib/defaults": "^5.0.2",
|
||||
"@webpack-contrib/eslint-config-webpack": "^3.0.0",
|
||||
"babel-jest": "^24.9.0",
|
||||
"commitlint-azure-pipelines-cli": "^1.0.2",
|
||||
"cross-env": "^5.2.1",
|
||||
"del": "^4.1.1",
|
||||
"del-cli": "^1.1.0",
|
||||
"eslint": "^6.4.0",
|
||||
"eslint-plugin-import": "^2.18.2",
|
||||
"eslint-plugin-prettier": "^3.1.1",
|
||||
"express": "^4.17.1",
|
||||
"file-loader": "^4.2.0",
|
||||
"husky": "^3.0.7",
|
||||
"jest": "^24.9.0",
|
||||
"jest-junit": "^8.0.0",
|
||||
"lint-staged": "^9.4.0",
|
||||
"prettier": "^1.18.2",
|
||||
"standard-version": "^7.0.0",
|
||||
"supertest": "^4.0.2",
|
||||
"webpack": "^4.41.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 6"
|
||||
},
|
||||
"files": [
|
||||
"lib",
|
||||
"index.js"
|
||||
],
|
||||
"homepage": "https://github.com/webpack/webpack-dev-middleware",
|
||||
"keywords": [
|
||||
"webpack",
|
||||
"middleware",
|
||||
"develompent"
|
||||
],
|
||||
"license": "MIT",
|
||||
"main": "index.js",
|
||||
"name": "webpack-dev-middleware",
|
||||
"peerDependencies": {
|
||||
"webpack": "^4.0.0"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/webpack/webpack-dev-middleware.git"
|
||||
},
|
||||
"scripts": {
|
||||
"commitlint": "commitlint --from=master",
|
||||
"defaults": "webpack-defaults",
|
||||
"lint": "eslint --cache lib test",
|
||||
"pretest": "npm run lint",
|
||||
"release": "standard-version",
|
||||
"security": "npm audit",
|
||||
"test": "npm run test:coverage",
|
||||
"test:coverage": "npm run test:only -- --coverage",
|
||||
"test:only": "jest",
|
||||
"test:watch": "npm run test:only --watch"
|
||||
},
|
||||
"version": "3.7.2"
|
||||
}
|
||||
Reference in New Issue
Block a user