Resugar 项目教程

Resugar 项目教程

resugar Rewrite your JavaScript & TypeScript source code with sweet new features. 项目地址: https://gitcode.com/gh_mirrors/re/resugar

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

Resugar 项目的目录结构如下：

resugar/
├── circleci/
├── github/
├── vscode/
├── packages/
├── script/
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .npmrc
├── .prettierrc
├── LICENSE
├── README.md
├── jest.config.js
├── lerna.json
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构介绍

• circleci/: 包含 CircleCI 的配置文件。
• github/: 包含 GitHub 相关的配置文件。
• vscode/: 包含 Visual Studio Code 的配置文件。
• packages/: 包含项目的各个子包。
• script/: 包含项目的脚本文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .npmrc: npm 配置文件。
• .prettierrc: Prettier 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• jest.config.js: Jest 测试框架的配置文件。
• lerna.json: Lerna 多包管理工具的配置文件。
• package.json: 项目的 npm 配置文件。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

Resugar 项目的启动文件主要是 package.json 中的 scripts 部分。以下是一些关键的启动命令：

{
  "scripts": {
    "start": "node index.js",
    "test": "jest",
    "build": "tsc"
  }
}

启动命令介绍

• start: 启动项目的入口文件 index.js。
• test: 使用 Jest 运行测试。
• build: 使用 TypeScript 编译项目。

3. 项目的配置文件介绍

.eslintrc

ESLint 配置文件，用于定义代码风格和规则：

{
  "extends": "eslint:recommended",
  "rules": {
    "no-console": "off"
  }
}

jest.config.js

Jest 测试框架的配置文件，用于定义测试环境和其他测试相关配置：

module.exports = {
  testEnvironment: 'node',
  coveragePathIgnorePatterns: [
    "/node_modules/"
  ]
};

lerna.json

Lerna 多包管理工具的配置文件，用于管理多个 npm 包：

{
  "packages": [
    "packages/*"
  ],
  "version": "0.0.0"
}

tsconfig.json

TypeScript 配置文件，用于定义 TypeScript 编译选项：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true
  }
}

package.json

项目的 npm 配置文件，包含项目的依赖、脚本和其他元数据：

{
  "name": "resugar",
  "version": "1.0.0",
  "dependencies": {
    "typescript": "^4.0.0"
  },
  "devDependencies": {
    "jest": "^26.0.0"
  }
}

通过以上配置文件，可以对 Resugar 项目进行开发、测试和构建。

resugar Rewrite your JavaScript & TypeScript source code with sweet new features. 项目地址: https://gitcode.com/gh_mirrors/re/resugar