Unibeautify 开源项目教程

Unibeautify 开源项目教程

unibeautifyOne Beautifier to rule them all, One Beautifier to clean them, One Beautifier to bring them all and in the darkness sheen them项目地址:https://gitcode.com/gh_mirrors/un/unibeautify

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

Unibeautify 项目的目录结构如下：

unibeautify/
├── .github/
├── bin/
├── docs/
├── src/
│   ├── beautifiers/
│   ├── config/
│   ├── language-options/
│   ├── options/
│   └── utils/
├── tests/
├── .editorconfig
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录介绍

• .github/: 包含 GitHub 相关的配置文件，如 issue 模板和 pull request 模板。
• bin/: 包含可执行文件。
• docs/: 包含项目文档。
• src/: 包含项目源代码。
  • beautifiers/: 包含各种代码美化器的实现。
  • config/: 包含配置相关的代码。
  • language-options/: 包含语言选项的定义。
  • options/: 包含选项的定义。
  • utils/: 包含工具函数。
• tests/: 包含测试代码。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 变更日志。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证。
• README.md: 项目说明文档。
• package.json: npm 包配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

Unibeautify 项目的启动文件是 src/index.ts。这个文件是项目的入口点，负责初始化和启动 Unibeautify。

// src/index.ts
import Unibeautify from "./unibeautify";
export default Unibeautify;

3. 项目的配置文件介绍

Unibeautify 的配置文件主要包括 package.json 和 tsconfig.json。

package.json

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

{
  "name": "unibeautify",
  "version": "0.17.0",
  "description": "One Beautifier to rule them all, One Beautifier to clean them, One Beautifier to bring them all and in the darkness sheen them",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "cosmiconfig": "^5.2.1",
    "lodash": "^4.17.11"
  },
  "devDependencies": {
    "@types/jest": "^24.0.11",
    "jest": "^24.7.1",
    "ts-jest": "^24.0.2",
    "typescript": "^3.4.3"
  }
}

tsconfig.json

tsconfig.json 文件包含了 TypeScript 编译器的配置。以下是一些关键字段：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": [
    "src/**/*"
  ]
}

以上是 Unibeautify 开源项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Unibeautify。

unibeautifyOne Beautifier to rule them all, One Beautifier to clean them, One Beautifier to bring them all and in the darkness sheen them项目地址:https://gitcode.com/gh_mirrors/un/unibeautify