Depcheck——专门用于检测 JavaScript 和 Node.js 项目中未使用依赖项的工具

文章目录

  • Depcheck 是什麽
  • 核心功能
    • 📚检测未使用的依赖
    • 🐛检测缺失的依赖
    • ✨支持多种文件类型
    • 🌍可扩展性
  • 安装与使用
    • 1. 安装 Depcheck
    • 2. 使用 Depcheck
  • Depcheck 的应用
  • 总结
  • 项目源码:

Depcheck 是什麽

来看一个常见错误场景🚨:同一个项目,开发者A持续开发并且稳定运行,但是开发者B拉取代码安装依赖却运行失败,除去 Node 等版本错误原因,最大的原因就是:A的本地node_modules文件夹中下载了某个依赖,但是package.json文件中并没有记录该依赖,导致其他开发者无法正常运行项目…

Depcheck 是一个开源的命令行工具,专门用于检测 JavaScript 和 Node.js 项目中的未使用的依赖项。它可以帮助开发者快速识别出项目中哪些依赖包没有被实际使用,或者是哪些未在 package.json 中声明但已经被项目使用的包。
在这里插入图片描述

对于开发者而言,Depcheck 是保持项目简洁和高效的必备工具,尤其是在复杂项目或长期维护的代码库中,它能显著减少冗余代码,提高依赖管理的质量。

核心功能

📚检测未使用的依赖

Depcheck 的核心功能是扫描项目中的所有代码,分析哪些依赖被引用了,哪些没有。未使用的依赖项会被标记为 “unused dependencies”,提醒开发者可以安全地移除这些依赖,减小项目体积,减少安全风险。

🐛检测缺失的依赖

除了查找未使用的依赖外,Depcheck 还能帮助检测项目中已经在代码中引用了,但却没有在 package.json 文件中声明的依赖项。这些缺失的依赖(missing dependencies)可能会导致项目在某些环境中无法正确构建或运行。

✨支持多种文件类型

Depcheck 支持多种文件类型和语法,包括 JavaScript、TypeScript、Babel、React JSX 等现代前端技术栈。这意味着它不仅适用于 Node.js 后端项目,也适合前端项目。

🌍可扩展性

Depcheck 允许开发者通过配置文件自定义检查规则,或忽略某些特定的文件或依赖。对于某些动态加载的模块,开发者可以通过 ignore 选项灵活调整工具的行为。

安装与使用

使用前提:
node.js版本 >= 10

1. 安装 Depcheck

Depcheck 是一个 npm 包,可以通过以下命令全局或本地安装:
在这里插入图片描述

2. 使用 Depcheck

在项目根目录运行以下命令:

depcheck

如果你是局部安装的话就使用npx命令:

npx depcheck

Depcheck 将扫描项目并返回检测结果,结果通常会分为三类⭐:
• 没有未使用的依赖项(Unused dependencies):项目中的 package.json 文件所声明的依赖项都被代码实际使用了。
• 没有缺失的依赖项(Missing dependencies):所有代码中引用的依赖项都在 package.json 中声明了。
• 没有未使用的开发依赖项(Unused devDependencies):开发依赖项也没有冗余,都是有效的。

示例输出:

情况一:

No depcheck issue

这个提示表明你的项目的依赖管理良好,所有依赖项都被合理使用且声明正确,项目依赖关系清晰,无需进一步操作。是一个积极信号✅。

情况二:

Unused dependencies
* element-plus

这表示项目中安装了element-plus,但是没有在代码中使用,是多余的依赖❌。

Missing dependencies和Unused devDependencies现实情况和上面一样。

在这里插入图片描述
还可以在项目文件夹下创建一个.depcheckrc文件,用来配置更多的项目选项。

ignores: ["eslint", "babel-*"]
skip-missing: true

