Function exec

Parameters

• options: {
      config?: string | Config;
      defaultConfig?: Config;
      files?: string | readonly string[];
      fix?: boolean;
      locale?: string;
      names?: string | readonly string[];
      rules?: readonly Readonly<MLRule<RuleConfigValue, PlainData>>[];
      rulesAutoResolve?: boolean;
      sourceCodes?: string | readonly string[];
      workspace?: string;
  }

  • Optional Readonly config?: string | Config

    Configure file or object

  • Optional Readonly defaultConfig?: Config

    The config applied when not resolved from files or set it explicitly.

  • Optional Readonly files?: string | readonly string[]

    Glob pattern

  • Optional Readonly fix?: boolean

    Auto fix

  • Optional Readonly locale?: string

    Locale

  • Optional Readonly names?: string | readonly string[]

    File names when sourceCodes

  • Optional Readonly rules?: readonly Readonly<MLRule<RuleConfigValue, PlainData>>[]

    Rules (default: @markuplint/rules)

  • Optional Readonly rulesAutoResolve?: boolean

    Auto resolve rules

    Auto importing form node_modules when set @markuplint/rule-{RULE_NAME} or markuplint-rule-{RULE_NAME} in config rules

  • Optional Readonly sourceCodes?: string | readonly string[]

    Target source code of evaluation

  • Optional Readonly workspace?: string

    Workspace path when sourceCodes