Variable NON_ASCII_CODE`Const`

NON_ASCII_CODE: {
    createSearch: () => FlowrSearchBuilderOut<
        "all",
        [],
        ParentInformation,
        "filter",
    >;
    info: {
        certainty: BestEffort;
        defaultConfig: () => { checkStrings: true; checkSymbols: true };
        description: "Finds non-ASCII characters in R code and the NAMESPACE outside of comments. Offers `\\u` escapes for strings as a quick fix.";
        name: "Non-ASCII Code";
        tags: readonly [Smell, CmdCheck, QuickFix];
    };
    prettyPrint: {
        full: (r: NonAsciiCodeResult) => string;
        query: (r: NonAsciiCodeResult) => string;
    };
    processSearchResult: (
        elements: FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<(...)>[],
        >,
        config: NonAsciiCodeConfig,
        data: ReadonlyFlowrAnalysisProvider<KnownParser>,
    ) => {
        ".meta": { consideredTokens: number };
        results: NonAsciiCodeResult[];
    };
} = ...

Port of the R CMD check note "Found the following file with non-ASCII characters", from the check "checking code files for non-ASCII characters". Portable packages must use only ASCII in their R code outside of comments. Unlike the check, which only names the file, each offending string literal and symbol is reported with its characters. Comments and roxygen documentation are ignored, and so is code outside the R folder. The NAMESPACE file is inspected line by line, outside of comments, as R CMD check does.

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilderOut<"all", [], ParentInformation, "filter">
Readonlyinfo: {
    certainty: BestEffort;
    defaultConfig: () => { checkStrings: true; checkSymbols: true };
    description: "Finds non-ASCII characters in R code and the NAMESPACE outside of comments. Offers `\\u` escapes for strings as a quick fix.";
    name: "Non-ASCII Code";
    tags: readonly [Smell, CmdCheck, QuickFix];
}
ReadonlyprettyPrint: {
full: (r: NonAsciiCodeResult) => string;
query: (r: NonAsciiCodeResult) => string;
}
ReadonlyprocessSearchResult: (
    elements: FlowrSearchElements<
        ParentInformation,
        FlowrSearchElement<(...)>[],
    >,
    config: NonAsciiCodeConfig,
    data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => {
    ".meta": { consideredTokens: number };
    results: NonAsciiCodeResult[];
}

Variable NON_ASCII_CODE`Const`

Type Declaration

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

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

Settings

Variable NON_ASCII_CODEConst

Type Declaration

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

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

ReadonlyprocessSearchResult: ( elements: FlowrSearchElements< ParentInformation, FlowrSearchElement<(...)>[], >, config: NonAsciiCodeConfig, data: ReadonlyFlowrAnalysisProvider<KnownParser>,) => { ".meta": { consideredTokens: number }; results: NonAsciiCodeResult[];}

Settings

Variable NON_ASCII_CODE`Const`

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

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

`Readonly`processSearchResult: (
elements: FlowrSearchElements<
ParentInformation,
FlowrSearchElement<(...)>[],
>,
config: NonAsciiCodeConfig,
data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => {
".meta": { consideredTokens: number };
results: NonAsciiCodeResult[];
}