Depcheck 的应用

  1. 代码库优化 随着项目的增长,某些依赖项可能在开发过程中被添加,但后来不再需要。Depcheck 可以帮助识别这些无用的依赖,减少项目的复杂度,提高构建性能。

  2. 项目迁移或升级 在迁移或升级技术栈时,Depcheck 可以用于检测哪些依赖项已经不再兼容或不需要。尤其是在从老旧版本向现代框架迁移时,依赖项的清理变得非常重要。

  3. 依赖管理中的安全性 未使用的依赖项可能带来潜在的安全风险,因为它们可能包含已知漏洞,但实际上并未在项目中使用。移除这些依赖项可以降低项目暴露的攻击面。

总结

Depcheck 是一个强大且简单易用的工具,适合所有 JavaScript 和 Node.js 项目的开发者使用。它通过自动化的方式帮助开发者保持项目依赖的清洁和安全,减少技术债务,同时提升项目的可维护性。通过定期使用 Depcheck,开发者可以确保项目中只包含必要的依赖,从而提高项目的性能和安全性。

项目源码:

https://github.com/depcheck/depcheck

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

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

相关文章

Sqoop的安装配置及使用

Sqoop安装前需要检查之前是否安装了Tez,否则会产生版本或依赖冲突,我们需要移除tez-site.xml,并将hadoop中的mapred-site.xml配置文件中的mapreduce驱动改回成yarn,然后分发到其他节点,hive里面配置的tez也要移除,然后…

sqoop抽取数据报驱动包不存在的问题

sqoop抽取数据报驱动包不存在的问题 报错示例:需要把相应的jar包放到sqoop的lib目录下: 可以正常查询

SpringBoot后端开发常用工具详细介绍——flyway数据库版本控制工具

文章目录 什么是flyway简介为什么要使用flyway 流程介绍整合springboot添加pom文件配置flyway向resource/db/migration添加sql文件 注意事项1. 迁移报错2. 迁移顺序 参考 什么是flyway 简介 为什么要使用flyway 我们在开发时往往会有这样一种情况: 进行软件开发…

HCIP-HarmonyOS Application Developer V1.0 笔记(一)

