【React】package.json 文件详解

文章目录

    • 一、package.json 文件的基本结构
    • 二、package.json 文件的关键字段
      • 1. name 和 version
      • 2. description
      • 3. main
      • 4. scripts
      • 5. dependencies 和 devDependencies
      • 6. repository
      • 7. keywords
      • 8. author 和 license
      • 9. bugs 和 homepage
    • 三、package.json 文件的高级配置
      • 1. 配置 Babel
      • 2. 配置 ESLint
      • 3. 配置 Browserslist
      • 4. 配置 Husky 和 lint-staged
    • 四、实际应用案例

在任何一个 React 项目中,package.json 文件都是不可或缺的核心配置文件。它不仅记录了项目的基本信息,还管理着项目的依赖、脚本和各种配置。本文将详细介绍 package.json 文件的各个部分,从基础到高级应用,帮助你全面掌握如何有效地配置和管理 React 项目。

一、package.json 文件的基本结构

package.json 文件是一个 JSON 格式的文件,通常位于项目的根目录中。以下是一个典型的 package.json 文件的示例:

{"name": "my-app","version": "1.0.0","description": "A simple React application","main": "index.js","scripts": {"start": "react-scripts start","build": "react-scripts build","test": "react-scripts test","eject": "react-scripts eject"},"dependencies": {"react": "^17.0.2","react-dom": "^17.0.2","react-scripts": "4.0.3"},"devDependencies": {},"repository": {"type": "git","url": "git+https://github.com/yourusername/my-app.git"},"keywords": ["react","application"],"author": "Your Name","license": "MIT","bugs": {"url": "https://github.com/yourusername/my-app/issues"},"homepage": "https://github.com/yourusername/my-app#readme"
}

二、package.json 文件的关键字段

1. name 和 version

name 字段指定了项目的名称,通常使用小写字母和连字符。version 字段表示项目的版本号,遵循语义化版本控制(SemVer)规范。

{"name": "my-app","version": "1.0.0"
}

2. description

description 字段用于简要描述项目的功能和用途。

{"description": "A simple React application"
}

3. main

main 字段指定了项目的入口文件,通常用于库或包的开发。在 React 应用中,这个字段通常不会用到,因为 Webpack 等打包工具会处理入口文件。

{"main": "index.js"
}

4. scripts

scripts 字段定义了一组命令,可以通过 npm run <script-name> 来执行。这些脚本可以用于启动开发服务器、构建项目、运行测试等。

{"scripts": {"start": "react-scripts start","build": "react-scripts build","test": "react-scripts test","eject": "react-scripts eject"}
}

5. dependencies 和 devDependencies

dependencies 字段列出了项目运行时所需的依赖包,而 devDependencies 字段则列出了开发时所需的依赖包。使用 npm install <package-name> 安装的包会默认添加到 dependencies 中,使用 npm install <package-name> --save-dev 安装的包会添加到 devDependencies 中。

{"dependencies": {"react": "^17.0.2","react-dom": "^17.0.2","react-scripts": "4.0.3"},"devDependencies": {}
}

6. repository

repository 字段用于指定项目的代码仓库地址,通常是 Git 仓库的 URL。这有助于其他开发者找到项目的源代码。

{"repository": {"type": "git","url": "git+https://github.com/yourusername/my-app.git"}
}

7. keywords

keywords 字段是一个数组,用于指定与项目相关的关键字,便于在 npm 搜索中找到项目。

{"keywords": ["react","application"]
}

8. author 和 license

author 字段用于指定项目的作者信息,license 字段用于指定项目的许可证类型。

{"author": "Your Name","license": "MIT"
}

9. bugs 和 homepage

bugs 字段用于指定报告项目问题的 URL,homepage 字段用于指定项目的主页 URL。

{"bugs": {"url": "https://github.com/yourusername/my-app/issues"},"homepage": "https://github.com/yourusername/my-app#readme"
}

三、package.json 文件的高级配置

1. 配置 Babel

Babel 是一个 JavaScript 编译器,用于将现代 JavaScript 代码转换为向后兼容的版本。可以在 package.json 文件中配置 Babel。

{"babel": {"presets": ["@babel/preset-env", "@babel/preset-react"]}
}

2. 配置 ESLint

ESLint 是一个静态代码分析工具,用于识别和修复代码中的问题。可以在 package.json 文件中配置 ESLint。

{"eslintConfig": {"extends": ["react-app", "eslint:recommended"],"rules": {"no-unused-vars": "warn","eqeqeq": "error"}}
}

3. 配置 Browserslist

Browserslist 是一个配置工具,用于指定项目支持的浏览器范围。它可以用于 Babel、Autoprefixer 和其他工具,以确保项目的兼容性。

{"browserslist": [">0.2%","not dead","not op_mini all"]
}

4. 配置 Husky 和 lint-staged

