Edge.js 开源项目教程

1. 项目的目录结构及介绍

Edge.js 项目的目录结构如下：

edge-js/
├── build/
├── lib/
├── src/
│   ├── edge.js
│   ├── edge.ts
│   ├── index.d.ts
│   ├── index.js
│   ├── index.ts
│   ├── native/
│   ├── node-addon-api/
│   ├── tsconfig.json
│   └── webpack.config.js
├── test/
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• build/: 包含编译后的文件。
• lib/: 包含项目的主要库文件。
• src/: 包含项目的源代码文件。
  • edge.js 和 edge.ts: Edge.js 的核心文件。
  • index.d.ts 和 index.js: 项目的入口文件。
  • native/: 包含与本地代码相关的文件。
  • node-addon-api/: 包含 Node.js 的附加 API。
  • tsconfig.json: TypeScript 配置文件。
  • webpack.config.js: Webpack 配置文件。
• test/: 包含项目的测试文件。
• .gitignore: Git 忽略文件。
• .npmignore: npm 忽略文件。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• package.json: 项目的 npm 配置文件。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

Edge.js 项目的启动文件是 src/index.js 和 src/index.ts。这两个文件是项目的入口点，负责初始化和启动 Edge.js 的核心功能。

src/index.js

const edge = require('./edge');
module.exports = edge;

src/index.ts

import edge from './edge';
export default edge;

这两个文件都导入了 edge.js 或 edge.ts 文件，并将其作为模块导出，以便其他模块可以使用 Edge.js 的功能。

3. 项目的配置文件介绍

Edge.js 项目的主要配置文件包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的元数据和依赖项信息。以下是一些关键字段：

{
  "name": "edge-js",
  "version": "14.13.0",
  "description": "Edge.js: run .NET and Node.js in-process on Windows, Mac OS, and Linux",
  "main": "src/index.js",
  "types": "src/index.d.ts",
  "scripts": {
    "build": "npm run clean && npm run compile",
    "clean": "rimraf build lib",
    "compile": "tsc -p .",
    "test": "mocha --reporter spec --timeout 10000"
  },
  "dependencies": {
    "node-addon-api": "^3.0.0"
  },
  "devDependencies": {
    "mocha": "^8.1.3",
    "rimraf": "^3.0.2",
    "typescript": "^4.0.3"
  },
  "keywords": [
    "edge",
    "js",
    "dotnet",
    "core",
    "clr",
    "node",
    "node.js",
    "nodejs",
    "javascript",
    "c#",
    "csharp",
    "f#",
    "fsharp",
    "python",
    "ruby",
    "powershell",
    "bash",
    "shell",
    "scripting",
    "interop",
    "native",
    "addon",
    "binding",
    "extension",
    "module"
  ],
  "author": "Tomasz Janczuk <t