@eagleoutice/flowr
Version:
Static Dataflow Analyzer and Program Slicer for the R Programming Language
41 lines (40 loc) • 2.23 kB
TypeScript
import type { BaseQueryFormat, BaseQueryResult } from '../../base-query-format';
import type { ParsedQueryLine } from '../../query';
import Joi from 'joi';
import { executeLinterQuery } from './linter-query-executor';
import { type LintingRuleNames } from '../../../linter/linter-rules';
import { type ConfiguredLintingRule, LintingResults } from '../../../linter/linter-format';
import type { FlowrConfig } from '../../../config';
import type { ReplOutput } from '../../../cli/repl/commands/repl-main';
import type { CommandCompletions } from '../../../cli/repl/core';
export interface LinterQuery extends BaseQueryFormat {
readonly type: 'linter';
/**
* The rules to lint for. If unset, all rules will be included.
* Optionally, a {@link ConfiguredLintingRule} can be provided, which additionally includes custom user-supplied values for the linting rules' configurations.
*/
readonly rules?: (LintingRuleNames | ConfiguredLintingRule)[];
}
export interface LinterQueryResult extends BaseQueryResult {
/**
* The results of the linter query, which returns a set of linting results for each rule that was executed.
*/
readonly results: {
[L in LintingRuleNames]?: LintingResults<L>;
};
}
declare function linterQueryLineParser(output: ReplOutput, line: readonly string[], _config: FlowrConfig): ParsedQueryLine<'linter'>;
declare function linterQueryCompleter(line: readonly string[], startingNewArg: boolean, _config: FlowrConfig): CommandCompletions;
export declare const LinterQueryDefinition: {
readonly executor: typeof executeLinterQuery;
readonly asciiSummarizer: (formatter: import("../../../util/text/ansi").OutputFormatter, analyzer: import("../../../project/flowr-analyzer").ReadonlyFlowrAnalysisProvider<import("../../../r-bridge/parser").KnownParser>, queryResults: BaseQueryResult, result: string[]) => true;
readonly completer: typeof linterQueryCompleter;
readonly fromLine: typeof linterQueryLineParser;
readonly schema: Joi.ObjectSchema<any>;
readonly flattenInvolvedNodes: (queryResults: BaseQueryResult) => ((string & {
__brand?: "node-id";
}) | (number & {
__brand?: "node-id";
}))[];
};
export {};