当前位置：首页 > news >正文

自定义luacheck校验规则

news 来源：原创 2025/7/12 21:00:58

安装运行环境

安装环境及源码解析，参考：LuaCheck校验原理解析

自定义校验规则

从代码中可以看出，定义一条规则有以下关键点：

需要定义告警信息：由键值对组成，key为告警编码（不一定为纯数字，只是这里使用的是纯数字），value为告警信息，告警信息中，message_format为消息模板，fields为消息中定义的字段，这两者用于模板文本传参，如果不需要传参，即只需要打印固定信息时，fields可以为空 {} 。此处定义在每个模块的stage.warnings对象中。
需要在模块中定义stage.run函数并将其return，stage.run函数即为此模块的主函数，在这里执行校验规则，函数接受chstate参数，作为被检查行的上下文对象；
当需要弹出告警时，需要使用chstate:warn_xx函数推送，可用函数有：
1. chstate:warn_range(code, range, warning)：
  - code为步骤1定义的告警信息对应告警编码，字符串形式，如"541"；
  - range为需要提示的代码块，以node节点形式传入;
  - warning为需要覆盖的告警信息，例如，已定义告警信息为 {["541"] = {message_format = "empty do..end block", fields = {}}} ，这里可以通过传参 {["541"] = {message_format = "nothing", fields = {}}} 来将其覆盖。通常不需要传这个参数。
2. chstate:warn_var(code, var, warning)：此处code、warning参数与chstate:warn_range函数一致，var参数顾名思义，传入的是一个变量对象，同样以node节点形式传入；
3. chstate:warn_value(code, value, warning)：此处value为一个被赋值的变量对象，可知其关系为value.var_node 即为这个值对应的变量（ast语法树中节点），value.var_node.node即为对应代码块；
需要将这个模块添加到stages.lua的执行列表中，即 stages.names ，注意，必须要添加到前置流程之后，即 resolve_locals 之后；

示例：自定义规则模块

接下来实现一条简单自定义规则：代码中不允许出现 HelloLua 字样，规则编码为 700 ;

步骤1：stages下新增模块

在 src/luacheck/stages/ 下，新建 HelloLua.lua 文件，其内容为：

local stage = {}stage.warnings = {}function stage.run(chstate)
endreturn stage

步骤2：编写规则及其校验方法

修改 HelloLua.lua 文件如下：

local stage = {}stage.warnings = {["700"] = {message_format = "do not show HelloLua", fields = {}},
}function stage.run(chstate)local num_lines = #chstate.line_offsetsfor line_number = 1, num_lines dolocal line_offset = chstate.line_offsets[line_number]local line_length = chstate.line_lengths[line_number]-- 若检查到此行代码中存在HelloLua，则打印对应告警if chstate.source:find("HelloLua", line_offset, true) thenchstate:warn("700", line_number, line_offset, line_offset + #("HelloLua") - 1)endend
endreturn stage

步骤3：将自定义模块添加到stages.lua中

修改stages.lua中stages.names如下：

stages.names = {"parse","unwrap_parens","linearize","parse_inline_options","name_functions","resolve_locals","detect_bad_whitespace","detect_cyclomatic_complexity","detect_empty_blocks","detect_empty_statements","detect_globals","detect_reversed_fornum_loops","detect_unbalanced_assignments","detect_uninit_accesses","detect_unreachable_code","detect_unused_fields","detect_unused_locals","HelloLua"
}
-- 添加到末尾

此时该规则已配置完成，接下来是验证其生效；

步骤4：验证

用于测试的lua文件 init.lua 内容如下：

local base_dir = vim.env.LUNARVIM_BASE_DIRor (function()local init_path = debug.getinfo(1, "HelloLua").source -- 此处修改字符串内容，检查是否告警return init_path:sub(2):match("(.*[/\\])"):sub(1, -2)end)()if not vim.tbl_contains(vim.opt.rtp:get(), base_dir) thenvim.opt.rtp:prepend(base_dir)
endrequire("lvim.bootstrap"):init(base_dir)require("lvim.config"):load()local plugins = require "lvim.plugins"require("lvim.plugin-loader").load { plugins, lvim.plugins }require("lvim.core.theme").setup()local Log = require "lvim.core.log"
Log:debug "Starting LunarVim"local commands = require "lvim.core.commands"
commands.load(commands.defaults)

