Eruda 开源项目使用教程

Eruda 开源项目使用教程

erudaConsole for mobile browsers项目地址:https://gitcode.com/gh_mirrors/er/eruda

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

Eruda 项目的目录结构如下：

eruda/
├── docs/
├── scripts/
├── src/
│   ├── css/
│   ├── js/
│   └── index.js
├── test/
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── webpack.config.js

目录介绍

• docs/: 包含项目的文档文件。
• scripts/: 包含项目的脚本文件。
• src/: 项目的源代码目录，包含 CSS、JavaScript 文件以及入口文件 index.js。
• test/: 包含项目的测试文件。
• .gitignore: Git 忽略文件列表。
• .npmignore: npm 忽略文件列表。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

Eruda 的启动文件是 src/index.js。这个文件是项目的入口点，负责初始化 Eruda 控制台。

// src/index.js
import Eruda from './js/Eruda';
import * as tools from './js/tools';

Eruda.setConfig({
    tool: ['console', 'elements']
});

Eruda.init({
    container: document.createElement('div'),
    tool: Object.keys(tools)
});

启动文件功能

• 导入 Eruda 核心模块和工具模块。
• 设置 Eruda 的配置，包括启用的工具。
• 初始化 Eruda 控制台。

3. 项目的配置文件介绍

Eruda 的配置文件主要包括 package.json 和 webpack.config.js。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "eruda",
  "version": "2.4.1",
  "description": "Console for mobile browsers",
  "main": "eruda.js",
  "scripts": {
    "build": "webpack",
    "dev": "webpack --watch",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/liriliri/eruda.git"
  },
  "keywords": [
    "console",
    "mobile",
    "debug"
  ],
  "author": "redhoodsu",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/liriliri/eruda/issues"
  },
  "homepage": "https://github.com/liriliri/eruda#readme",
  "devDependencies": {
    "webpack": "^4.44.2",
    "webpack-cli": "^3.3.12"
  }
}

webpack.config.js

webpack.config.js 文件是 Webpack 的配置文件，用于打包项目。

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    filename: 'eruda.js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      },
      {
        test: /\.scss$/,
        use: [
          'style-loader',
          'css-loader',
          'sass-loader'
        ]
      }
    ]
  }
};

配置文件功能

• package.json: 管理项目的依赖和脚本。
• webpack.config.js: 配置 Webpack 打包规则和输出路径。

以上是 Eruda

erudaConsole for mobile browsers项目地址:https://gitcode.com/gh_mirrors/er/eruda