uRequire 技术文档

1. 安装指南

1.1 环境要求

• Node.js
• npm

1.2 安装命令

在命令行中执行以下命令全局安装 uRequire：

npm install urequire-cli -g

然后，在你的项目本地安装 uRequire：

npm install urequire

2. 项目使用说明

uRequire 是一个用于转换 JavaScript 模块和资源的工具，支持多种模块系统，如 AMD、CommonJS 和 UMD。以下是基本使用步骤：

2.1 配置文件

创建一个名为 urequire.json 的配置文件，在其中定义项目的配置，例如模块路径、依赖关系、资源转换等。

{
  "paths": {
    "src": "src",
    "dist": "dist"
  },
  "dependencies": {
    "lodash": ["_"]
  },
  "resources": {
    "import-keys": {
      "chai": "expect"
    }
  }
}

2.2 构建项目

在项目根目录下运行以下命令构建项目：

urequire build

这将根据配置文件中的设置，编译、转换和打包项目中的模块。

2.3 监听文件变化

可以使用以下命令启动文件监听，自动重新构建项目：

urequire watch

3. 项目 API 使用文档

uRequire 提供了丰富的 API，以下是一些常用的 API 调用示例：

3.1 编译模块

const uRequire = require('urequire');
const compiler = uRequire.createCompiler({
  // 配置项
});
compiler.compile('src/module.js', (err, result) => {
  if (err) throw err;
  console.log(result);
});

3.2 转换资源

const uRequire = require('urequire');
const converter = uRequire.createConverter({
  // 配置项
});
converter.convert('src/resource.json', (err, result) => {
  if (err) throw err;
  console.log(result);
});

3.3 注入版本号

const uRequire = require('urequire');
const injector = uRequire.createInjector({
  // 配置项
});
injector.injectVersion('src/main.js', (err, result) => {
  if (err) throw err;
  console.log(result);
});

4. 项目安装方式

如前所述，项目可以通过 npm 进行安装。首先确保你的系统中已安装 Node.js 和 npm，然后执行以下命令：

npm install urequire-cli -g  # 全局安装
npm install urequire         # 本地安装

安装完成后，你可以通过 urequire 命令使用 uRequire 提供的功能。