执行检查：

root@979bc2a8a939:~/test/luacheck-0.23.0# lua -e 'package.path="/root/test/luacheck-0.23.0/src/?.lua;/root/test/luacheck-0.23.0/src/?/init.lua;"..package.path' /root/test/luacheck-0.23.0/bin/luacheck.lua --codes init.lua 
Checking init.lua                                 8 warningsinit.lua:1:1: (W700) do not show HelloLuainit.lua:1:18: (W113) accessing undefined variable viminit.lua:2:1: (W700) do not show HelloLuainit.lua:3:1: (W700) do not show HelloLuainit.lua:7:8: (W113) accessing undefined variable viminit.lua:7:25: (W113) accessing undefined variable viminit.lua:8:3: (W113) accessing undefined variable viminit.lua:17:47: (W113) accessing undefined variable lvimTotal: 8 warnings / 0 errors in 1 file

可见该规则已生效。

此处注意，因为这里使用的是从luacheck源脚本执行，所以所有涉及路径的参数必须指向luacheck所在路径，要根据实际所处位置进行调整，--codes 参数用于显示对应检查规则，也可以在 .luacheckrc 文件中定义 codes = true 。

自定义luacheck校验规则

安装运行环境安装环境及源码解析，参考：LuaCheck校验原理解析自定义校验规则从代码中可以看出，定义一条规则有以下关键点： 需要定义告警信息：由键值对组成，key为告警编码（不一定为纯数字&…...

编程日记 2025/7/12 21:00:58

Mac连接云服务器工具推荐

文章目录前言步骤1. 下载2. 安装3. 常用插件安装4. 连接ssh测试5. 连接sftp测试注意：ssh和sftp的区别注意：不同文件传输的区别解决SSL自动退出前言 Royal TSX是什么： Royal TSX 是一款跨平台的远程桌面和连接管理工具，专为 mac…...

编程日记 2025/7/9 23:19:15

【react】Redux的设计思想与工作原理

Redux 的设计理念 Redux 的设计采用了 Facebook 提出的 Flux 数据处理理念在 Flux 中通过建立一个公共集中数据仓库 Store 进行管理，整体分成四个部分即: View （视图层）、Action （动作）、Dispatcher (派发器)、Stor…...

编程日记 2025/7/10 21:22:41

深入解析Android JNI：以Visualizer为例

深入解析Android JNI：以Visualizer为例引言 Java Native Interface (JNI) 是Java平台提供的一种机制，允许Java代码与本地代码（如C/C++）进行交互。在Android开发中，JNI被广泛用于性能优化、访问底层系统API、以及复用现有的C/C++库。本文将通过Android中的Visualizer类，…...

编程日记 2025/7/1 1:15:20

Java基于SpringBoot的甘肃非物质文化网站的设计与实现，附源码

博主介绍：✌Java老徐、7年大厂程序员经历。全网粉丝12w、csdn博客专家、掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java技术领域和毕业项目实战✌ 🍅文末获取源码联系🍅 👇🏻 精彩专栏推荐订阅👇&…...

编程日记 2025/7/6 2:27:41

Unity小白工作心得（无限记录）

24届毕业，11月才找到工作在一家小公司。工作两个月了，遇到最大的问题就是探索新知识，每天都是摸索式前进，因为工作面临着交付，你不得不想尽办法解决问题然后交给上面，但其他程序员用的引擎不一样&#xff0…...

编程日记 2025/7/10 7:55:41

STC单片机内部常见寄存器及其作用

STC单片机内部常见寄存器及其作用 STC单片机是基于8051架构的增强型单片机，广泛应用于嵌入式系统中。其内部有多个特殊功能寄存器（SFR, Special Function Register），用于控制硬件模块（如定时器、串口、中断等&#xf…...

编程日记 2025/7/8 20:37:10

【亚马逊云】基于Amazon EC2实例部署 NextCloud 云网盘并使用 Docker-compose 搭建 ONLYOFFICE 企业在线办公应用软件

