Variable PACKAGE_METAFILES`Const`

PACKAGE_METAFILES: {
    createSearch: () => FlowrSearchBuilder<
        "from",
        [],
        ParentInformation,
        FlowrSearchElements<ParentInformation, (...)[]>,
    >;
    info: {
        certainty: BestEffort;
        defaultConfig: () => {
            citation: true;
            index: true;
            relativeLinks: true;
            superseded: true;
        };
        description: "Finds problems in the demo index, `INDEX`, `inst/CITATION`, and relative links in README, NEWS, and vignettes.";
        name: "Package Metafiles";
        tags: readonly [CmdCheck, Robustness];
    };
    prettyPrint: {
        full: (r: PackageMetafilesResult, metadata: unknown) => string;
        query: (r: PackageMetafilesResult, metadata: unknown) => string;
    };
    processSearchResult: (
        _elements: unknown,
        config: PackageMetafilesConfig,
        data: ReadonlyFlowrAnalysisProvider,
    ) =>
        | PromiseLike<{ ".meta": ...; results: ... }>
        | { ".meta": { checkedFiles: ... }; results: (...)[] };
} = ...

Port of the R CMD check notes on INDEX, demo/00Index, inst/CITATION, CITATION locations, and relative links of README, NEWS and vignettes.

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilder<
    "from",
    [],
    ParentInformation,
    FlowrSearchElements<ParentInformation, (...)[]>,
>
Readonlyinfo: {
    certainty: BestEffort;
    defaultConfig: () => {
        citation: true;
        index: true;
        relativeLinks: true;
        superseded: true;
    };
    description: "Finds problems in the demo index, `INDEX`, `inst/CITATION`, and relative links in README, NEWS, and vignettes.";
    name: "Package Metafiles";
    tags: readonly [CmdCheck, Robustness];
}
ReadonlyprettyPrint: {
full: (r: PackageMetafilesResult, metadata: unknown) => string;
query: (r: PackageMetafilesResult, metadata: unknown) => string;
}
ReadonlyprocessSearchResult: (
    _elements: unknown,
    config: PackageMetafilesConfig,
    data: ReadonlyFlowrAnalysisProvider,
) =>
    | PromiseLike<{ ".meta": ...; results: ... }>
    | { ".meta": { checkedFiles: ... }; results: (...)[] }

Variable PACKAGE_METAFILES`Const`

Type Declaration

`Readonly`createSearch: () => FlowrSearchBuilder<
    "from",
    [],
    ParentInformation,
    FlowrSearchElements<ParentInformation, (...)[]>,
>

`Readonly`prettyPrint: {
full: (r: PackageMetafilesResult, metadata: unknown) => string;
query: (r: PackageMetafilesResult, metadata: unknown) => string;
}

`Readonly`processSearchResult: (
    _elements: unknown,
    config: PackageMetafilesConfig,
    data: ReadonlyFlowrAnalysisProvider,
) =>
    | PromiseLike<{ ".meta": ...; results: ... }>
    | { ".meta": { checkedFiles: ... }; results: (...)[] }

Settings

Variable PACKAGE_METAFILESConst

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilder< "from", [], ParentInformation, FlowrSearchElements<ParentInformation, (...)[]>,>

ReadonlyprettyPrint: { full: (r: PackageMetafilesResult, metadata: unknown) => string; query: (r: PackageMetafilesResult, metadata: unknown) => string;}

ReadonlyprocessSearchResult: ( _elements: unknown, config: PackageMetafilesConfig, data: ReadonlyFlowrAnalysisProvider,) => | PromiseLike<{ ".meta": ...; results: ... }> | { ".meta": { checkedFiles: ... }; results: (...)[] }

Settings

Variable PACKAGE_METAFILES`Const`

`Readonly`createSearch: () => FlowrSearchBuilder<
"from",
[],
ParentInformation,
FlowrSearchElements<ParentInformation, (...)[]>,
>

`Readonly`prettyPrint: {
full: (r: PackageMetafilesResult, metadata: unknown) => string;
query: (r: PackageMetafilesResult, metadata: unknown) => string;
}

`Readonly`processSearchResult: (
_elements: unknown,
config: PackageMetafilesConfig,
data: ReadonlyFlowrAnalysisProvider,
) =>
| PromiseLike<{ ".meta": ...; results: ... }>
| { ".meta": { checkedFiles: ... }; results: (...)[] }