Variable UNUSED_IMPORT`Const`

UNUSED_IMPORT: {
    createSearch: () => FlowrSearchBuilder<
        "from-query",
        [],
        ParentInformation,
        FlowrSearchElements<ParentInformation, (...)[]>,
    >;
    info: {
        certainty: BestEffort;
        defaultConfig: { whitelist: readonly [] };
        description: "Highlights packages that are attached but never used, so the code runs just the same without them. Requires a signature database, and packages that only do their work on load should be whitelisted in the configuration.";
        name: "Unused Import";
        tags: readonly [Smell, Readability, QuickFix];
    };
    prettyPrint: {
        full: (result: UnusedImportResult) => string;
        query: (result: UnusedImportResult) => string;
    };
    processSearchResult: (
        elements: FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<(...)>[],
        >,
        config: UnusedImportConfig,
        data: ReadonlyFlowrAnalysisProvider<KnownParser>,
    ) => Promise<{ ".meta": UnusedImportMetadata; results: (...)[] }>;
} = ...

Flags packages that are attached but never used, so dropping the library/require call would leave the code running just the same. A package counts as used as soon as any call resolves into it or anything reads one of its exports.

Needs a signature database to know what a package exports; without one the rule reports nothing. Packages the database does not know, packages whose namespace loads with side effects, and those in the whitelist are skipped. Every step errs towards keeping an import.

Type Declaration

ReadonlycreateSearch: () => FlowrSearchBuilder<
    "from-query",
    [],
    ParentInformation,
    FlowrSearchElements<ParentInformation, (...)[]>,
>
Readonlyinfo: {
    certainty: BestEffort;
    defaultConfig: { whitelist: readonly [] };
    description: "Highlights packages that are attached but never used, so the code runs just the same without them. Requires a signature database, and packages that only do their work on load should be whitelisted in the configuration.";
    name: "Unused Import";
    tags: readonly [Smell, Readability, QuickFix];
}
ReadonlyprettyPrint: {
full: (result: UnusedImportResult) => string;
query: (result: UnusedImportResult) => string;
}
ReadonlyprocessSearchResult: (
    elements: FlowrSearchElements<
        ParentInformation,
        FlowrSearchElement<(...)>[],
    >,
    config: UnusedImportConfig,
    data: ReadonlyFlowrAnalysisProvider<KnownParser>,
) => Promise<{ ".meta": UnusedImportMetadata; results: (...)[] }>

Variable UNUSED_IMPORT`Const`

Type Declaration

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

`Readonly`prettyPrint: {
full: (result: UnusedImportResult) => string;
query: (result: UnusedImportResult) => string;
}

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

Settings

Variable UNUSED_IMPORTConst

Type Declaration

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

ReadonlyprettyPrint: { full: (result: UnusedImportResult) => string; query: (result: UnusedImportResult) => string;}

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

Settings

Variable UNUSED_IMPORT`Const`

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

`Readonly`prettyPrint: {
full: (result: UnusedImportResult) => string;
query: (result: UnusedImportResult) => string;
}

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