Variable PACKAGE_HOOKS`Const`

PACKAGE_HOOKS: {
    createSearch: () => FlowrSearchBuilder<
        "from",
        [],
        ParentInformation,
        FlowrSearchElements<ParentInformation, (...)[]>,
    >;
    info: {
        certainty: BestEffort;
        defaultConfig: () => {
            allowedOutput: (...)[];
            followCalls: true;
            startupMessageFunctions: (...)[];
            unsafeCalls: (...)[];
        };
        description: "Finds problems in `.onLoad`, `.onAttach`, `.onDetach`, and `.Last.lib`: argument lists, attaching packages, output other than `packageStartupMessage()`, `installed.packages()`, misplaced `library.dynam()` calls, and the obsolete `.First.lib`. Follows calls into the package's own functions.";
        name: "Package Hooks";
        tags: readonly [CmdCheck, Bug, Usability, QuickFix];
    };
    prettyPrint: {
        full: (r: PackageHooksResult, metadata: unknown) => string;
        query: (r: PackageHooksResult, metadata: unknown) => string;
    };
    processSearchResult: (
        _elements: FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<(...)>[],
        >,
        config: PackageHooksConfig,
        data: ReadonlyFlowrAnalysisProvider<KnownParser>,
    ) => Promise<{ ".meta": { hooks: ... }; results: (...)[] }>;
} = ...

Port of the R CMD check notes on package hooks (checking R code for possible problems, from tools:::.check_package_code_startup_functions and tools:::.check_package_code_unload_functions).

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilder<
    "from",
    [],
    ParentInformation,
    FlowrSearchElements<ParentInformation, (...)[]>,
>
Readonlyinfo: {
    certainty: BestEffort;
    defaultConfig: () => {
        allowedOutput: (...)[];
        followCalls: true;
        startupMessageFunctions: (...)[];
        unsafeCalls: (...)[];
    };
    description: "Finds problems in `.onLoad`, `.onAttach`, `.onDetach`, and `.Last.lib`: argument lists, attaching packages, output other than `packageStartupMessage()`, `installed.packages()`, misplaced `library.dynam()` calls, and the obsolete `.First.lib`. Follows calls into the package's own functions.";
    name: "Package Hooks";
    tags: readonly [CmdCheck, Bug, Usability, QuickFix];
}
ReadonlyprettyPrint: {
full: (r: PackageHooksResult, metadata: unknown) => string;
query: (r: PackageHooksResult, metadata: unknown) => string;
}
ReadonlyprocessSearchResult: (
    _elements: FlowrSearchElements<
        ParentInformation,
        FlowrSearchElement<(...)>[],
    >,
    config: PackageHooksConfig,
    data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<{ ".meta": { hooks: ... }; results: (...)[] }>

Variable PACKAGE_HOOKS`Const`

Type Declaration

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

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

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

Settings

Variable PACKAGE_HOOKSConst

Type Declaration

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

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

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

Settings

Variable PACKAGE_HOOKS`Const`

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

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

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