HarmonyOS的系统特性 硬件互助,资源共享;一次开发,多端部署;统一OS,弹性部署。 分布式软总线:分布式任务调度、分布式数据管理、分布式硬件虚拟化的基座 18N的独立设备 1个手机,8种设备(车机&#xff0c…

深入解析HTTP与HTTPS的区别及实现原理

文章目录 引言HTTP协议基础HTTP响应 HTTPS协议SSL/TLS协议 总结参考资料 引言 HTTP(HyperText Transfer Protocol)超文本传输协议是用于从Web服务器传输超文本到本地浏览器的主要协议。随着网络安全意识的提高,HTTPS(HTTP Secure…

Docker搭建基于Nextcloud的个人云盘/私有云盘/个人相册/家庭NAS

安装配置Docker 官方安装文档:https://docs.docker.com/engine/install/ Docker常用命令:https://blog.csdn.net/qq_43003203/article/details/139532097?spm1001.2014.3001.5502 Docker镜像仓库配置方法和国内常用镜像仓库地址: 输入&a…

杂项笔记

这个好像如果如果分配空间就会执行 这个扩容好像会进行拷贝 4 没懂 X x 0; X x1 {0,0}; 都会调用X::X(int x1, int x2 0)

腾讯通低成本替代方案:支持银河麒麟及统信等国产系统和移动端

一、腾讯通继续使用的核心痛点 自腾讯通停更及官网下架后,用户获取更新、技术支持和资源下载的渠道被切断,面临以下无法解决的关键问题: ● 在国产系统及移动端无法使用:腾讯通仅兼容Windows与MAC系统,致使用户在国产…

vue路由的基本使用

vue路由的基本使用 vue-router简介一、路由配置和使用1、安装2、创建路由实例2、在组件中引用路由 router-view ,如APP根组件中直接引用:3、最后还需要把路由挂载到APP实例中,在main.js中注册路由: 二、路由重定向与别名三、声明式导航1、传统…

大模型低资源部署策略

文章目录 解码效率分析大模型训练后量化方法经验性分析与相关结论由于大模型的参数量巨大,在解码阶段需要占用大量的显存资源,因而在实际应用中的部署代价非常高。在本文中,我们将介绍一种常用的模型压缩方法,即模型量化(ModelQuantization),来减少大模型的显存占用,从…

基于Springboot+微信小程序的“学课助手”小程序 (含源码数据库)

1.开发环境 开发系统:Windows10/11 架构模式:MVC/前后端分离 JDK版本: Java JDK1.8 开发工具:IDEA 数据库版本: mysql5.7或8.0 数据库可视化工具: navicat 服务器: SpringBoot自带 apache tomcat 主要技术: Java,Springboot,mybatis,mysql,vue 2.视频演示地址 3.功能 该系统…

如何将原本打开Edge呈现出的360浏览器,更换成原本的Edge页面或者百度等其他页面

每次打开Edge浏览器,都会呈现出360浏览器的页面,很烦。以下将说明如果将呈现出的360浏览器,更换成原本的Edge页面或者百度等其他页面。 1.找到你的控制面板,点击卸载程序。 2. 找到360安全卫士,右键单击更改/卸载。 3…

云原生笔记

#1024程序员节|征文# 单页应用(Single-Page Application,SPA) 云原生基础 云原生全景内容宽泛,以至于刚开始就极具挑战性。 云原生应用是高度分布式系统,它们存在于云中,并且能够对变化保持韧性。系统是由多个服务组成的&#…

Android 下载进度条HorizontalProgressView 基础版

一个最基础的自定义View 水平横向进度条,只有圆角、下载进度控制;可二次定制度高; 核心代码: Overrideprotected void onDraw(NonNull Canvas canvas) {super.onDraw(canvas);int mW getMeasuredWidth();int mH getMeasuredHei…

WebGL进阶(五)-可视域

理论基础: 顶点着色器 Vertex Shader 主要是负责处理顶点位置、顶点颜色、顶点向量等顶点的数据;处理一些顶点的变换:例如在进行视图变换和投影变换时MVP矩阵会改变顶点的位置信息。 输入: 顶点着色器输入部分主要是声明&…

Android中常用adb命令

目录 1.adb连接安卓模拟器 2.adb列出所有已经连接的设备 3.adb显示设备的日志信息 4.adb 电脑文件推送到安卓模拟器中 5.adb 手机传送文件到电脑 6.adb获取安卓应用的包名和Activity名 附录 1--命令 1)adb devices 2)adb install 路径> 3)…

windows 下安装 make

Error running ‘docs’: Cannot run program “\usr\bin\make” (in directory “F:\xx\goland-api\xxxx-go”): CreateProcess error2, 系统找不到指定的文件。 windows上安装:chocolatey github地址: https://github.com/chocolatey/choco/releases然…

PAT甲级-1052 Linked List Sorting

题目 题目大意 给定一个链表,要求按链表中的数值从小到大排序生成新的链表。输出有效节点的个数和链表的起始地址,以及链表本身。 思路 链表用结构体数组来表示,然后用sort自定义排序。需要注意的是,链表中存在无效节点&#x…

【CSS in Depth 2 精译_055】8.3 伪类 :is() 和 :where() 的正确打开方式

当前内容所在位置(可进入专栏查看其他译好的章节内容) 【第三部分 现代 CSS 代码组织】 ✔️【第八章 层叠图层及其嵌套】 ✔️ 8.1 用 layer 图层来操控层叠规则(上篇) 8.1.1 图层的定义(上篇)8.1.2 图层的…

React基础语法

1.React介绍 React由Meta公司开发,是一个用于构建Web和原生交互界面的库 1.1 React优势 相较于传统基于DOM开发的优势 1.组件化的开发方式 2.不错的性能 相较于其他前端框架的优势 1.丰富的生态 2.跨平台支持 1.2React的时长情况 全球最流行,大厂…