Prettier-Standard 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00031/article/details/138947538

Prettier-Standard 项目教程

prettier-standard Formats with Prettier and lints with ESLint+Standard! (✿◠‿◠) 项目地址: https://gitcode.com/gh_mirrors/pr/prettier-standard

1. 项目目录结构及介绍

Prettier-Standard 项目的目录结构如下：

prettier-standard/
├── src/
│   └── ...
├── test/
│   └── ...
├── .all-contributorsrc
├── .eslintignore
├── .gitignore
├── .npmignore
├── .npmrc
├── .prettierignore
├── .travis.yml
├── .yarnignore
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

目录结构介绍

src/: 存放项目的源代码文件。
test/: 存放项目的测试代码文件。
.all-contributorsrc: 配置文件，用于管理项目的贡献者列表。
.eslintignore: 配置文件，用于指定 ESLint 忽略的文件或目录。
.gitignore: 配置文件，用于指定 Git 忽略的文件或目录。
.npmignore: 配置文件，用于指定 npm 发布时忽略的文件或目录。
.npmrc: 配置文件，用于指定 npm 的配置选项。
.prettierignore: 配置文件，用于指定 Prettier 忽略的文件或目录。
.travis.yml: 配置文件，用于 Travis CI 的持续集成配置。
.yarnignore: 配置文件，用于指定 Yarn 发布时忽略的文件或目录。
LICENSE: 项目的开源许可证文件。
README.md: 项目的说明文档。
package.json: 项目的 npm 配置文件，包含项目的依赖、脚本等信息。
yarn.lock: Yarn 的锁定文件，用于确保依赖版本的稳定性。

2. 项目的启动文件介绍

Prettier-Standard 项目没有传统意义上的“启动文件”，因为它是一个命令行工具，主要通过命令行调用。项目的核心功能是通过 src/ 目录下的代码实现的。

主要启动命令

在 package.json 文件中，定义了项目的启动命令：

{
  "scripts": {
    "format": "prettier-standard --format",
    "lint": "prettier-standard --lint"
  }
}

format: 用于格式化代码。
lint: 用于格式化和检查代码。

3. 项目的配置文件介绍

3.1 `.prettierrc`

.prettierrc 文件用于配置 Prettier 的格式化选项。例如，你可以通过以下配置启用分号：

{
  "semi": true
}

3.2 `.eslintrc`

.eslintrc 文件用于配置 ESLint 的规则。例如，你可以通过以下配置关闭 eqeqeq 规则：

{
  "rules": {
    "eqeqeq": "off"
  }
}

3.3 `.prettierignore`

.prettierignore 文件用于指定 Prettier 忽略的文件或目录。例如：

dist
.next
**/*.ts

3.4 `.eslintignore`

.eslintignore 文件用于指定 ESLint 忽略的文件或目录。例如：

dist
.next
**/*.ts

3.5 `package.json`

package.json 文件包含了项目的依赖、脚本、配置等信息。例如：

{
  "name": "prettier-standard",
  "version": "1.0.0",
  "scripts": {
    "format": "prettier-standard --format",
    "lint": "prettier-standard --lint"
  },
  "devDependencies": {
    "prettier-standard": "^1.0.0"
  }
}