npm node deps tests coverage chat

1. File Loader

github

指示webpack发出所需的对象作为文件,并返回它的公共URL

1.1. 安装

npm install --save-dev file-loader

1.2. 用法

默认情况下,生成的文件的文件名就是文件内容的 MD5 哈希值,并会保留所请求资源的原始扩展名。

import img from './file.png'

webpack.config.js

module.exports = {
  module: {
    rules: [
      {
        test: /\.(png|jpg|gif)$/,
        use: [
          {
            loader: 'file-loader',
            options: {}  
          }
        ]
      }
    ]
  }
}

发射 file.png 作为一个文件到输出目录,并返回一个公共路径。

"/public/path/0dcbbaa7013869e351f.png"
// 文件名为hash值
// 扩展名与原始文件保持一致

1.3. 选项

名称 类型 默认值 描述
name `{String\ Function}` [hash].[ext] 为文件配置一个自定义的文件名模板
context {String} this.options.context 配置自定义的文件名上下文, 默认为 webpack.config.js context
publicPath `{String\ Function}` __webpack_public_path__ 为文件配置一个自定义 public 路径
outputPath `{String\ Function}` 'undefined' 为文件配置一个自定义output 路径
useRelativePath {Boolean} false 如果你希望为每一个文件生成一个相对于URL的context,应该设置为true
emitFile {Boolean} true 默认情况下,文件会被发射,但是需要,可以将它禁用(例如,使用了服务器端的package)

1.3.1. name

可以使用查询参数name为您的文件配置一个自定义的文件名模板。例如,将一个文件从您的context目录复制到输出目录中,保留完整的目录结构,可能会使用

{String}

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name: '[path][name].[ext]'
  }  
}

{Function}

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name (file) {
      if (env === 'development') {
        return '[path][name].[ext]'
      }

      return '[hash].[ext]'
    }
  }  
}

placeholders

名称 类型 默认值 描述
[ext] {String} file.extname 资源的扩展
[name] {String} file.basename 资源的basename
[path] {String} file.dirname 资源相对于 context的路径
[hash] {String} md5 内容的hash,下面是更多信息
[N] {Number} `` n-th匹配 从匹配当前文件名与查询参数 regExp获得的东西

hashes

[<hashType>:hash:<digestType>:<length>] 你也可以选择配置

名称 类型 默认值 描述
hashType {String} md5 sha1, md5, sha256, sha512
digestType {String} base64 hex, base26, base32, base36, base49, base52, base58, base62, base64
length {Number} 8 字符的长度

默认情况下,您指定的路径和名称将在同一个目录中输出该文件,并将使用相同的URL路径来访问该文件。

1.3.2. context

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name: '[path][name].[ext]',
    context: ''
  }  
}

你可以使用outputPath, publicPathuseRelativePath来指定自定义的outputpublic路径。

1.3.3. publicPath

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name: '[path][name].[ext]',
    publicPath: 'assets/'
  }  
}

1.3.4. outputPath

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name: '[path][name].[ext]',
    outputPath: 'images/'
  }  
}

1.3.5. useRelativePath

如果您希望为每个文件上下文生成一个相对URL,useRelativePath 应该是true

{
  loader: 'file-loader',
  options: {
    useRelativePath: process.env.NODE_ENV === "production"
  }
}

1.3.6. emitFile

默认情况下文件是被发射的,但是如果需要,这是可以被禁用的(例如,对于服务器端的package)。

import img from './file.png'
{
  loader: 'file-loader',
  options: {
    emitFile: false
  }  
}

⚠️ 返回公共URL,但发出文件

`${publicPath}/0dcbbaa701328e351f.png`

1.4. 示例

import png from 'image.png'

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name: 'dirname/[hash].[ext]'
  }  
}
dirname/0dcbbaa701328ae351f.png

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name: '[sha512:hash:base64:7].[ext]'
  }  
}
gdyb21L.png
import png from 'path/to/file.png'

webpack.config.js

{
  loader: 'file-loader',
  options: {
    name: '[path][name].[ext]?[hash]'
  }  
}
path/to/file.png?e43b20c069c4a01867c31e98cbce33c9

1.5. 贡献者


Juho Vepsäläinen

Joshua Wiens

Michael Ciniawsky

Alexander Krasnoyarov
Copyright © tuzhu008 2017 all right reserved,powered by Gitbook该文件修订时间: 2017-11-24 09:23:47

results matching ""

    No results matching ""