Interface LinterQuery

interface LinterQuery {
    format?: LinterOutputFormat;
    rules?: (
        | "deprecated-functions"
        | "file-path-validity"
        | "seeded-randomness"
        | "absolute-file-paths"
        | "unused-definitions"
        | "naming-convention"
        | "network-functions"
        | "dataframe-access-validation"
        | "dead-code"
        | "useless-loop"
        | "problematic-inputs"
        | "stop-call"
        | "roxygen-arguments"
        | "software-has-license"
        | "software-has-tests"
        | "no-leaked-credentials"
        | "undefined-symbol"
        | "syntactically-valid"
        | ConfiguredLintingRule<
            | "deprecated-functions"
            | "file-path-validity"
            | "seeded-randomness"
            | "absolute-file-paths"
            | "unused-definitions"
            | "naming-convention"
            | "network-functions"
            | "dataframe-access-validation"
            | "dead-code"
            | "useless-loop"
            | "problematic-inputs"
            | "stop-call"
            | "roxygen-arguments"
            | "software-has-license"
            | "software-has-tests"
            | "no-leaked-credentials"
            | "undefined-symbol"
            | "syntactically-valid",
        >
    )[];
    type: "linter";
}

Hierarchy (View Summary)

BaseQueryFormat
- LinterQuery

Hierarchy-Diagram

UML class diagram of LinterQuery

Index

Properties

format? rules? type

Properties

`Optional` `Readonly`format

format?: LinterOutputFormat

Print the findings in a machine-readable format instead of the human-readable summary.

`Optional` `Readonly`rules

rules?: (
    | "deprecated-functions"
    | "file-path-validity"
    | "seeded-randomness"
    | "absolute-file-paths"
    | "unused-definitions"
    | "naming-convention"
    | "network-functions"
    | "dataframe-access-validation"
    | "dead-code"
    | "useless-loop"
    | "problematic-inputs"
    | "stop-call"
    | "roxygen-arguments"
    | "software-has-license"
    | "software-has-tests"
    | "no-leaked-credentials"
    | "undefined-symbol"
    | "syntactically-valid"
    | ConfiguredLintingRule<
        | "deprecated-functions"
        | "file-path-validity"
        | "seeded-randomness"
        | "absolute-file-paths"
        | "unused-definitions"
        | "naming-convention"
        | "network-functions"
        | "dataframe-access-validation"
        | "dead-code"
        | "useless-loop"
        | "problematic-inputs"
        | "stop-call"
        | "roxygen-arguments"
        | "software-has-license"
        | "software-has-tests"
        | "no-leaked-credentials"
        | "undefined-symbol"
        | "syntactically-valid",
    >
)[]

The rules to lint for. If unset, all rules will be included. Optionally, a ConfiguredLintingRule can be provided, which additionally includes custom user-supplied values for the linting rules' configurations.

`Readonly`type

type: "linter"

used to select the query type :)