Variable CLASS_STRING_COMPARISON`Const`

CLASS_STRING_COMPARISON: {
    createSearch: () => FlowrSearchBuilderOut<
        "all",
        [],
        ParentInformation,
        "filter",
    >;
    info: {
        certainty: BestEffort;
        defaultConfig: () => { checkWhile: true; resolveStrings: true };
        description: "Finds `if`/`while` conditions comparing `class(x)` with a string, which fail for objects with several classes. Offers `inherits(x, ...)` as a quick fix.";
        name: "Class String Comparison";
        tags: readonly [CmdCheck, Bug, Robustness, QuickFix];
    };
    prettyPrint: {
        full: (r: ClassStringComparisonResult) => string;
        query: (r: ClassStringComparisonResult) => string;
    };
    processSearchResult: (
        elements: FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<(...)>[],
        >,
        config: ClassStringComparisonConfig,
        data: ReadonlyFlowrAnalysisProvider<KnownParser>,
    ) => Promise<{ ".meta": { consideredConditions: ... }; results: (...)[] }>;
} = ...

Port of the R CMD check note "Found if() conditions comparing class() to string" (checking R code for possible problems, _R_CHECK_CODE_CLASS_IS_STRING_). As an object may have more than one class, class(x) == "a" gives a condition longer than one (an error since R 4.2) or misses a subclass; inherits(x, "a") is what is meant.

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilderOut<"all", [], ParentInformation, "filter">
Readonlyinfo: {
    certainty: BestEffort;
    defaultConfig: () => { checkWhile: true; resolveStrings: true };
    description: "Finds `if`/`while` conditions comparing `class(x)` with a string, which fail for objects with several classes. Offers `inherits(x, ...)` as a quick fix.";
    name: "Class String Comparison";
    tags: readonly [CmdCheck, Bug, Robustness, QuickFix];
}
ReadonlyprettyPrint: {
full: (r: ClassStringComparisonResult) => string;
query: (r: ClassStringComparisonResult) => string;
}
ReadonlyprocessSearchResult: (
    elements: FlowrSearchElements<
        ParentInformation,
        FlowrSearchElement<(...)>[],
    >,
    config: ClassStringComparisonConfig,
    data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<{ ".meta": { consideredConditions: ... }; results: (...)[] }>

Variable CLASS_STRING_COMPARISON`Const`

Type Declaration

`Readonly`createSearch: () => FlowrSearchBuilderOut<"all", [], ParentInformation, "filter">

`Readonly`prettyPrint: {
full: (r: ClassStringComparisonResult) => string;
query: (r: ClassStringComparisonResult) => string;
}

Settings

Variable CLASS_STRING_COMPARISONConst

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilderOut<"all", [], ParentInformation, "filter">

ReadonlyprettyPrint: { full: (r: ClassStringComparisonResult) => string; query: (r: ClassStringComparisonResult) => string;}

ReadonlyprocessSearchResult: ( elements: FlowrSearchElements< ParentInformation, FlowrSearchElement<(...)>[], >, config: ClassStringComparisonConfig, data: ReadonlyFlowrAnalysisProvider<KnownParser>,) => Promise<{ ".meta": { consideredConditions: ... }; results: (...)[] }>

Settings

Variable CLASS_STRING_COMPARISON`Const`

`Readonly`createSearch: () => FlowrSearchBuilderOut<"all", [], ParentInformation, "filter">

`Readonly`prettyPrint: {
full: (r: ClassStringComparisonResult) => string;
query: (r: ClassStringComparisonResult) => string;
}

`Readonly`processSearchResult: (
elements: FlowrSearchElements<
ParentInformation,
FlowrSearchElement<(...)>[],
>,
config: ClassStringComparisonConfig,
data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<{ ".meta": { consideredConditions: ... }; results: (...)[] }>