Class MLRule<T, O>

Type Parameters

T extends RuleConfigValue
O extends PlainData = undefined

Hierarchy

MLRule

Index

Constructors

constructor

new MLRule<T, O>(o: Readonly<RuleSeed<T, O>> & {
name: string;
}): MLRule<T, O>
Type Parameters
- T extends RuleConfigValue
- O extends PlainData = undefined
Parameters
- o: Readonly<RuleSeed<T, O>> & {
  name: string;
  }
Returns MLRule<T, O>
- Defined in @markuplint/ml-core/src/ml-rule/ml-rule.ts:30

Properties

`Private` #f

#f: undefined | ((context: {
    document: Document<T, O>;
    report: {
        (report: Report<T, O>): undefined;
        (report: CheckerReport<T, O>): boolean;
    };
    reports: ({
        message: string;
    } | {
        message: string;
    } | {
        message: string;
    })[];
    t: Translator;
    translate: Translator;
}) => void | Promise<void>)

`Private` #v

#v: ((context: {
    document: Document<T, O>;
    report: {
        (report: Report<T, O>): undefined;
        (report: CheckerReport<T, O>): boolean;
    };
    reports: ({
        message: string;
    } | {
        message: string;
    } | {
        message: string;
    })[];
    t: Translator;
    translate: Translator;
}) => void | Promise<void>)

Type declaration

- (context: {
      document: Document<T, O>;
      report: {
          (report: Report<T, O>): undefined;
          (report: CheckerReport<T, O>): boolean;
      };
      reports: ({
          message: string;
      } | {
          message: string;
      } | {
          message: string;
      })[];
      t: Translator;
      translate: Translator;
  }): void | Promise<void>
- Parameters
  - context: {
        document: Document<T, O>;
        report: {
            (report: Report<T, O>): undefined;
            (report: CheckerReport<T, O>): boolean;
        };
        reports: ({
            message: string;
        } | {
            message: string;
        } | {
            message: string;
        })[];
        t: Translator;
        translate: Translator;
    }
    - document: Document<T, O>
    - report: {
      (report: Report<T, O>): undefined;
      (report: CheckerReport<T, O>): boolean;
      }
      
      (report: Report<T, O>): undefined
      
      Parameters
      
      report: Report<T, O>
      
      Returns undefined
      
      (report: CheckerReport<T, O>): boolean
      
      Parameters
      
      report: CheckerReport<T, O>
      
      Returns boolean
    - reports: ({
          message: string;
      } | {
          message: string;
      } | {
          message: string;
      })[]
    - t: Translator
    - translate: Translator
  Returns void | Promise<void>

`Readonly` defaultOptions

defaultOptions: O

`Readonly` defaultSeverity

defaultSeverity: Severity

`Readonly` defaultValue

defaultValue: T

`Readonly` name

name: string

Accessors

`Protected` f

get f(): undefined | ((context: {
    document: Document<T, O>;
    report: {
        (report: Report<T, O>): undefined;
        (report: CheckerReport<T, O>): boolean;
    };
    reports: ({
        message: string;
    } | {
        message: string;
    } | {
        message: string;
    })[];
    t: Translator;
    translate: Translator;
}) => void | Promise<void>)
The following getter is unused internally, only for extending from 3rd party library

Returns undefined | ((context: {
    document: Document<T, O>;
    report: {
        (report: Report<T, O>): undefined;
        (report: CheckerReport<T, O>): boolean;
    };
    reports: ({
        message: string;
    } | {
        message: string;
    } | {
        message: string;
    })[];
    t: Translator;
    translate: Translator;
}) => void | Promise<void>)
- Defined in @markuplint/ml-core/src/ml-rule/ml-rule.ts:44

`Protected` v

