Prettier-ESLint 项目教程

Prettier-ESLint 项目教程

【免费下载链接】prettier-eslint Code :arrow_right: prettier :arrow_right: eslint --fix :arrow_right: Formatted Code :sparkles: 项目地址: https://gitcode.com/gh_mirrors/pr/prettier-eslint

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

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

prettier-eslint/
├── bin/
│   └── prettier-eslint.js
├── src/
│   ├── index.js
│   ├── format.js
│   ├── logger.js
│   └── utils.js
├── test/
│   ├── format.test.js
│   └── utils.test.js
├── .eslintrc.js
├── .prettierrc
├── package.json
└── README.md

目录结构介绍

• bin/：包含可执行文件，如 prettier-eslint.js。
• src/：包含项目的主要源代码文件。
  • index.js：项目的入口文件。
  • format.js：格式化代码的逻辑。
  • logger.js：日志记录功能。
  • utils.js：工具函数。
• test/：包含测试文件。
  • format.test.js：格式化代码的测试。
  • utils.test.js：工具函数的测试。
• .eslintrc.js：ESLint 配置文件。
• .prettierrc：Prettier 配置文件。
• package.json：项目的依赖和脚本配置。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 bin/prettier-eslint.js。这个文件是可执行文件，用于启动 Prettier-ESLint 工具。

启动文件内容概述

#!/usr/bin/env node

const meow = require('meow');
const format = require('../src/format');

const cli = meow(`
  Usage
    $ prettier-eslint <text>
    $ echo <text> | prettier-eslint

  Options
    --write              Edit the file in-place
    --stdin              Read input from stdin
    --eslint-path        Path to eslint
    --prettier-path      Path to prettier
    --prettier-last      Run prettier last
    --log-level          Set the log level (silent, error, warn, info, debug)

  Examples
    $ prettier-eslint "var foo = bar;"
    $ echo "var foo = bar;" | prettier-eslint
`, {
  flags: {
    write: {
      type: 'boolean',
      default: false,
    },
    stdin: {
      type: 'boolean',
      default: false,
    },
    'eslint-path': {
      type: 'string',
      default: 'eslint',
    },
    'prettier-path': {
      type: 'string',
      default: 'prettier',
    },
    'prettier-last': {
      type: 'boolean',
      default: false,
    },
    'log-level': {
      type: 'string',
      default: 'warn',
    },
  },
});

format(cli.input[0], cli.flags).then(result => {
  console.log(result);
});

启动文件功能

• 使用 meow 库解析命令行参数。
• 调用 src/format.js 中的 format 函数进行代码格式化。
• 根据命令行参数配置格式化选项。

3. 项目的配置文件介绍

.eslintrc.js

ESLint 配置文件，用于配置 ESLint 的规则和插件。

module.exports = {
  parser: 'babel-eslint',
  extends: [
    'eslint:recommended',
    'plugin:prettier/recommended',
  ],
  plugins: [
    'prettier',
  ],
  rules: {
    'prettier/prettier': 'error',
  },
};

.prettierrc

Prettier 配置文件，用于配置 Prettier 的格式化规则。

{
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80,
  "tabWidth": 2
}

`

【免费下载链接】prettier-eslint Code :arrow_right: prettier :arrow_right: eslint --fix :arrow_right: Formatted Code :sparkles: 项目地址: https://gitcode.com/gh_mirrors/pr/prettier-eslint