Sign upLogin

KnodesCommunity/typedoc-plugins

View on GitHub
Star
packages/plugin-pages/src/output/theme/default-pages-renderer.tsx

Summary

Maintainability
A
3 hrs
Test Coverage
A
100%

Function _onRendererBeginPageAlterModel has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    private _onRendererBeginPageAlterModel( pageEvent: PageEvent<any> ) {
        if( pageEvent.model instanceof ANodeReflection ){
            const newModel = this._nodeDeclarationMappingCache.get( pageEvent.model );
            assert( newModel );
            this._addRestore( () => newModel.children, v => newModel.children = v );
Severity: Minor
Found in packages/plugin-pages/src/output/theme/default-pages-renderer.tsx - About 1 hr 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 _onRendererBeginPageAlterModel has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private _onRendererBeginPageAlterModel( pageEvent: PageEvent<any> ) {
        if( pageEvent.model instanceof ANodeReflection ){
            const newModel = this._nodeDeclarationMappingCache.get( pageEvent.model );
            assert( newModel );
            this._addRestore( () => newModel.children, v => newModel.children = v );
Severity: Minor
Found in packages/plugin-pages/src/output/theme/default-pages-renderer.tsx - About 1 hr to fix

    Function _onRendererBeginPageAlterNavigation has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        private _onRendererBeginPageAlterNavigation( pageEvent: PageEvent<any> ) {
        this._addRestore( () => pageEvent.project.children, prev => pageEvent.project.children = prev );
        const modelModule = getReflectionModule( pageEvent.model );
        const projectPages = this._modulesPages.find( p => p.module === pageEvent.project );
        pageEvent.project.children = [
    Severity: Minor
    Found in packages/plugin-pages/src/output/theme/default-pages-renderer.tsx - About 35 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

    There are no issues that match your filters.

    Category
    Status