remlint 0.1.0

data/config/default.yml

@@ -0,0 +1,374 @@
+# RemLint's shipped defaults. A project's own .remlint.yml is merged over this
+# key by key, so setting one option on one rule leaves everything else alone.
+#
+# Every rule understands `Enabled` and `Severity`; the rules with further
+# options list them below. Run `remlint --show-rules` to see what is on.
+#
+# The default split: a rule reports something Remind itself would call an
+# error, or it is off. Style preferences are opt-in, because a linter whose
+# first run is a wall of cosmetic noise is a linter that gets switched off.
+
+# Paths never linted, as shell globs against the path as given.
+Exclude: []
+
+# ---------------------------------------------------------------------------
+# On by default: things Remind rejects, or that break its output.
+# ---------------------------------------------------------------------------
+
+# Whitespace at the end of a line. remind.vim highlights this as an Error --
+# "This will match trailing whitespaces that seem to break rem2ps".
+TrailingWhitespace:
+  Enabled: true
+  Severity: error
+
+# A backslash that looks like a line continuation and is not, because it has a
+# space after it, or because the file ends before the continuation does.
+DanglingContinuation:
+  Enabled: true
+  Severity: error
+
+# IF/IFTRIG/ENDIF, ELSE, and the PUSH/POP context stacks that do not pair up.
+UnbalancedBlocks:
+  Enabled: true
+  Severity: error
+
+# Brackets and parentheses that never close, or that close each other. Remind's
+# own E_MISS_END and E_MISS_RIGHT_PAREN, reported without running the file.
+UnbalancedDelimiters:
+  Enabled: true
+  Severity: error
+
+# Calls with the wrong number of arguments, checked against Remind's function
+# table and against the FSET definitions in the file itself.
+FunctionArity:
+  Enabled: true
+  Severity: error
+
+# A $SysVar that is not one of Remind's. Its namespace is closed, so a name
+# that is not in the table is E_NOSUCH_VAR rather than an empty variable.
+UnknownSystemVariable:
+  Enabled: true
+  Severity: error
+  # Extra $-prefixed names to accept, for a file that is fed variables from
+  # outside -- `remind -i$Latitude=...` and the like.
+  AllowedNames: []
+
+# SET or UNSET on a read-only system variable, or a literal value outside the
+# range Remind's table declares for it.
+SystemVariableAssignment:
+  Enabled: true
+  Severity: error
+
+# Colour components outside 0-255, in SPECIAL COLOR, SPECIAL SHADE and
+# ansicolor(). Remind errors on these; rem2ps silently clamps them.
+ColorComponentRange:
+  Enabled: true
+  Severity: error
+
+# Reminder text pasted into a RUN or INCLUDECMD body outside shell quotes.
+# The body goes through the substitution filter and the result is handed to
+# /bin/sh, so a substitution is a hole in a shell command and what lands in it
+# is data. An apostrophe is the polite failure.
+UnquotedShellSubstitution:
+  Enabled: true
+  Severity: error
+
+# DURATION or TZ on a reminder with no AT clause. A duration needs a start
+# time; a bare date has no instant to convert between zones.
+ClauseRequiresAt:
+  Enabled: true
+  Severity: error
+
+# SATISFY inside an IFTRIG. IFTRIG takes every clause REM does except that
+# one, which is easy to miss when a working REM is copied into an IFTRIG.
+IftrigWithSatisfy:
+  Enabled: true
+  Severity: error
+
+# A % sequence Remind does not substitute, or an argument form left unclosed.
+# Every letter and digit is a real sequence, so this is mostly about
+# punctuation -- but the failure is silent: Remind drops the % and prints the
+# character.
+UnknownSubstitutionSequence:
+  Enabled: true
+  Severity: warning
+
+# A %<Header> reference with no INFO clause of that name on the same command.
+# It expands to nothing, so the reminder reads like a truncation bug.
+InfoSubstitutionWithoutHeader:
+  Enabled: true
+  Severity: warning
+
+# Commands below a line reading exactly __EOF__, which Remind never reads.
+# The marker is a debugging convenience; the failure is leaving it in.
+TextAfterEofMarker:
+  Enabled: true
+  Severity: warning
+
+# An UNTIL or THROUGH date earlier than the FROM or SCANFROM it belongs with.
+# Remind warns about this one itself, at parse time; the linter says it in the
+# editor and in CI instead of only on stderr when someone runs the file.
+UntilBeforeFrom:
+  Enabled: true
+  Severity: error
+
+# $Latitude or $Longitude set to a bare number. Remind has no floating-point
+# type, so the coordinate has to arrive as a STRING; the failure is a
+# confidently wrong sunrise time rather than an error.
+CoordinateNotString:
+  Enabled: true
+  Severity: error
+
+# A function calling shell(), defined between RUN OFF and RUN ON. The
+# permission binds at definition, so the function fails even when it is called
+# later with RUN back on -- and the error names the call site, which is the one
+# place the mistake is not.
+ShellUseWhileRunDisabled:
+  Enabled: true
+  Severity: error
+
+# A comparison between literals of different types. Remind makes == a constant
+# 0 and != a constant 1 across types, silently; ordering raises Type mismatch.
+LiteralTypeMismatch:
+  Enabled: true
+  Severity: error
+
+# An AT, DURATION, PRIORITY or MAX-OVERDUE value outside its range. Remind
+# rejects each, but only on the day the line is reached.
+ClauseValueRange:
+  Enabled: true
+  Severity: error
+
+# A date outside 1990-01-01 to 5990-12-31, or with an impossible component.
+# BASE + YR_RANGE make that range the type rather than a policy.
+DateOutOfRange:
+  Enabled: true
+  Severity: error
+
+# FROM, UNTIL, THROUGH or COMPLETE-THROUGH given a partial date. GetFullDate
+# needs all three components; a TODO with an unusable COMPLETE-THROUGH starts
+# its whole calculation at 1990-01-01.
+ClauseNeedsFullDate:
+  Enabled: true
+  Severity: error
+
+# A *n repeat with no start date to count from, or with a weekday that only
+# picks the start date and is then ignored by the recurrence.
+RepeatTrigger:
+  Enabled: true
+  Severity: warning
+
+# An INFO clause that is malformed or repeats another's header. Headers are
+# not case-sensitive, so Url: and URL: on one command collide.
+InfoClause:
+  Enabled: true
+  Severity: warning
+
+# A TAG containing a comma or whitespace. Tags reach back-ends as a
+# comma-separated list, so a comma inside one splits it in two.
+TagSyntax:
+  Enabled: true
+  Severity: warning
+
+# A second BANNER, which silently replaces the first, or one written below the
+# reminders it appears to apply to.
+BannerPlacement:
+  Enabled: true
+  Severity: warning
+
+# A SPECIAL type no shipped back-end parses. Remind passes any SPECIAL
+# through and a back-end must ignore what it cannot read, so a typo produces
+# no output and no error.
+UnknownSpecialType:
+  Enabled: true
+  Severity: warning
+  # Extra types to accept, for a project with its own back-end.
+  AllowedTypes: []
+
+# A backslash escape Remind does not define, which drops the backslash
+# silently, or the prohibited \x00.
+StringEscape:
+  Enabled: true
+  Severity: warning
+
+# A DEBUG flag Remind does not define, or one switched on and never off --
+# which turns every later run, including the cron one, into a trace log.
+DebugCommand:
+  Enabled: true
+  Severity: warning
+
+# shell() given a maximum length of zero, which returns the empty string
+# whatever the command printed.
+ShellMaxlen:
+  Enabled: true
+  Severity: warning
+
+# A function redefined without the FSET - form that says the redefinition is
+# deliberate. Remind warns; this says where the `-` goes.
+FunctionRedefinition:
+  Enabled: true
+  Severity: warning
+
+# A variable SET inside a PUSH-VARS block the PUSH-VARS never named, so the
+# assignment survives the POP -- the one thing the block was there to stop.
+PushVarsMissingName:
+  Enabled: true
+  Severity: warning
+
+# A Remind callback defined with the wrong arity. Remind checks the shape and
+# walks away, so the callback is simply never called.
+CallbackSignature:
+  Enabled: true
+  Severity: warning
+
+# INCLUDE with a relative path, which resolves against the working directory
+# rather than the file's, or SYSINCLUDE with an absolute one.
+IncludePath:
+  Enabled: true
+  Severity: warning
+
+# easterdate(today()) in a trigger with an offset. On the day itself the
+# function has already jumped a year ahead, so the reminder never fires.
+EasterdateFromToday:
+  Enabled: true
+  Severity: warning
+
+# A TZ name the zone database does not have, or one differing only in case.
+# Reads /usr/share/zoneinfo; reports nothing where there is none to read.
+TimeZoneName:
+  Enabled: true
+  Severity: warning
+  # Where to look, if not TZDIR or /usr/share/zoneinfo.
+  Directory: ~
+
+# A reminder file anyone can write to. Remind refuses a world-writable script
+# outright; the mode is invisible in every editor.
+WorldWritableScript:
+  Enabled: true
+  Severity: error
+
+# A TODO with MAX-OVERDUE and no COMPLETE-THROUGH. The calculation then starts
+# at Remind's epoch, the task is decades overdue, and MAX-OVERDUE suppresses
+# it -- so the reminder never appears at all.
+TodoCompleteThrough:
+  Enabled: true
+  Severity: warning
+
+# ADDOMIT with no SCANFROM, which adds next year's date once the day itself
+# has passed -- so reminders skipping around the holiday are wrong from the
+# day after it. Remind 06.01.03+ warns; this says it without running.
+AddomitWithoutScanfrom:
+  Enabled: true
+  Severity: warning
+  # Ask for a minimum SCANFROM window as well. Zero accepts any. Chapter 4
+  # works through 28 days and include/holidays/us.rem uses that, but
+  # examples/defs.rem uses -7 throughout -- a smaller guarantee, not a bug.
+  MinimumWindow: 0
+
+# A TRANSLATE that is none of Remind's five forms, or whose translated string
+# does not carry the same % escapes in the same order as the original --
+# which Remind rejects, leaving the message in English.
+TranslateCommand:
+  Enabled: true
+  Severity: warning
+
+# A Hebrew month Remind does not know, or a day past that month's length. The
+# lengths were established by asking Remind across seven years, because
+# Heshvan and Kislev vary with the year.
+HebrewDate:
+  Enabled: true
+  Severity: error
+
+# A moon phase or solstice selector outside the four values it accepts.
+MoonPhaseArgument:
+  Enabled: true
+  Severity: error
+
+# A hand-written TAG in TkRemind's TKTAGn namespace, which makes the GUI edit
+# the wrong reminder with no diagnostic at all.
+TkTagNamespace:
+  Enabled: true
+  Severity: warning
+
+# Things a file does that its declared `# remlint:invocation` will not
+# deliver: an unreadable -g sort spec, INFO under plain -p, TODO in a
+# calendar. Silent for a file that declares no invocation.
+InvocationMismatch:
+  Enabled: true
+  Severity: warning
+
+# A language pack that never translates LANGID, so every script branching on
+# `_("LANGID")` takes the English path. A pack is recognised by its day and
+# month names; a file translating a handful of strings is not one.
+LocalizationPack:
+  Enabled: true
+  Severity: info
+
+# Hand-written commands in a file a tool owns and rewrites. Says nothing
+# until GeneratedFiles lists something -- the linter cannot guess a layout.
+GeneratedFileEdited:
+  Enabled: true
+  Severity: warning
+  GeneratedFiles: []
+
+# ---------------------------------------------------------------------------
+# Off by default: house style, and the one rule that executes the file.
+# ---------------------------------------------------------------------------
+
+# A SATISFY constraint the trigger could name directly, one no date can
+# satisfy, or a year bound that wants to be an UNTIL. The book measures the
+# first: 13.2M expression evaluations become 482K, and 2.30s becomes 0.58s.
+SatisfyConstraint:
+  Enabled: false
+  Severity: info
+
+# A reminder with a delta or an AT whose body never says when the event is.
+# Pairs with CalendarTextLimited: this one asks for %b, that one fences it.
+AdvanceWarningBody:
+  Enabled: false
+  Severity: info
+
+# A relative-date substitution with no %" ... %" limit, so it follows the
+# reminder into a calendar box where it is wrong.
+CalendarTextLimited:
+  Enabled: false
+  Severity: info
+
+# A single-sign delta in a file that omits nothing, where it is exactly the
+# doubled form -- so either the sign or an OMIT is missing.
+OmitAwareDelta:
+  Enabled: false
+  Severity: info
+
+# Command keywords in a case other than the file's own. Off because
+# examples/alignment.rem deliberately mixes MSG and msg to show they are the
+# same thing. EnforcedStyle: upper, lower, or consistent (the file's majority).
+KeywordCase:
+  Enabled: false
+  Severity: info
+  EnforcedStyle: upper
+
+# Physical lines past Max characters. Measured before continuations are joined,
+# so a command that was split to stay inside the margin is not penalised for it.
+LineLength:
+  Enabled: false
+  Severity: info
+  Max: 100
+
+# A licence identifier near the top of the file. Off because it is a project
+# policy, not a Remind fact -- but it is a policy Remind's own examples keep.
+LicenseHeader:
+  Enabled: false
+  Severity: info
+  Pattern: 'SPDX-License-Identifier:\s*\S+'
+  WithinLines: 10
+
+# Remind's own diagnostics, from running the file through Remind.
+#
+# OFF, AND DELIBERATELY SO. Remind has no parse-only mode, so this runs the
+# file. `-r` is passed to disable RUN directives, but INCLUDE still reads and
+# INCLUDECMD still executes. Turn it on for files you trust.
+Syntax:
+  Enabled: false
+  Severity: error
+  Command: remind