types

local types = require("@std/commands/lint/types")

WARNING

These APIs are still open to future evolution. In new major versions, they may change in backwards incompatible ways.

Summary

Entry	Description
GlobalsConfig
LintRule
LintViolation
RuleContext
RuleOptions
severity
tag

---

Types

GlobalsConfig

type GlobalsConfig = { [string]: unknown }

---

LintRule

type LintRule = {
	read lint: (cst: syntax.CstStatBlock, sourcepath: path.Path?, context: RuleContext) -> { LintViolation },
	read name: string,
}

---

LintViolation

type LintViolation = {
	lintname: string,
	location: syntax.Span,
	message: string,
	severity: severity,
	sourcepath: path.Path?,
	suggestedfix: {
		read location: syntax.Span?, -- if nil, applies to whole violation location
		read fix: string,
	}?,
	target: string?, -- Additional information on the violation (e.g link to docs)
	tags: { tag }?,
}

---

RuleContext

type RuleContext = {
	globals: GlobalsConfig,
	options: RuleOptions,
}

---

RuleOptions

type RuleOptions = { [string]: unknown }

---

severity

type severity = "error" | "warning" | "info" | "hint"

---

tag

type tag = "unnecessary" | "deprecated"

---