get v(): ((context: {
    document: Document<T, O>;
    report: {
        (report: Report<T, O>): undefined;
        (report: CheckerReport<T, O>): boolean;
    };
    reports: ({
        message: string;
    } | {
        message: string;
    } | {
        message: string;
    })[];
    t: Translator;
    translate: Translator;
}) => void | Promise<void>)
The following getter is unused internally, only for extending from 3rd party library

Returns ((context: {
    document: Document<T, O>;
    report: {
        (report: Report<T, O>): undefined;
        (report: CheckerReport<T, O>): boolean;
    };
    reports: ({
        message: string;
    } | {
        message: string;
    } | {
        message: string;
    })[];
    t: Translator;
    translate: Translator;
}) => void | Promise<void>)
- - (context: {
        document: Document<T, O>;
        report: {
            (report: Report<T, O>): undefined;
            (report: CheckerReport<T, O>): boolean;
        };
        reports: ({
            message: string;
        } | {
            message: string;
        } | {
            message: string;
        })[];
        t: Translator;
        translate: Translator;
    }): void | Promise<void>
  - Parameters
    - context: {
          document: Document<T, O>;
          report: {
              (report: Report<T, O>): undefined;
              (report: CheckerReport<T, O>): boolean;
          };
          reports: ({
              message: string;
          } | {
              message: string;
          } | {
              message: string;
          })[];
          t: Translator;
          translate: Translator;
      }
      
      document: Document<T, O>
      
      report: {
          (report: Report<T, O>): undefined;
          (report: CheckerReport<T, O>): boolean;
      }
      
      (report: Report<T, O>): undefined
      
      Parameters
      
      report: Report<T, O>
      
      Returns undefined
      
      (report: CheckerReport<T, O>): boolean
      
      Parameters
      
      report: CheckerReport<T, O>
      
      Returns boolean
      
      reports: ({
          message: string;
      } | {
          message: string;
      } | {
          message: string;
      })[]
      
      t: Translator
      
      translate: Translator
    Returns void | Promise<void>
- Defined in @markuplint/ml-core/src/ml-rule/ml-rule.ts:52

Methods

`Private` _optimize

_optimize(rules: undefined | Rules, ruleName: string): RuleInfo<T, O>
Parameters
- rules: undefined | Rules
- ruleName: string
Returns RuleInfo<T, O>
- Defined in @markuplint/ml-core/src/ml-rule/ml-rule.ts:152

getRuleInfo

getRuleInfo(ruleSet: Ruleset, ruleName: string): GlobalRuleInfo<T, O>
Parameters
- ruleSet: Ruleset
- ruleName: string
Returns GlobalRuleInfo<T, O>
- Defined in @markuplint/ml-core/src/ml-rule/ml-rule.ts:56

optimizeOption

optimizeOption(configSettings: undefined | null | Rule<T, O>): RuleInfo<T, O>
Parameters
- configSettings: undefined | null | Rule<T, O>
Returns RuleInfo<T, O>
- Defined in @markuplint/ml-core/src/ml-rule/ml-rule.ts:66

verify

verify(document: Document<T, O>, locale: LocaleSet, fix: boolean): Promise<Violation[]>
Parameters
- document: Document<T, O>
- locale: LocaleSet
- fix: boolean
Returns Promise<Violation[]>
- Defined in @markuplint/ml-core/src/ml-rule/ml-rule.ts:94

Class MLRule<T, O>

Type Parameters

T extends RuleConfigValue

O extends PlainData = undefined

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends RuleConfigValue

O extends PlainData = undefined

Parameters

o: Readonly<RuleSeed<T, O>> & { name: string; }

Returns MLRule<T, O>

Properties

Private #f

Private #v

Type declaration

Parameters

context: { document: Document<T, O>; report: { (report: Report<T, O>): undefined; (report: CheckerReport<T, O>): boolean; }; reports: ({ message: string; } | { message: string; } | { message: string; })[]; t: Translator; translate: Translator; }

document: Document<T, O>

report: { (report: Report<T, O>): undefined; (report: CheckerReport<T, O>): boolean; }

Parameters

