Sign upLogin

MaxMilton/microdoc

View on GitHub
Star

Showing 11 of 11 total issues

Function normaliseRoutes has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
Open

function normaliseRoutes(routes: Routes, parent?: InternalRoute) {
  for (let index = 0; index < routes.length; index++) {
    if (typeof routes[index] === 'string') {
      // eslint-disable-next-line no-param-reassign
      routes[index] = {
Severity: Minor
Found in src/router.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 Router has 52 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function Router(): RouterComponent {
  const root = view;

  const loadRoute = (path: string) => {
    if (!path || path === '/') {
Severity: Major
Found in src/router.ts - About 2 hrs to fix

    Function loadRoute has 45 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      const loadRoute = (path: string) => {
    if (!path || path === '/') {
      const [[firstRoute]] = $routes;
      routeTo(firstRoute);
      return;
    Severity: Minor
    Found in src/router.ts - About 1 hr to fix

      Function Search has 34 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function Search(): SearchComponent {
  const root = searchView as SearchComponent;
  const { button, input } = searchView.collect<SearchRefNodes>(root);

  const search = () => {
      Severity: Minor
      Found in src/plugin/search.ts - About 1 hr to fix

        Function normaliseRoutes has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function normaliseRoutes(routes: Routes, parent?: InternalRoute) {
  for (let index = 0; index < routes.length; index++) {
    if (typeof routes[index] === 'string') {
      // eslint-disable-next-line no-param-reassign
      routes[index] = {
        Severity: Minor
        Found in src/router.ts - About 1 hr to fix

          Function Search has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

          function Search(): SearchComponent {
  const root = searchView as SearchComponent;
  const { button, input } = searchView.collect<SearchRefNodes>(root);

  const search = () => {
          Severity: Minor
          Found in src/plugin/search.ts - About 55 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

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

            n.__click = () => {
    window.location.hash = [...$routes.keys()][currentRouteIndex() + 1];
  };
          Severity: Minor
          Found in src/plugin/prevnext.ts and 1 other location - About 55 mins to fix
          src/plugin/prevnext.ts on lines 43..45

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

          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

            p.__click = () => {
    window.location.hash = [...$routes.keys()][currentRouteIndex() - 1];
  };
          Severity: Minor
          Found in src/plugin/prevnext.ts and 1 other location - About 55 mins to fix
          src/plugin/prevnext.ts on lines 46..48

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

          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

          Consider simplifying this complex logical expression.
          Open

            if (
    event.ctrlKey ||
    event.metaKey ||
    event.altKey ||
    event.shiftKey ||
          Severity: Major
          Found in src/router.ts - About 40 mins to fix

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

            async function loadContent() {
  const files: [fetchRes: Promise<Response>, title: string, url: string][] = [];
  const content = [];

  $routes.forEach((route) => {
            Severity: Minor
            Found in src/plugin/search.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

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

            export function Router(): RouterComponent {
  const root = view;

  const loadRoute = (path: string) => {
    if (!path || path === '/') {
            Severity: Minor
            Found in src/router.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

            Severity
            Category
            Status
            Source
            Language