Variable LintingResults

Type Declaration

• allInvolvedIds: function

  • allInvolvedIds<
        L extends
            | "deprecated-functions"
            | "file-path-validity"
            | "seeded-randomness"
            | "absolute-file-paths"
            | "unused-definitions"
            | "naming-convention"
            | "network-functions"
            | "dataframe-access-validation"
            | "dead-code"
            | "useless-loop"
            | "problematic-eval"
            | "stop-call"
            | "roxygen-arguments",
    >(
        this: void,
        res: LintingResults<L> | undefined,
    ): Set<NodeId>

    Gets all involved node IDs from the given linting results. If the results represent an error, an empty set is returned.

    Type Parameters

    • L extends
          | "deprecated-functions"
          | "file-path-validity"
          | "seeded-randomness"
          | "absolute-file-paths"
          | "unused-definitions"
          | "naming-convention"
          | "network-functions"
          | "dataframe-access-validation"
          | "dead-code"
          | "useless-loop"
          | "problematic-eval"
          | "stop-call"
          | "roxygen-arguments"

    Parameters

    • this: void
    • res: LintingResults<L> | undefined

    Returns Set<NodeId>

• allLocations: function

  • allLocations<
        L extends
            | "deprecated-functions"
            | "file-path-validity"
            | "seeded-randomness"
            | "absolute-file-paths"
            | "unused-definitions"
            | "naming-convention"
            | "network-functions"
            | "dataframe-access-validation"
            | "dead-code"
            | "useless-loop"
            | "problematic-eval"
            | "stop-call"
            | "roxygen-arguments",
    >(
        this: void,
        res: LintingResults<L> | undefined,
    ): [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ][]

    Gets all locations from the given linting results, i.e. the loc property of all results that have a location.

    Type Parameters

    • L extends
          | "deprecated-functions"
          | "file-path-validity"
          | "seeded-randomness"
          | "absolute-file-paths"
          | "unused-definitions"
          | "naming-convention"
          | "network-functions"
          | "dataframe-access-validation"
          | "dead-code"
          | "useless-loop"
          | "problematic-eval"
          | "stop-call"
          | "roxygen-arguments"

    Parameters

    • this: void
    • res: LintingResults<L> | undefined

    Returns [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ][]

• hasLocation: function

  • hasLocation<R extends LintingResult>(
        this: void,
        res: R,
    ): res is R & {
        loc: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ];
    }

    Checks whether the given linting result has a location, i.e. whether it has a loc property.

    Type Parameters

    • R extends LintingResult

    Parameters

    • this: void
    • res: R

    Returns res is R & {
        loc: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ];
    }

• isError: function

  • isError<
        Name extends
            | "deprecated-functions"
            | "file-path-validity"
            | "seeded-randomness"
            | "absolute-file-paths"
            | "unused-definitions"
            | "naming-convention"
            | "network-functions"
            | "dataframe-access-validation"
            | "dead-code"
            | "useless-loop"
            | "problematic-eval"
            | "stop-call"
            | "roxygen-arguments",
    >(
        this: void,
        o: LintingResults<Name>,
    ): o is LintingResultsError

    Checks whether the given linting results represent an error.

    Type Parameters

    • Name extends
          | "deprecated-functions"
          | "file-path-validity"
          | "seeded-randomness"
          | "absolute-file-paths"
          | "unused-definitions"
          | "naming-convention"
          | "network-functions"
          | "dataframe-access-validation"
          | "dead-code"
          | "useless-loop"
          | "problematic-eval"
          | "stop-call"
          | "roxygen-arguments"

    Parameters

    • this: void
    • o: LintingResults<Name>

    Returns o is LintingResultsError

    See

    • LintingResultsError
    • LintingResults.isSuccess

• isSuccess: function

  • isSuccess<
        Name extends
            | "deprecated-functions"
            | "file-path-validity"
            | "seeded-randomness"
            | "absolute-file-paths"
            | "unused-definitions"
            | "naming-convention"
            | "network-functions"
            | "dataframe-access-validation"
            | "dead-code"
            | "useless-loop"
            | "problematic-eval"
            | "stop-call"
            | "roxygen-arguments",
    >(
        this: void,
        o: LintingResults<Name>,
    ): o is LintingResultsSuccess<Name>

    Checks whether the given linting results represent a successful execution.

    Type Parameters

    • Name extends
          | "deprecated-functions"
          | "file-path-validity"
          | "seeded-randomness"
          | "absolute-file-paths"
          | "unused-definitions"
          | "naming-convention"
          | "network-functions"
          | "dataframe-access-validation"
          | "dead-code"
          | "useless-loop"
          | "problematic-eval"
          | "stop-call"
          | "roxygen-arguments"

    Parameters

    • this: void
    • o: LintingResults<Name>

    Returns o is LintingResultsSuccess<Name>

    See

    • LintingResultsSuccess
    • LintingResults.isError
    • LintingResults.unpackSuccess

• stringifyError: function

  • stringifyError(this: void, __namedParameters: LintingResultsError): string

    Stringifies the error contained in the given linting results error.

    Parameters

    • this: void
    • __namedParameters: LintingResultsError

    Returns string

• unpackSuccess: function

  • unpackSuccess<
        Name extends
            | "deprecated-functions"
            | "file-path-validity"
            | "seeded-randomness"
            | "absolute-file-paths"
            | "unused-definitions"
            | "naming-convention"
            | "network-functions"
            | "dataframe-access-validation"
            | "dead-code"
            | "useless-loop"
            | "problematic-eval"
            | "stop-call"
            | "roxygen-arguments",
    >(
        this: void,
        o: LintingResults<Name>,
    ): LintingResultsSuccess<Name>

    Unpacks the given linting results, throwing an error if they represent an error.

    Type Parameters

    • Name extends
          | "deprecated-functions"
          | "file-path-validity"
          | "seeded-randomness"
          | "absolute-file-paths"
          | "unused-definitions"
          | "naming-convention"
          | "network-functions"
          | "dataframe-access-validation"
          | "dead-code"
          | "useless-loop"
          | "problematic-eval"
          | "stop-call"
          | "roxygen-arguments"

    Parameters

    • this: void
    • o: LintingResults<Name>

    Returns LintingResultsSuccess<Name>