Sign upLogin

avegao/aws-athena-node-client

View on GitHub
Star
src/index.ts

Summary

Maintainability
A
3 hrs
Test Coverage

Function setColumnParsers has 40 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private setColumnParsers(results: ResultSet): Column[] {
        return results.ResultSetMetadata?.ColumnInfo?.map((columnInfo, index) => {
            const name = columnInfo.Name ?? `column_${index}`;
            let parse: ColumnParse;
Severity: Minor
Found in src/index.ts - About 1 hr to fix

    Function startQueryExecution has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private async startQueryExecution<T>(query: Query<T>): Promise<string> {
        const input: StartQueryExecutionCommandInput = {
            QueryExecutionContext: {
                Database: this._config.database,
            },
    Severity: Minor
    Found in src/index.ts - About 1 hr to fix

      Function getQueryResults has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          private async getQueryResults<T extends object>(query: Query<T>, nextToken?: string): Promise<T[]> {
        const input: GetQueryResultsInput = {
            NextToken: nextToken,
            QueryExecutionId: query.athenaId,
        };
      Severity: Minor
      Found in src/index.ts - About 25 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Type assertion on object literals is forbidden, use a type annotation instead.
      Open

              const result = {} as T;
      Severity: Minor
      Found in src/index.ts by tslint

      Rule: no-object-literal-type-assertion

      Forbids an object literal to appear in a type assertion expression. Casting to any or to unknown is still allowed.

      Rationale

      Always prefer const x: T = { ... }; to const x = { ... } as T;. The type assertion in the latter case is either unnecessary or hides an error. The compiler will warn for excess properties with this syntax, but not missing required fields. For example: const x: { foo: number } = {} will fail to compile, but const x = {} as { foo: number } will succeed. Additionally, the const assertion const x = { foo: 1 } as const, introduced in TypeScript 3.4, is considered beneficial and is ignored by this rule.

      Notes
      • TypeScript Only

      Config

      One option may be configured:

      • allow-arguments allows type assertions to be used on object literals inside call expressions.
      Examples
      "no-object-literal-type-assertion": true
      "no-object-literal-type-assertion": true,[object Object]
      Schema
      {
  "type": "object",
  "properties": {
    "allow-arguments": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

      For more information see this page.

      There are no issues that match your filters.

      Category
      Status