jiahaog/nativefier

View on GitHub
app/src/components/menu.ts

Summary

Maintainability
F
3 days
Test Coverage

Function generateMenu has 291 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function generateMenu(
  options: {
    disableDevTools: boolean;
    nativefierVersion: string;
    zoom?: number;
Severity: Major
Found in app/src/components/menu.ts - About 1 day to fix

    File menu.ts has 398 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import * as fs from 'fs';
    import path from 'path';
    
    import {
      BrowserWindow,
    Severity: Minor
    Found in app/src/components/menu.ts - About 5 hrs to fix

      Function generateMenu has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
      Open

      export function generateMenu(
        options: {
          disableDevTools: boolean;
          nativefierVersion: string;
          zoom?: number;
      Severity: Minor
      Found in app/src/components/menu.ts - About 3 hrs 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 injectBookmarks has 50 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function injectBookmarks(menuTemplate: MenuItemConstructorOptions[]): void {
        const bookmarkConfigPath = path.join(__dirname, '..', 'bookmarks.json');
      
        if (!fs.existsSync(bookmarkConfigPath)) {
          return;
      Severity: Minor
      Found in app/src/components/menu.ts - About 2 hrs to fix

        Function injectBookmarks has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
        Open

        function injectBookmarks(menuTemplate: MenuItemConstructorOptions[]): void {
          const bookmarkConfigPath = path.join(__dirname, '..', 'bookmarks.json');
        
          if (!fs.existsSync(bookmarkConfigPath)) {
            return;
        Severity: Minor
        Found in app/src/components/menu.ts - 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 submenu has 31 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

              bookmarksMenuConfig.bookmarks.map((bookmark) => {
                switch (bookmark.type) {
                  case 'link':
                    if (!('title' in bookmark && 'url' in bookmark)) {
                      throw new Error(
        Severity: Minor
        Found in app/src/components/menu.ts - About 1 hr to fix

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

                  click: (): void => {
                    openExternal('https://github.com/nativefier/nativefier/issues').catch(
                      (err: unknown): void =>
                        log.error('Report an Issue.click ERROR', err),
                    );
          Severity: Minor
          Found in app/src/components/menu.ts and 1 other location - About 45 mins to fix
          app/src/components/menu.ts on lines 293..301

          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 50.

          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

                  click: (): void => {
                    openExternal('https://github.com/nativefier/nativefier').catch(
                      (err: unknown): void =>
                        log.error(
                          'Built with Nativefier v${nativefierVersion}.click ERROR',
          Severity: Minor
          Found in app/src/components/menu.ts and 1 other location - About 45 mins to fix
          app/src/components/menu.ts on lines 305..310

          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 50.

          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