react+ts项目搭建

leon96
381 阅读3分钟

开启掘金成长之旅！这是我参与「掘金日新计划 · 12 月更文挑战」的第4天

1、使用creact-react-app创建react+ts项目

creact-react-app默认没有typescript，需要加--template typescript才有

npx creact-react-app 项目名 --template typescript

image.png

2、设置别名

一旦文件层级很多的话，很容易出现../../文件的情况。这个时候需要设置别名

image.png 2.1、设置方式：

  1. react是基于webpack的，是可以通过npm run eject暴露webpack配置文件修改（不推荐）
  2. 使用craco库（推荐）

2.1.1、安装craco库

  1. 执行npm i @craco/craco@alpha - D
  2. 创建craco.config.js，让react能识别
const path = require('path')
const resolve = (dir) => path.resolve(__dirname, dir)
// 添加less
const CracoLessPlugin = require('craco-less')

module.exports = {
  webpack: {
    alias: {
      '@': resolve('src')
    }
  },
  plugins: [
    {
      plugin: CracoLessPlugin
    }
  ]
}

3.在tsconfig.json的compilerOptions添加baseUrl、paths，让ts能识别防止报错

// tsconfig.json当前文件路径
"baseUrl": ".",
"paths": {
   // @/*下的文件代表着src/*文件
  "@/*": ["src/*"]
}

image.png 4.修改package.json中的scripts语句 image.png

3、代码规范

3.1、集成editorconfig配置

EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。

# http://editorconfig.org

root = true

[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格（tab | space）
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行尾的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行

[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

VSCode需要安装一个插件：EditorConfig for VS Code

image-20210722215138665

3.2、 使用prettier工具

Prettier 是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。

1.安装prettier

npm install prettier -D

2.配置.prettierrc文件：

  • useTabs：使用tab缩进还是空格缩进，选择false；
  • tabWidth：tab是空格的情况下，是几个空格，选择2个；
  • printWidth：当行字符的长度，推荐80，也有人喜欢100或者120；
  • singleQuote：使用单引号还是双引号，选择true，使用单引号；
  • trailingComma：在多行输入的尾逗号是否添加，设置为 none，比如对象类型的最后一个属性后面是否加一个，；
  • semi：语句末尾是否要加分号，默认值true，选择false表示不加；
{
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": true,
  "trailingComma": "none",
  "semi": false
}

3.创建.prettierignore忽略文件

/dist/*
.local
.output.js
/node_modules/**

**/*.svg
**/*.sh

/public/*

4.VSCode需要安装prettier的插件

image-20210722214543454

5.VSCod中的配置

  • settings =>format on save => 勾选上
  • settings => editor default format => 选择 prettier

1665644883500

6.测试prettier是否生效

  • 测试一：在代码中保存代码；
  • 测试二：配置一次性修改的命令；

在package.json中配置一个scripts：

    "prettier": "prettier --write ."

3.3、使用ESLint检测

1.VSCode需要安装ESLint插件：

image-20210722215933360

2.解决eslint和prettier冲突的问题：

安装插件：（vue在创建项目时，如果选择prettier，那么这两个插件会自动安装）

npm install eslint-plugin-prettier eslint-config-prettier -D

添加prettier插件：

  extends: [
    "plugin:vue/vue3-essential",
    "eslint:recommended",
    "@vue/typescript/recommended",
    "@vue/prettier",
    "@vue/prettier/@typescript-eslint",
    'plugin:prettier/recommended'
  ],

3.VSCode中eslint的配置

  "eslint.lintTask.enable": true,
  "eslint.alwaysShowStatus": true,
  "eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact"
  ],
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
avatar
文章
阅读
粉丝