Sign upLogin

zkoss/zk

View on GitHub
Star
eslint-plugin-zk/src/rules/tsdocValidation.ts

Summary

Maintainability
F
5 days
Test Coverage

Function create has a Cognitive Complexity of 115 (exceeds 5 allowed). Consider refactoring.
Open

    create(context) {
        const tsdocConfig = getTsdocConfig();
        if (!tsdocConfig) {
            return {};
        }
Severity: Minor
Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 2 days 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

Function create has 350 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    create(context) {
        const tsdocConfig = getTsdocConfig();
        if (!tsdocConfig) {
            return {};
        }
Severity: Major
Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 1 day to fix

    File tsdocValidation.ts has 405 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import { AST_TOKEN_TYPES, AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils';
// import { createRule, getParserServices } from '../util';
import {
    DocBlock,
    DocComment,
    Severity: Minor
    Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 5 hrs to fix

      Function transformJavadocParam has 48 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

              function transformJavadocParam(param: DocParamBlock): void {
            const { pos: start, end, buffer } = param.blockTag.getTokenSequence().getContainingTextRange();
            uselessParamPattern.lastIndex = end;
            if (uselessParamPattern.test(buffer)) {
                const lineEnd = uselessParamPattern.lastIndex;
      Severity: Minor
      Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 1 hr to fix

        Function ensureInternal has 39 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

                function ensureInternal(node: PropertyNameNonComputedNode, docComment: DocComment, tsdoc: TextRange): void {
            const name = getPropertyNameNonComputed(node);
            const isAnnotatedInternal = docComment.modifierTagSet.isInternal();
            if (name.startsWith('_') || name.endsWith('_')) {
                if (!isAnnotatedInternal) {
        Severity: Minor
        Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 1 hr to fix

          Function ensureTsdocHeaderNewline has 36 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

                  function ensureTsdocHeaderNewline(tsdoc: TextRange): void {
            const startOfDoc = sourceCode.getLocFromIndex(tsdoc.pos);
            if (startOfDoc.line === sourceCode.getLocFromIndex(tsdoc.end).line) {
                return; // TSDoc is single line.
            }
          Severity: Minor
          Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 1 hr to fix

            Function getTsdocConfig has 31 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                    function getTsdocConfig(): TSDocConfiguration | undefined {
            const tsdocConfig = new TSDocConfiguration();
            try {
                const tsdocConfigFile = getForSourceFile(context.getFilename());
                if (!tsdocConfigFile.fileNotFound) {
            Severity: Minor
            Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 1 hr to fix

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

                      function ensureSingleTsdoc(node: PropertyNameNonComputedNode, commentNode: TSESTree.Node | TSESTree.Token): TextRange | undefined {
            const comments = sourceCode.getCommentsBefore(commentNode);
            const tsdocs = new Array<TextRange>();
            const tsdocLocs = new Array<string>();
            for (const comment of comments) {
              Severity: Minor
              Found in eslint-plugin-zk/src/rules/tsdocValidation.ts - About 1 hr to fix

                Similar blocks of code found in 2 locations. Consider refactoring.
                Open

                                    try {
                        tsdocConfigFile.configureParser(tsdocConfig);
                    } catch (e) {
                        context.report({
                            loc: topOfFile,
                Severity: Minor
                Found in eslint-plugin-zk/src/rules/tsdocValidation.ts and 1 other location - About 50 mins to fix
                eslint-plugin-zk/src/rules/tsdocValidation.ts on lines 189..217

                Duplicated Code

                Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                Tuning

                This issue has a mass of 52.

                We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                Refactorings

                Further Reading

                Similar blocks of code found in 2 locations. Consider refactoring.
                Open

                            try {
                const tsdocConfigFile = getForSourceFile(context.getFilename());
                if (!tsdocConfigFile.fileNotFound) {
                    if (tsdocConfigFile.hasErrors) {
                        throw Error(`\n${tsdocConfigFile.getErrorSummary()}`);
                Severity: Minor
                Found in eslint-plugin-zk/src/rules/tsdocValidation.ts and 1 other location - About 50 mins to fix
                eslint-plugin-zk/src/rules/tsdocValidation.ts on lines 195..206

                Duplicated Code

                Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                Tuning

                This issue has a mass of 52.

                We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                Refactorings

                Further Reading

                There are no issues that match your filters.

                Category
                Status