文章目录 1. 部署EC2实例2. 安装 Docker 服务3. 安装docker-compose4. 创建Docker-compose文件5. 创建nginx.conf文件6. 运行docker-compose命令开始部署7. 访问ONLYOFFICE插件8. 访问NextCloud云盘9. 下载并启用ONLYOFFICE插件10. 上传文件测试11. 所遇问题12. 参考链接 1. 部…...

编程日记 2025/7/7 7:54:34

vim、watch、cp和mv

一、vim使用技巧 vim主配置文件：/etc/vimrc （对所有用户都生效） vim子配置文件：vim ~/.vimrc (只对当前用户生效） 可写入： set nu 显示行号 ts2 tab键长度为两个空格（默认为8个空格…...

编程日记 2025/7/12 6:46:01

【Linux】：线程安全 + 死锁问题

📃个人主页：island1314 🔥个人专栏：Linux—登神长阶 ⛺️ 欢迎关注：👍点赞 👂🏽留言 😍收藏 💞 💞 💞 1. 线程安全和重入问题&…...

编程日记 2025/7/11 15:10:53

HarmonyOS Next 应用元服务开发-应用接续动态配置迁移保持迁移连续性

保证迁移连续性，由于迁移加载时，目标端拉起的应用可能执行过自己的迁移状态设置命令（如：冷启动时目标端在onCreate中设置了INACTIVE；热启动时对端已打开了不可迁移的页面，迁移状态为INACTIVE等情况&#xf…...

编程日记 2025/7/12 13:21:19

重装操作系统后 Oracle 11g 数据库数据还原

场景描述： 由于SSD系统盘损坏，更换硬盘后重装了操作系统，Oracle数据库之前安装在D盘(另一个硬盘)，更换硬盘多添加一个盘符重装系统后盘符从D变成E，也就是之前的D:/app/... 变成了现在的 E:/app/...，重新安装…...

编程日记 2025/7/10 23:44:49

《Vue3实战教程》39：Vue3无障碍访问

如果您有疑问，请观看视频教程《Vue3实战教程》无障碍访问 Web 无障碍访问 (也称为 a11y) 是指创建可供任何人使用的网站的做法——无论是身患某种障碍、通过慢速的网络连接访问、使用老旧或损坏的硬件，还是仅处于某种不方便的环境。例如，…...

编程日记 2025/7/12 17:16:09

Linux-Redis哨兵搭建

环境资源准备主机名IP端口号角色vm1192.168.64.156379/26379mastervm2192.168.64.166379/26379slavevm3192.168.64.176379/26379slave 6379为redis服务暴露端口号、26379为sentinel暴露端口号。安装Redis # 包文件下载 wget https://github.com/redis/redis/archive/7.2.2…...

编程日记 2025/7/7 22:52:53

数据分析思维（六）：分析方法——相关分析方法

数据分析并非只是简单的数据分析工具三板斧——Excel、SQL、Python，更重要的是数据分析思维。没有数据分析思维和业务知识，就算拿到一堆数据，也不知道如何下手。推荐书本《数据分析思维——分析方法和业务知识》，本文内容就是提取…...

编程日记 2025/7/8 22:05:30

Go基础之环境搭建

文章目录 1 Go1.1 简介1.1.1 定义1.1.2 特点用途 1.2 环境配置1.2.1 下载安装1.2.2 环境配置1.2.2.1 添加环境变量1.2.2.2 各个环境变量理解 1.2.3 验证环境变量 1.3 包管理工具 Go Modules1.3.1 开启使用1.3.2 添加依赖包1.3.3 配置国内包源1.3.3.1 通过 go env 配置1.3.3.2 修…...

编程日记 2025/7/11 16:11:33

Flume的安装和使用

一、安装Flume 1. 下载flume-1.7.0 http://mirrors.shu.edu.cn/apache/flume/1.7.0/apache-flume-1.7.0-bin.tar.gz 2. 解压改名 tar xvf apache-flume-1.7.0-bin.tar.gz mv apache-flume-1.7.0-bin flume 二、配置Flume 1. 配置sh文件 cp conf/flume-env.sh.template …...

编程日记 2025/7/12 15:43:17

原生js封装ajax请求以及css实现提示效果和禁止点击效果

<!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><meta name"viewport" content"widthdevice-width, initial-scale1.0,user-scalableno"><title>本地模式网络切换</title>&l…...

编程日记 2025/7/10 14:45:40

idea 的 springboot项目spring-boot-devtools 自动编译配置热部署

1，设置一 2，设置二设置二（旧版本） CtrlShiftAlt/ 点击弹出框中Registry... 引入（如果报错，换不同的版本） <dependency><groupId>org.springframework.boot</groupId><a…...

编程日记 2025/6/28 15:46:18

算法 class 005 （对数器C语言实现）

对数器的概念： 用来测试你的算法是否正确。怎么做呢？ 1：比如，写个冒泡排序，作为对比的对象 2：生成一个随机数数组，用来测试 3：用冒泡排序和你想要验证的那个排序算法，同…...

编程日记 2025/7/12 1:54:36

靶场搭建问题(技巧)总结

目录 DVWA靶场问题待续、更新中...... DVWA靶场问题错误信息 Parse error: syntax error, unexpected ‘[’, expecting ‘)’ in C:\Softwares\phpstudy\PHPTutorial\WWW\dvwa\dvwa\includes\dvwaPage.inc.php on line 52 原因 phpstudy2018所使用的php版本过低&#xff0c…...

编程日记 2025/7/9 5:28:01

Elasticsearch DSL版

文章目录 1.索引库操作创建索引库：删除索引库：查询索引库：修改索引库：总结 2.文档操作创建文档：查询文档：删除文档：全量修改文档：增量修改文档：总结 3.DSL查询语法&#…...

编程日记 2025/7/9 10:34:43

在K8S中，Pod请求另一个Pod偶尔出现超市或延迟，如何排查？

在Kubernetes中，当Pod请求另一个Pod时偶尔出现超时或延迟，可能是由于多种原因造成的。以下是一些建立的排查步骤： 1. 检查网络配置和插件： 确认你的kubernetes集群使用了合适的网络插件（如Calico、Flannel等&#xf…...

编程日记 2025/7/9 5:34:05

Echarts实现大屏可视化2

目录一、效果展示二、说明 2.1 销售额统计图表 2.2 全国热榜模块三、边框图片【border-image】 3.1 使用场景 3.2 边框图片切图原理 3.3 边框图片语法【重要】四、代码展示 4.1 展示页面 4.2 数据概览区域 4.3 监控区域 4.4 点位分布统计区域 4.5 设备数据统…...

编程日记 2025/7/8 23:38:09

HarmonyOS NEXT 应用开发练习：智能视频推荐

一、整体思路本DEMO展示了如何在HarmonyOS NEXT平台上开发一个智能视频推荐应用。应用通过模拟的用户偏好数据，为用户推荐可能感兴趣的视频。用户可以通过滑动屏幕查看推荐的视频列表，并点击视频封面进入播放页面，本例中仅模拟点击效果&…...

编程日记 2025/7/10 11:37:13

FPGA（二）组成结构基础内容

1. FPGA的基本结构 FPGA主要由以下部分组成： （1）可编程逻辑单元（CLB）：CLB是FPGA中最基本的逻辑单元，由查找表（LUT）和触发器组成，可实现任意逻辑功能。查找表…...

编程日记 2025/7/8 11:25:13

linux中执行命令

1.1 命令格式命令格式： 主命令选项参数（操作对象） 命令分为两类： 内置命令（ builtin ）：由 shell 程序自带的命令外部命令：有独立的可执行程序文件，文件名即命令…...

编程日记 2025/7/10 1:18:06

《Java 数据结构》

《Java 数据结构》 1. 概述 Java 数据结构是计算机科学中的一种基础概念，它涉及到数据的组织和存储方式，以便能够高效地访问和修改数据。在 Java 中，数据结构通常通过类和接口来实现，这些类和接口提供了用于操作数据的各种方法。…...

编程日记 2025/7/7 2:28:25

C# 设计模式（结构型模式）：装饰器模式

C# 设计模式（结构型模式）：装饰器模式在软件开发中，面对需要扩展功能但又不想修改已有代码的情况时，装饰模式（Decorator Pattern）是一个非常有用的设计模式。装饰模式允许我们在不改变对象自身…...

编程日记 2025/7/7 23:24:06

ubuntu初始配置

ubuntu初始配置 vm下ubuntu安装vmtools安装常用工具ubuntu终端美化安装ssh使用apt安装时出现错误解决办法 vm下ubuntu安装vmtools //安装vmtools sudo apt-get install open-vm-tools //桌面组件提供了更好的集成体验，包括拖放文件和共享剪贴板等功能 sudo apt-get…...

编程日记 2025/7/10 1:25:29

Spark Runtime Filter

Runtime Filter 参考链接： https://docs.google.com/document/d/16IEuyLeQlubQkH8YuVuXWKo2-grVIoDJqQpHZrE7q04/edit?tabt.0https://www.modb.pro/db/557718https://issues.apache.org/jira/browse/SPARK-32268https://github.com/apache/spark/pull/35789https…...

编程日记 2025/7/8 8:29:21

《Vue3实战教程》42：Vue3TypeScript 与组合式 API

如果您有疑问，请观看视频教程《Vue3实战教程》 TypeScript 与组合式 API 这一章假设你已经阅读了搭配 TypeScript 使用 Vue 的概览。为组件的 props 标注类型使用 <script setup> 当使用 <script setup> 时，defineProps() 宏函数支…...

编程日记 2025/7/11 17:57:42

【Hadoop】Hadoop安全之Knox网关

目录一、概述 2.1 knox介绍 2.2 版本信息二、部署三、验证Knox网关 3.1 Hdfs RESTFULL 3.2 HDFSUI 3.3 YARNUI 3.4 HBASEUI 一、概述 2.1 knox介绍 Apache Knox网关是一个用于与Apache Hadoop部署的REST api和ui交互的应用程序网关。Knox网关为所有与Apache Hadoop…...

编程日记 2025/7/10 15:03:58

UML之关联

关联指两个类之间的各种联系。UML使用各种单实线表示关联，这个单实线可以是直线（垂直的、水平的或者倾斜的）、折线甚至曲线。事实上，关联也是展示类的属性的另一外的一种形式。例如在下图中，我们通过一条实线连接类B…...

编程日记 2025/7/7 22:36:59

大数据面试笔试宝典之大数据运维面试

1.大数据集群节点规划 1.HDFS 集群节点规划假如业务系统数据量每天增量 50T ，保留周期为 30 天，那么...

编程日记 2025/7/5 8:10:25

Matlab全局变量用法及其实例分析

⭕⭕ 目录 ⭕⭕ 一、全局变量使用说明二、全局变量的用法实例演示2.1 实例演示2.2 修改global 一、全局变量使用说明全局变量是指在不同的工作空间以及基本的工作空间中可以共享的变量。用户只需要在主程序或者任何子程序中声明一个或多个全局变量，则函数和主程序…...

编程日记 2025/7/10 15:06:35

leetcode hot 100 跳跃游戏

55. 跳跃游戏已解答中等相关标签相关企业给你一个非负整数数组 nums ，你最初位于数组的第一个下标。数组中的每个元素代表你在该位置可以跳跃的最大长度。判断你是否能够到达最后一个下标，如果可以，返回 true ；否则…...

编程日记 2025/7/11 17:56:23

CG顶会论文阅读｜《科技论文写作》硕士课程报告

文章目录一、基本信息1.1 论文基本信息1.2 课程基本信息1.3 博文基本信息二、论文评述（中英双语）2.1 研究问题（Research Problem）2.2 创新点（Innovation/Contribution）2.3 优点（Why this pape…...

编程日记 2025/7/12 6:30:36

短视频矩阵系统搭建开发指导

在数字化营销的广阔天地中，抖音短视频已迅速崛起为一个拥有巨大影响力的社交媒体平台。随着其受众范围的日益扩大，采用有效的搜索引擎优化（SEO）策略以增强视频的曝光度和吸引流量变得至关重要。本文旨在阐述一种专为抖音短视频量身…...

编程日记 2025/7/8 21:53:35

LeetCode热题100-移动零【JavaScript讲解】

题目： 根据本题想思路： 快指针和慢指针同时移动，当遍历的值不为0的时候，将快指针的值赋给慢指针，如果遍历到0，快指针继续移动，慢指针不动等待被覆盖。之后使用fill方法填充0。具体答案放在最后…...

编程日记 2025/7/12 14:07:50

MarkDown 的 mermaid gantt（甘特图）、mermaid sequenceDiagram （流程图）语法解析和应用

简简单单 Online zuozuo：简简单单 Online zuozuo 简简单单 Online zuozuo 简简单单 Online zuozuo 简简单单 Online zuozuo ：本心、输入输出、结果简简单单 Online zuozuo ：文章目录 MarkDown 的 mermaid gantt、mermaid sequenceDiagram 语法解析和应用前言mermaid gan…...

编程日记 2025/7/9 8:16:51

Flask 与 SocketIO 正确初始化及最佳实践调试

1、问题我使用Flask和Flask-SocketIO 来做 Websocket 链接。前期正常使用，但是后期布置修改什么导致Websocket连接失败。排查需求，才发现初始化不正常导致。 SocketIO 和 Flask 应用的初始化顺序和引用循环的问题 2、环境 python-engineio4.11.1 py…...

编程日记 2025/7/10 9:44:23

Spring Boot 3 文件上传、多文件上传、大文件分片上传、文件流处理以及批量操作

在 Spring Boot 3 中，可以通过内置的文件处理机制结合 Java 的 IO 流与多线程技术，实现文件上传、多文件上传、大文件分片上传、文件流处理以及批量操作的需求。以下是详细实现步骤： 1. 单文件上传控制器代码 import org.springframework…...

编程日记 2025/7/12 15:58:13

Springcloud项目-前后端联调(一）

项目采用SpringCloud整体构建，nacos作为注册中心，Mysql和Redis进行数据存储，整体项目类似于平时使用的出行APP,idea2023编写后端，vscode编写前端后端代码先前已经编写完毕这部分功能主要是通过前端输入出发地和目的地之后调用…...

编程日记 2025/7/7 23:09:52

树莓派之旅-第一天系统的烧录和设置

自言自语： 在此记录一下树莓派的玩法。以后有钱了买点来玩啊草系统的安装烧录系统下载树莓派官网：https://www.raspberrypi.com/ 首页点击SoftWare进入OS下载页面这里是安装工具：安装工具负责将系统镜像安装到sd卡中点击下载符合自己…...

编程日记 2025/7/11 11:55:52

SQL 中的 EXISTS

我们先从 SQL 中最基础的 WHERE 子句开始。比如下面这条 SQL 语句： 很显然，在执行这条 SQL 语句的时候，DBMS 会扫描 Student 表中的每一条记录，然后把符合 Sdept IS 这个条件的所有记录筛选出来，并放到结果集里面去…...

编程日记 2025/7/8 4:23:29

WebSocket 的封装使用

import { ElMessage } from "element-plus";// 全局WebSocket实例 let ws null; let isConnected false; let currentWsUrl ; // 用于存储当前的wsUrl let baseURL ws://XXX.com:8081;const initWebSocket (wsUrl, sendData) > {return new Prom…...

编程日记 2025/7/4 18:25:09

[算法] [leetcode-509] 斐波那契数

509 斐波那契数斐波那契数 （通常用 F(n) 表示）形成的序列称为斐波那契数列。该数列由 0 和 1 开始，后面的每一项数字都是前面两项数字的和。也就是： F(0) 0，F(1) 1 F(n) F(n - 1) F(n - 2)，其中 n…...

编程日记 2025/7/8 21:28:22

解决CentOS 8 YUM源更新后报错问题：无法下载AppStream仓库元数据

背景介绍在尝试更新CentOS 8的YUM源以使用阿里云镜像时，遇到了Failed to download metadata for repo appstream的错误。此错误通常出现在执行yum clean all && yum makecache命令之后，表明系统无法从指定的URL获取AppStream仓库的元数据。本文…...

编程日记 2025/7/10 13:26:16

HTML——49.header和footer标签

<!DOCTYPE html> <html><head><meta charset"UTF-8"><title>header和footer标签</title></head><body><!--header:定义文档的页眉，通常用来定义可见…...

编程日记 2025/7/6 19:04:42