Function assertLinter

assertLinter<
    Name extends
        | "deprecated-functions"
        | "file-path-validity"
        | "seeded-randomness"
        | "absolute-file-paths"
        | "unused-definitions"
        | "naming-convention"
        | "network-functions"
        | "dataframe-access-validation"
        | "dead-code"
        | "useless-loop"
        | "problematic-eval"
        | "stop-call"
        | "roxygen-arguments",
>(
    name: string | TestLabel,
    parser: KnownParser,
    code: string,
    ruleName: Name,
    expected:
        | Omit<LintingRuleResult<Name>, "involvedId">[]
        | (
            (
                df: DataflowInformation,
                ast: NormalizedAst,
            ) => Omit<LintingRuleResult<Name>, "involvedId">[]
        ),
    expectedMetadata?: LintingRuleMetadata<Name>,
    lintingRuleConfig?: DeepPartial<LintingRuleConfig<Name>> & {
        addFiles?: FlowrFileProvider<{ toString(): string }>[];
        useAsFilePath?: string;
    },
): void
Asserts correct linting results while ignoring each linting result's LintingRuleResult.involvedId.
Type Parameters
- Name extends
      | "deprecated-functions"
      | "file-path-validity"
      | "seeded-randomness"
      | "absolute-file-paths"
      | "unused-definitions"
      | "naming-convention"
      | "network-functions"
      | "dataframe-access-validation"
      | "dead-code"
      | "useless-loop"
      | "problematic-eval"
      | "stop-call"
      | "roxygen-arguments"
Parameters
- name: string | TestLabel
- parser: KnownParser
- code: string
- ruleName: Name
- expected:
      | Omit<LintingRuleResult<Name>, "involvedId">[]
      | (
          (
              df: DataflowInformation,
              ast: NormalizedAst,
          ) => Omit<LintingRuleResult<Name>, "involvedId">[]
      )
- OptionalexpectedMetadata: LintingRuleMetadata<Name>
- OptionallintingRuleConfig: DeepPartial<LintingRuleConfig<Name>> & {
  addFiles?: FlowrFileProvider<{ toString(): string }>[];
  useAsFilePath?: string;
  }
Returns void
- Defined in test/functionality/_helper/linter.ts:35

Function assertLinter

Type Parameters

Parameters

Returns void

Settings