Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

3.6 KB
Raw Blame
StylesPath = .vale/styles
MinAlertLevel = suggestion
Vocab = Infisical

# `icon`, `url`, and `openapi` hold paths and route templates, not prose.
# This key replaces the defaults rather than adding to them, so the inline
# code scopes are re-listed.
IgnoredScopes = code, tt, kbd, frontmatter.icon, frontmatter.url, frontmatter.openapi

# Vale 3.17.1 has no native MDX parser: `.mdx` is dispatched to an external
# `mdx2vast` binary, and the whole run aborts with E100 when it is missing.
# Mapping to Markdown also keeps prose inside Mintlify components visible --
# the native MDX parser skips everything inside a JSX element, children
# included, which would hide most of our prose.
[formats]
mdx = md

[*.mdx]
BasedOnStyles = Vale, Infisical

# Lets `{/* vale off */}` and `{/* vale Infisical.Rule = NO */}` work in MDX.
CommentDelimiters = {/*, */}

# 1. Indented fenced code blocks. Mintlify indents them inside components, and
#    a fence indented four or more spaces cannot open a code block, so goldmark
#    treats it as paragraph text and lints the code as prose. Re-wrapping the
#    whole fence at column zero makes it code again. Only indented fences are
#    matched: Vale replaces frontmatter with a fence at column zero before
#    these patterns run, and re-wrapping that one exposes the YAML keys.
# 2. ESM snippet imports, which are linted as prose otherwise, and `vale off`
#    does not suppress them (upstream #1073).
BlockIgnores = (?s)  +(````*[^\n]*\n.*?\n *````*), \
(?s) *((?:^import\s+[^\n]*\n?)+), \
(?s) *((?:^export\s+[^\n]*\n?)+)

# Each pattern hides its first capture group by wrapping it in a code span.
#
# 1. JSX component tags. Hiding them stops goldmark from opening a raw-HTML
#    block at every Mintlify component, which is what makes links, code spans,
#    and fenced blocks inside a <Tab> or <Step> get linted as literal prose.
# 2. JSX expressions, with `{/*` excluded so comment suppression still works
#    (ignore patterns are applied before CommentDelimiters).
# 3. Email addresses, then URLs, then bare hostnames. Each is guarded against a
#    preceding backtick, word character, `@`, `.`, or `/` so a token is never
#    wrapped twice -- a second wrap leaves unbalanced backticks and the whole
#    span gets linted as prose instead. Filenames are deliberately not matched:
#    a fence info string like ```toml infisical-scan.toml would gain a backtick
#    and stop opening a code block at all.
# 4. SHOUTING_PLACEHOLDER tokens -- underscores are invalid in HTML tag names,
#    so goldmark emits these as literal text.
TokenIgnores = (</?[A-Z][A-Za-z0-9]*(?:\s[^>]*?)?/?>), \
(\{(?!/\*)[^{}\n]*\}), \
(?<![`\w])([\w.+-]+@[\w-]+(?:\.[\w-]+)+), \
(?<![`\w])((?:https?|mailto):[^\s)\]`]+), \
(?<![`\w@/.-])([\w-]+(?:\.[\w-]+)*\.(?:com|io|org|net|sh|dev|cloud|app|co|ai|gov|edu)\b(?:/[^\s)\]`]*)?), \
(<[A-Z][A-Z0-9_]*>)

# Vale.Terms is generated from the vocabulary and enforces one casing per term
# everywhere. On this corpus that produced roughly 750 false positives against
# 25 real findings, because nearly every acronym and product name has a
# legitimate lowercase form somewhere -- `rest` the English word, `helm` the
# binary, `kubernetes.io` the API group, `infisical` the CLI. Casing is enforced
# by the explicit swaps in Infisical/Terminology.yml instead, and the vocabulary
# is left to do spelling and sentence-case exceptions.
Vale.Terms      = NO
Vale.Spelling   = error
Vale.Repetition = error

# Google's service is singular "Secret Manager" and is referenced bare all over
# these pages, in more shapes than a lookbehind can cover.
[*gcp*.mdx]
Infisical.SecretsManager = NO

[*google*.mdx]
Infisical.SecretsManager = NO