Skip to content

fex-team/fis3-hook-commonjs

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

fis3-hook-commonjs

fis3 已经默认不自带模块化开发支持,那么如果需要采用 commonjs 规范作为模块化开发,请使用此插件。

请配合 mod.js 一起使用。

注意:需要对目标文件设置 isMod 属性,说明这些文件是模块化代码。

fis.match('/modules/**.js', {
  isMod: true
})

这样才会被自动包装成 amd,才能在浏览器里面运行(当然还得依靠 mod.js)。

另外,所有 isModtrue 的文件都会被包裹成 AMD, 如果不想包裹,请设置 wrap 属性为 false

设置了 isMod 为 true 的文件可以在 js 里面直接通过 require('文件路径') 的方式来使用,支持相对路径和绝对路径。

var $ = require('/static/lib/jquery.js');

require('./index.js');

如果存在部分模块化文件不是以 commonjs 规范编写的,该插件可以通过配置文件属性 umd2commonjs 尝试兼容。

fis.match('/node_modules/echarts/**.js', {
  umd2commonjs: true
})

同时某些 js 内部有很多 require 的用法,如果希望 fis 忽略这部分依赖,可以设置 ignoreDependencies 如:

fis.match('/node_modules/echarts/**.js', {
  ignoreDependencies: true
})

自定义模块ID

插件默认使用资源的绝对路径作为模块ID,如果希望更改模块ID,需要对目标文件设置 moduleId 属性

fis.match('/modules/(**).js', {
  isMod: true,
  moduleId: '$1'
})

通过上述配置,我们可以将 /modules/A.js 的模块ID由 modules/A 改变为 A

安装

全局安装或者本地安装都可以。

npm install -g fis3-hook-commonjs

或者

npm install fis3-hook-commonjs

用法

在 fis-conf.js 中加入以下代码。

fis.hook('commonjs', {
  // 配置项
});

注意

虽然支持 paths 和 packages 设置,目的主要是为了迁移代码用的,从零开发,推荐直接使用 require('文件路径') 的方式,更简单明了。

配置项

以下所有配置都是可选配置。简单使用可以跳过。

  • baseUrl 默认为 . 即项目根目录。用来配置模块查找根目录。

  • paths 用来设置别名,路径基于 baseUrl 设置。

    fis.hook('commonjs', {
      paths: {
        $: '/modules/jquery/jquery-1.11.2.js'
      }
    });
  • packages 用来配置包信息,方便项目中引用。

    fis.hook('commonjs', {
      packages: [
        {
          name: 'foo',
          location: './modules/foo',
          main: 'index.js'
        }
      ]
    });
    • require('foo') 的时候等价于 require('/modules/foo/index.js').
    • require('foo/a.js') 的时候,等价于 require('/modules/foo/a.js').
  • forwardDeclaration 默认为 false, 用来设置是否开启依赖前置,根据前端加载器来定,mod.js 是不需要的。

  • skipBuiltinModules 默认为 true, 只有在 forwardDeclaration 启动的时候才有效,用来设置前置依赖列表中是否跳过内置模块如: require, module, exports

  • extList 默认为 ['.js', '.coffee', '.jsx', '.es6'],当引用模块时没有指定后缀,该插件会尝试这些后缀。

  • tab 默认为 2, 用来设置包裹时,内容缩进的空格数。

  • ignoreDependencies 默认为 空,用来忽略掉对某些资源 require,一般用来忽略掉内部实现的 require 资源。

    fis.hook('commonjs', {
      // 忽略 angular2 的依赖。我自己负责加载需要资源。
      ignoreDependencies: [
        'angular2/**',
      ]
    });