Apache OpenWhisk wskdebug 使用教程

Apache OpenWhisk wskdebug 使用教程

openwhisk-wskdebugDebugging and live development tool for Apache OpenWhisk项目地址:https://gitcode.com/gh_mirrors/op/openwhisk-wskdebug

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

Apache OpenWhisk wskdebug 是一个用于开发和调试 OpenWhisk 动作的命令行工具。以下是项目的目录结构及其介绍：

openwhisk-wskdebug/
├── bin/
│   ├── wskdebug.js
│   └── ...
├── lib/
│   ├── agent.js
│   ├── debugger.js
│   └── ...
├── test/
│   ├── integration/
│   ├── unit/
│   └── ...
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── ...

• bin/: 包含可执行文件，如 wskdebug.js。
• lib/: 包含项目的主要逻辑文件，如 agent.js 和 debugger.js。
• test/: 包含项目的测试文件，分为集成测试和单元测试。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .npmignore: 指定 npm 包发布时忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• package.json: 项目的 npm 配置文件，包含依赖项、脚本等信息。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，主要文件是 wskdebug.js。这个文件是命令行工具的入口点，负责初始化和启动 wskdebug 工具。

#!/usr/bin/env node

const { main } = require('../lib/main');

main();

• #!/usr/bin/env node: 指定使用 Node.js 运行此脚本。
• const { main } = require('../lib/main'): 引入主逻辑模块。
• main(): 调用主逻辑模块的 main 函数，启动工具。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json，它包含了项目的元数据和依赖项。以下是 package.json 的主要内容：

{
  "name": "@openwhisk/wskdebug",
  "version": "1.4.0",
  "description": "A command line tool to develop and debug OpenWhisk actions",
  "main": "lib/main.js",
  "bin": {
    "wskdebug": "bin/wskdebug.js"
  },
  "scripts": {
    "test": "npm run test:unit && npm run test:integration",
    "test:unit": "mocha test/unit/**/*.test.js",
    "test:integration": "mocha test/integration/**/*.test.js"
  },
  "dependencies": {
    "chalk": "^4.1.0",
    "commander": "^6.2.0",
    "debug": "^4.3.1",
    "express": "^4.17.1",
    "http-proxy": "^1.18.1",
    "openwhisk": "^3.21.2",
    "socket.io": "^4.0.0",
    "ws": "^7.4.2"
  },
  "devDependencies": {
    "chai": "^4.2.0",
    "mocha": "^8.2.1",
    "sinon": "^9.2.4"
  },
  "license": "Apache-2.0"
}

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的主入口文件。
• bin: 指定可执行文件的路径。
• scripts: 定义项目的脚本命令，如测试脚本。
• dependencies: 项目的运行时依赖。
• devDependencies: 项目的开发依赖。
• license: 项目的许可证。

以上是 Apache OpenWhisk wskdebug 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

openwhisk-wskdebugDebugging and live development tool for Apache OpenWhisk项目地址:https://gitcode.com/gh_mirrors/op/openwhisk-wskdebug