report: Report<T, O>

Returns undefined

Parameters

report: CheckerReport<T, O>

Returns boolean

reports: ({ message: string; } | { message: string; } | { message: string; })[]

t: Translator

translate: Translator

Returns void | Promise<void>

Readonly defaultOptions

Readonly defaultSeverity

Readonly defaultValue

Readonly name

Accessors

Protected f

Returns undefined | ((context: { document: Document<T, O>; report: { (report: Report<T, O>): undefined; (report: CheckerReport<T, O>): boolean; }; reports: ({ message: string; } | { message: string; } | { message: string; })[]; t: Translator; translate: Translator; }) => void | Promise<void>)

Protected v

Returns ((context: { document: Document<T, O>; report: { (report: Report<T, O>): undefined; (report: CheckerReport<T, O>): boolean; }; reports: ({ message: string; } | { message: string; } | { message: string; })[]; t: Translator; translate: Translator; }) => void | Promise<void>)

Parameters

context: { document: Document<T, O>; report: { (report: Report<T, O>): undefined; (report: CheckerReport<T, O>): boolean; }; reports: ({ message: string; } | { message: string; } | { message: string; })[]; t: Translator; translate: Translator; }

document: Document<T, O>

report: { (report: Report<T, O>): undefined; (report: CheckerReport<T, O>): boolean; }

Parameters

report: Report<T, O>

Returns undefined

Parameters

report: CheckerReport<T, O>

Returns boolean

reports: ({ message: string; } | { message: string; } | { message: string; })[]

t: Translator

translate: Translator

Returns void | Promise<void>

Methods

Private _optimize

Parameters

rules: undefined | Rules

ruleName: string

Returns RuleInfo<T, O>

getRuleInfo

Parameters

ruleSet: Ruleset

ruleName: string

Returns GlobalRuleInfo<T, O>

optimizeOption

Parameters

configSettings: undefined | null | Rule<T, O>

Returns RuleInfo<T, O>

verify

Parameters

document: Document<T, O>

locale: LocaleSet

fix: boolean

Returns Promise<Violation[]>

o: Readonly<RuleSeed<T, O>> & {
name: string;
}

`Private` #f

`Private` #v

context: {
document: Document<T, O>;
report: {
(report: Report<T, O>): undefined;
(report: CheckerReport<T, O>): boolean;
};
reports: ({
message: string;
} | {
message: string;
} | {
message: string;
})[];
t: Translator;
translate: Translator;
}

report: {
(report: Report<T, O>): undefined;
(report: CheckerReport<T, O>): boolean;
}

reports: ({
message: string;
} | {
message: string;
} | {
message: string;
})[]

`Readonly` defaultOptions

`Readonly` defaultSeverity

`Readonly` defaultValue

`Readonly` name

`Protected` f

Returns undefined | ((context: {
document: Document<T, O>;
report: {
(report: Report<T, O>): undefined;
(report: CheckerReport<T, O>): boolean;
};
reports: ({
message: string;
} | {
message: string;
} | {
message: string;
})[];
t: Translator;
translate: Translator;
}) => void | Promise<void>)

`Protected` v

Returns ((context: {
document: Document<T, O>;
report: {
(report: Report<T, O>): undefined;
(report: CheckerReport<T, O>): boolean;
};
reports: ({
message: string;
} | {
message: string;
} | {
message: string;
})[];
t: Translator;
translate: Translator;
}) => void | Promise<void>)

context: {
document: Document<T, O>;
report: {
(report: Report<T, O>): undefined;
(report: CheckerReport<T, O>): boolean;
};
reports: ({
message: string;
} | {
message: string;
} | {
message: string;
})[];
t: Translator;
translate: Translator;
}

report: {
(report: Report<T, O>): undefined;
(report: CheckerReport<T, O>): boolean;
}

reports: ({
message: string;
} | {
message: string;
} | {
message: string;
})[]

`Private` _optimize