首页 > 其他分享 >ssts-hospital-web-master:项目开发规范

ssts-hospital-web-master:项目开发规范

时间:2024-02-21 12:44:36浏览次数:18  
标签:web 插件 文件 ssts hospital Prettier ESLint 代码 prettier

  在企业项目开发中,通常由多人一起协作完成开发任务,每个人编写的代码风格可能不统一。为了避免出现问题,一般会制定一些规范来约束整个项目的编码风格,包括编辑器规范、代码格式规范、编写代码规范、Git提交规范、命名规范等。这些规范可以帮助团队保持一致的代码风格,提高代码的可读性和可维护性。

 

1.统一IDE编码格式

使用不同的IDE编辑器编写代码时,由于各编辑器的默认配置不同,可能会导致同一项目的代码风格不一致。为了解决这个问题,可以使用EditorConfig工具来统一项目的代码格式,具体的使用步骤如下。

(1)在项目的根目录下新建.editorconfig文件,代码如下所示:

# 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

(2)VS Code 需要安装一个插件:EditConfig for VS Code。

(3)在任意文件中添加后,查看是否始终在文件末尾插入新行,如果是,则代表统一了 IDE 编码风格。

 

2.Prettier格式化代码

  Prettier是一款强大的代码格式化工具,支持大部分前端开发中用到的文件格式,包括JavaScript、TypeScript、CSS、Scss、Less、JSX、JSON、Angular、Vue.js和React等。

  Prettier能够自动识别代码的格式,并将其转换为一致的风格。目前,Prettier是前端领域最受欢迎的代码格式工具之一。以下是在项目中集成Prettier工具的步骤。

  第一步:安装Prettier。

   npm install prettier @2.7.1 -D #本书安装的版本是2.7.1

   npm install prettier @lastest -D #安装最新版本

  第二步,配置.prettierrc文件。

  在项目的根目录下新建.prettierrc文件,代码如下所示:

{
"useTabs": false,
"tabWidth": 2,
"printWidth": 80,
"singleQuote": true,
"trailingComma": "none",
"semi": false
}

  该配置文件中各个选项的作用如下。

  ● useTabs:是否使用Tab缩进,选择false表示使用空格缩进。

  ● tabWidth:当使用空格缩进时,一个Tab占几个空格,选择2。

  ● printWidth:一行字符的最大长度,推荐设置为80,也有人习惯设置为100或者120。

  ● singleQuote:使用单引号还是双引号,选择true,表示使用单引号。

  ● trailingComma:是否添加多行输入的尾逗号。

  ● semi:语句末尾是否加分号,默认为true,表示添加。

  第三步:创建.prettierignore文件

  在项目根目录下新建.prettierignore文件,用于指定哪些文件无需用Prettier进行格式化,代码如下所示:

/dist/* .local .output.js /node_modules/**
**/*.svg **/*.sh
/public/*     第四步:VS Code需要安装Prettier Code formatter插件。
  第五步:验证Prettier是否生效。   (1)保存代码,观察JavaScript中的双引号是否会被转成单引号。如果会,则代表配置成功;如果不会,那么可以在setting.json文件(%APPDATA%\Code\User\settings.json)中增加如下配置: "editor.formatOnSave": true "editor.defaultFormatter": "esbenp.prettier-vscode", "[javascript]": {   "editor.defaultFormatter": "esbenp.prettier-vscode" } "[typescript]": {   "editor.defaultFormatter": "esbenp.prettier-vscode" }   (2)配置一次性格式化所有代码的命令。 "scripts": {   "prettier": "prettier --write ." }   执行“npm run prettier”命令,查看是否会格式化所有的代码,如果会,则代表配置成功。   3.ESLint检测代码

  ESLint 是一款 JavaScript 代码检査工具,可以帮助开发者避免编写低质量代码,制定适合自己团队的规范,并能检测代码中的潜在错误和不安全的写法。

  以下是在项目中集成 ESLint 工具的步骤。
  (1)配置 ESLint 环境。在创建项目时选择 ESLint, 这样 Vue CLI会默认配置好 ESLint 环境。
  (2)VS Code 需要安装 ESLint 插件。
  (3)解决 Eslint 和 Prettier 冲突的问题,需要安装两个插件。其实,在创建项目时,我们已选择了 Prettier,因此下面这两个插件会自动安装好。
  npm i [email protected] [email protected] -D #已默认安装
  (4)在项目根目录的.eslintrc 文件的 extends 属性中添加 Prettier 插件,代码如下所示:

extends: [

  'plugin:prettier/recommended' # 该插件解决 ESLint 和 Prettier 的冲突,如默认有,则无须添加

]

翻译

搜索

复制

<iframe height="240" width="320"></iframe>

标签:web,插件,文件,ssts,hospital,Prettier,ESLint,代码,prettier
From: https://www.cnblogs.com/lizhigang/p/18024868

相关文章

  • ssts-hospital-web-master项目实战记录三:主要配置
    记录时间:2024-02-211.配置浏览器自动打开配置文件:package.json "scripts":{  "dev":"vite--open" } 2.配置src别名(1)安装@types/node输入npm命令npmi@types/node--save-dev(2)配置文件:vite.config.tsimport{defineConfig}from'vite&#......
  • 关于WebServer例程的使用
    关于WebServer例程,该例程主要实现通过网页对WCHNET网络参数的配置以及用户名密码的管理,关于该例程的使用,具体如下:首先,关于HTTPS.c文件中,以下几个数组数据需要注意一下,如下图:其中:01,02,03,04,05,06表示的是单片机网络通信的MAC地址,此处建议在使用例程时将第一个字节改为02......
  • ssts-hospital-web-master项目实战记录二:版本管理-git
    记录时间:2024-02-211.VSCode打开项目(1)文件→打开文件夹,对应的英文为File→OpenFolder(2)打开效果如下 2.VSCode本地项目托管 (1)打开终端:Terminal→NewTerminal(2)生成仓库:git init输入 git命令git init (3)添加到暂存区:git add.输入 git命令git add. (4)提......
  • ssts-hospital-web-master项目实战记录一:创建项目
    记录日期:2024-02-211.找到存放项目的文件夹,打开cmd命令 2.使用官方脚手架Vite创建项目(1)输入npm命令npmcreatevite@latest(2)输入项目名称:ssts-hospital-web-master (3)选择框架:Vue (4)选择变体(使用的编程语言):TypeScript(5)构建完成,提示我们用三行命令进行接下来的操作,......
  • 开始学习web-sql注入
    web内容多且杂,不知道怎么下手开始学,那就先从sql注入开始学吧目前只在b站上找了一些课程,还有ctfwiki作为参考链接贴在下面:ctfwikihttps://www.bilibili.com/video/BV1c34y1h7So/?spm_id_from=333.337.search-card.all.click&vd_source=27b6c7c9811379b1cf1a595591fa3086要是能......
  • 熟悉又陌生的JavaWeb 第1天
    传送门JavaWeb开发环境配置简单项目,其实我更推荐pom引入Jetty的方式B/S结构B-BrowserS-ServerWeb编程语言CGI、PHP、JSP、ASP服务器安装IDE安装第一个Web项目推荐自己手动建立webapp目录,从空项目建立webapp关于创建webapp项目理想中的默认方式IDEA创建Webapp......
  • webrtc终极版(三)将官方的demo部署到自己的服务器中
    webrtc终极版(三)将官方的demo部署到自己的服务器中本节,我们详细介绍下,如何再本地搭建RTCMultiConnection服务目录webrtc终极版(三)将官方的demo部署到自己的服务器中前言一、安装步骤1.下载并解压文件2.使用npm安装总结前言webrtc终极版系列,再年前,写了前两篇,还剩下两篇没有写,......
  • err code 90030,err msg webhook over limit
    钉钉群机器人发文本消息提示"webhookoverlimit"从2024.02.01钉钉修改了自定义机器人推送政策,免费额度,由之前的不限制,改为:目前钉钉已经限制了免费版的发送次数每个企业每月5000条(之前创建的外部群不限制,但是已经不能新增机器人了。)。钉钉收费版是9800元每年,然后每月5w条(如果......
  • c#使用webView2 访问本地静态html资源跨域问题 || Cors
    背景在浏览器中访问本地静态资源html网页时,可能会遇到跨域问题如图。 是因为浏览器默认启用了同源策略,即只允许加载与当前网页具有相同源(协议、域名和端口)的内容。WebView2默认情况下启用了浏览器的同源策略,即只允许加载与主机相同源的内容。所以如果我们把静态资源发布到ii......
  • 分享二十个web前端开发日常必备网站
    TNTWeb-全称腾讯新闻前端团队,组内小伙伴在Web前端、NodeJS开发、UI设计、移动APP等大前端领域都有所实践和积累。目前团队主要支持腾讯新闻各业务的前端开发,业务开发之余也积累沉淀了一些前端基础设施,赋能业务提效和产品创新。团队倡导开源共建,拥有各种技术大牛,团队Github地......