Husky 是一个 Git 钩子工具,用于在提交代码之前运行脚本。lint-staged 是一个工具,用于在暂存文件上运行 linters。可以在 package.json 文件中配置它们,以确保提交的代码符合代码规范。

{"husky": {"hooks": {"pre-commit": "lint-staged"}},"lint-staged": {"src/**/*.{js,jsx}": ["eslint --fix","git add"]}
}

四、实际应用案例

以下是一个综合了多种配置的 package.json 文件示例,展示了如何在一个实际项目中进行配置。

{"name": "my-advanced-app","version": "1.0.0","description": "An advanced React application with custom configurations","main": "index.js","scripts": {"start": "react-scripts start","build": "react-scripts build","test": "react-scripts test","eject": "react-scripts eject","lint": "eslint src/**/*.js","format": "prettier --write src/**/*.js"},"dependencies": {"react": "^17.0.2","react-dom": "^17.0.2","react-scripts": "4.0.3"},"devDependencies": {"@babel/core": "^7.14.6","@babel/preset-env": "^7.14.5","@babel/preset-react": "^7.14.5","eslint": "^7.29.0","eslint-plugin-react": "^7.24.0","prettier": "^2.3.2","husky": "^7.0.1","lint-staged": "^11.0.0"},"repository": {"type": "git","url": "git+https://github.com/yourusername/my-advanced-app.git"},"keywords": ["react","application","advanced"],"author": "Your Name","license": "MIT","bugs": {"url": "https://github.com/yourusername/my-advanced-app/issues"},"homepage": "https://github.com/yourusername/my-advanced-app#readme","babel": {"presets": ["@babel/preset-env", "@babel/preset-react"]},"eslintConfig": {"extends": ["react-app", "eslint:recommended"],"rules": {"no-unused-vars": "warn","eqeqeq": "error"}},"browserslist": [">0.2%","not dead","not op_mini all"],"husky": {"hooks": {"pre-commit": "lint-staged"}},"lint-staged": {"src/**/*.{js,jsx}": ["eslint --fix","git add"]}
}

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/383939.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

十、SpringBoot 统⼀功能处理【拦截器、统一数据返回格式、统一异常处理】

十、SpringBoot 统⼀功能处理 1. 拦截器【HandlerInterceptor、WebMvcConfig】1.1 拦截器快速⼊⻔⾃定义拦截器&#xff1a;实现HandlerInterceptor接⼝&#xff0c;并重写其所有⽅法注册配置拦截器&#xff1a;实现WebMvcConfigurer接⼝&#xff0c;并重写addInterceptors⽅法…

压测实操--produce压测方案

作者&#xff1a;九月 环境信息&#xff1a; 操作系统centos7.9&#xff0c;kafka版本为hdp集群中的2.0版本。 Producer相关参数 使用Kafka自带的kafka-producer-perf-test.sh脚本进行压测&#xff0c;该脚本参数为&#xff1a; 在producer涉及到性能的关键因素可能会存在如…

DetectorRS

文章目录 AbstractMethodExperimentAblation StudyMain Results Conclusion未来展望 link code Abstract 本文介绍了一种新的对象检测器——DetectoRS&#xff0c;通过在骨干网络设计中引入递归特征金字塔和可切换的空洞卷积机制&#xff0c;实现了出色的性能提升。在宏观层面…

谷粒商城实战笔记-54-商品服务-API-三级分类-拖拽效果

文章目录 一&#xff0c;54-商品服务-API-三级分类-修改-拖拽效果1&#xff0c;el-tree控件加上允许拖拽的属性2&#xff0c;是否允许拖拽3&#xff0c;完整代码 一&#xff0c;54-商品服务-API-三级分类-修改-拖拽效果 本节的主要内容是给三级分类树形结构加上拖拽功能&#…

四、GD32 MCU 常见外设介绍 (4) EXTI 中断介绍

4.EXTI 中断介绍 EXTI(中断/事件控制器)包含多个相互独立的边沿检测电路并且能够向处理器内核产生中断请求或唤醒事件。 EXTI 有三种触发类型&#xff1a;上升沿触发、下降沿触发和任意沿触发。 EXTI中的每一个边沿检测电路都可以独立配置和屏蔽。 4.1.GD32 EXTI 外设原理简介…

如何使用C#自制一个Windows安装包

原文链接&#xff1a;https://www.cnblogs.com/zhaotianff/p/17387496.html 以前都在用InstallShield制作安装包&#xff0c;基本需求是能满足的&#xff0c;但也有一些缺点&#xff1a; 1、界面不能完全定制 2、不能直接调用代码里的功能 平常使用一些其它软件&#xff0c;…

【基础算法总结】优先级队列

优先级队列 1.最后一块石头的重量2.数据流中的第 K 大元素4.前K个高频单词4.数据流的中位数 点赞&#x1f44d;&#x1f44d;收藏&#x1f31f;&#x1f31f;关注&#x1f496;&#x1f496; 你的支持是对我最大的鼓励&#xff0c;我们一起努力吧!&#x1f603;&#x1f603; 1…

