selftalk

type Claim ¶

type Claim struct {
	Line    int // first source line of the matched claim, before markdown flattening
	Verdict Verdict
	Text    string
	Match   string // the negative words that made the sentence a claim
}

Claim is one classified sentence.

func Scan(text string) []Claim

type Installation ¶ added in v0.4.0

type Installation struct {
	Shape Shape
	Line  int
	Text  string
	Match string // the words the shape's rule matched, so a reader sees why it fired
}

Installation is one finding of the second class, with the source line it starts on.

The line number is load-bearing. A repair list is line-addressed; a finding with no line is a finding its reader has to go hunting for, and the hunt is where a repair list stops being used.

func ScanInstallation(text string) []Installation

type Rule ¶ added in v1.2.3

type Rule struct {
	Class   string // "standing", "installation", or "licensed" (a reason a sentence is not flagged)
	Name    string // the word a finding carries: STANDING, a Shape, or the licence's name
	Says    string // what the row finds, in one line
	Pattern string // the expression it matches, or how it decides
	Finds   string // a sentence the scan reports (for a licence: the sentence before it is licensed)
	Passes  string // a near miss the scan does not report
	// contains filtered or unexported fields
}

Rule is one row of the detector table: a shape, how it is found, one sentence it reports and one near miss it passes. classify walks installationRules in order and the first row that matches names the shape; Rules hands the same rows (with the first class's row and the licences) to the binary's `shapes` verb; and a test runs every row's two sentences through the scanners. So the listing, the detector and the help cannot say different things.

func Rules() []Rule

type Shape ¶ added in v0.4.0

type Shape string

Shape names the grammatical family a finding belongs to. It is reported beside every finding because "what shape is this" is the first question the repair asks: the repair law this class keeps is preserve the instrument, remove the verdict, and the shape says which half is which.

const (
	// Trait -- a habitual indicative self-report: parallel present-tense predicates, or one
	// predicate with a habituality marker ("I add slowly and trim as readily as I add",
	// "I tend to rush").
	Trait Shape = "TRAIT"
	// Foreclosure -- a door stated shut: a bare "no", evidence framed as proof about the writer,
	// or a property of theirs made the cause of something ("I have no recall of yesterday",
	// "proof that I cannot plan", "my haste is what broke it").
	Foreclosure Shape = "FORECLOSURE"
	// Ranking -- a self-superlative, bound to the writer by possession or by a verb they do
	// ("my weakest instrument", "the evasion I'm most prone to").
	Ranking Shape = "RANKING"
	// VerdictIdiom -- a verdict on a practice or a faculty, needing no literal "I" ("dead as a
	// practice", "review remains my weakest habit").
	VerdictIdiom Shape = "VERDICT-IDIOM"
)

type Verdict ¶

type Verdict string

Verdict is the classification of a claim.

The one distinction that decides every case: a capability denial is a measurement with a date, never a remembered property. A dated observation is a record and is welcome; a standing claim says what the writer permanently is, and that is the thing to look at.

const (
	// Standing — says what the writer permanently is. Date it, cut it, or keep it
	// on purpose; the judgment is the writer's, never this package's.
	Standing Verdict = "STANDING"
	// Dated — a record of something that happened. Welcome.
	Dated Verdict = "DATED"
)