FPGA开发——LED流水灯实现先从左往右流水,再从右往左流水

一、概述 我们在设计完一个方向的流水灯的设计时&#xff0c;总是会想实现让流水灯倒着流水回去的设计&#xff0c;这里我也是一样&#xff0c;实现这种设计的方法有很多种&#xff0c;其中就有直接使用case语句将所有可能包含进去编写&#xff0c;这种设计方法是最简单的&…

leetcode日记(51)不同路径Ⅱ

和上一道题&#xff08;无障碍物的最短路径&#xff09;很像&#xff0c;但事实上比上一题多了优化方法 根据上一题改的代码如下&#xff0c;添加了对障碍物的判定&#xff0c;如果有障碍物则将数组值设为0。 class Solution { public:int uniquePathsWithObstacles(vector&l…

Origin制作线性拟合回归图

选中数据&#xff0c;点下方散点图 调整散点颜色 在分析中打开线性拟合回归 添加文本 显示上轴

算法 —— 暴力枚举

目录 循环枚举 P2241 统计方形&#xff08;数据加强版&#xff09; P2089 烤鸡 P1618 三连击&#xff08;升级版&#xff09; 子集枚举 P1036 [NOIP2002 普及组] 选数 P1157 组合的输出 排列枚举 P1706 全排列问题 P1088 [NOIP2004 普及组] 火星人 循环枚举 顾名思…

keil调试SH79F7416

仿真器JET51A, 调试设置 选择器件 再次点击调试就一切正常啦

快速汇总公司产品涉及的项目(服务、站点)

文章目录 引言I 快速汇总公司产品涉及的项目II 常用工具jar包转成exe应用远程操作常用命令III 把应用做成windows服务在后台运行借助工具`instsrv.exe`和`srvany.exe`把应用做成windows服务的步骤SysWOW64 文件夹的作用引言 需求:汇总 平台涉及站点和服务信息 I 快速汇总公司…

SkyWalking入门搭建【apache-skywalking-apm-10.0.0】

Java学习文档 视频讲解 文章目录 一、准备二、服务启动2-1、Nacos启动2-2、SkyWalking服务端启动2-3、SkyWalking控制台启动2-4、自定义服务接入 SkyWalking 三、常用监控3-1、服务请求通过率3-2、服务请求拓扑图3-3、链路 四、日志配置五、性能剖析六、数据持久化6-1、MySQL持…

MySQL SQL 编程练习

目录 创建表并插入数据 查看表结构 创建触发器 创建INSERT 触发器 创建DELETE 触发器 创建更新触发器 创建存储过程 创建提取emp_new表所有员工姓名和工资的存储过程s1 创建存储过程s2&#xff0c;实现输入员工姓名后返回员工的年龄 创建一个存储过程s3&#xff0c;有2个参数&…

Pytorch使用教学5-视图view与reshape的区别

有同学后台留言问为什么view有时可对张量进行形变操作&#xff0c;有时就会报错&#xff1f;另外它和reshape功能好像一致&#xff0c;有什么区别呢&#xff1f;本文就带你了解PyTorch中视图的概念。 在PyTorch中对张量进行形变操作时&#xff0c;很多同学也会使用view方法&am…

3.2、数据结构-数组、矩阵和广义表

数组结构 数组是定长线性表在维度上的扩展,即线性表中的元素又是一个线性表。N维数组是一种“同构”的数据结构,其每个数据元素类型相同、结构一致。 一个m行n列的数组表示如下: 其可以表示为行向量形式&#xff08;一行一行的数据&#xff09;或者列向量形式&#xff08;一…

Windows搭建Nginx代理本地盘的文件 共享本地文件

一、查询自己的内网IP和外网IP的方法&#xff0c;以及判断是否直接连接到公网 内网IP&#xff0c;即局域网IP&#xff1a; 打开cmd窗口&#xff0c; 输入 ipconfig 后回车 外网IP&#xff0c;即公网IP&#xff1a; 打开cmd窗口&#xff0c;输入curl ifconfig.me指令访问ifconfi…

PE文件(十二)导入表

导入表 导入表的引入 当一个PE文件&#xff08;如.dll/.exe等&#xff09;需要使用别的模块的函数&#xff0c;也叫做依赖某模块&#xff0c;就需要一个清单来记录使用的模块&#xff08;一般为.dll文件&#xff0c;为方便理解&#xff0c;以后我们将模块都认为是.dll文件&am…

Python写UI自动化--playwright(通过UI文本匹配实现定位)

本篇简单拓展一下元素定位技巧&#xff0c;通过UI界面的文本去实现定位 目录 匹配XPath 匹配文本元素 .count()统计匹配数量 处理匹配文本返回多个元素 1、使用.nth(index)选择特定元素: 2、获取所有匹配的元素并遍历: 3、错误处理: 匹配XPath 比如我们要定位到下图的…