Sign upLogin

stoplightio/markdown

View on GitHub
Star

Showing 69 of 69 total issues

File reader.spec.ts has 434 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import * as fs from 'fs';
import * as path from 'path';
import html from 'remark-html';
import unified from 'unified';
Severity: Minor
Found in src/reader/__tests__/reader.spec.ts - About 6 hrs to fix

    Function computeMetaProps has a Cognitive Complexity of 41 (exceeds 5 allowed). Consider refactoring.
    Open

    function computeMetaProps(annotations: object) {
  const metaProps = [];
  if (Object.keys(annotations).length) {
    for (const key in annotations) {
      const annotationVal = annotations[key];
    Severity: Minor
    Found in src/plugins/stringify/code.ts - About 6 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 smdAnnotations has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
    Open

    export const smdAnnotations: unified.Attacher = function () {
  return function transform($root) {
    const root = $root as MDAST.Root;
    const nodes = root.children;
    Severity: Minor
    Found in src/plugins/run/annotations.ts - About 5 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

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

                      {
                    type: 'emphasis',
                    children: [
                      {
                        type: 'text',
    Severity: Major
    Found in src/reader/__tests__/reader.spec.ts and 1 other location - About 4 hrs to fix
    src/reader/__tests__/reader.spec.ts on lines 31..63

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

    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

        it.each`
      start      | end         | path
      ${[0, 0]}  | ${[21, 0]}  | ${[]}
      ${[0, 0]}  | ${[0, 10]}  | ${['children', 0]}
      ${[2, 0]}  | ${[2, 31]}  | ${['children', 1, 'children', 0]}
    Severity: Major
    Found in src/__tests__/getLocationForJsonPath.spec.ts and 1 other location - About 4 hrs to fix
    src/__tests__/getJsonPathForPosition.spec.ts on lines 16..31

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

    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

        it.each`
      line  | character | path
      ${0}  | ${0}      | ${['children', 0]}
      ${2}  | ${18}     | ${['children', 1, 'children', 0]}
      ${2}  | ${37}     | ${['children', 1, 'children', 1, 'children', 0]}
    Severity: Major
    Found in src/__tests__/getJsonPathForPosition.spec.ts and 1 other location - About 4 hrs to fix
    src/__tests__/getLocationForJsonPath.spec.ts on lines 16..31

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

    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

              {
            type: 'paragraph',
            children: [
              {
                type: 'text',
    Severity: Major
    Found in src/reader/__tests__/reader.spec.ts and 1 other location - About 4 hrs to fix
    src/reader/__tests__/reader.spec.ts on lines 108..140

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

    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

    Function smdAnnotations has 91 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export const smdAnnotations: unified.Attacher = function () {
  return function transform($root) {
    const root = $root as MDAST.Root;
    const nodes = root.children;
    Severity: Major
    Found in src/plugins/run/annotations.ts - About 3 hrs to fix

      Function transform has 89 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        return function transform($root) {
    const root = $root as MDAST.Root;
    const nodes = root.children;

    const processed: MDAST.Content[] = [];
      Severity: Major
      Found in src/plugins/run/annotations.ts - About 3 hrs to fix

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

            it.each`
      start      | end         | path
      ${[10, 0]} | ${[10, 13]} | ${['children', 5, 'children', 0]}
      ${[64, 3]} | ${[66, 8]}  | ${['children', 18, 'children', 1, 'children', 1]}
      ${[65, 3]} | ${[65, 8]}  | ${['children', 18, 'children', 1, 'children', 1, 'children', 1]}
        Severity: Major
        Found in src/__tests__/getLocationForJsonPath.spec.ts and 1 other location - About 3 hrs to fix
        src/__tests__/getLocationForJsonPath.spec.ts on lines 16..44

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

        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

        Function applicable has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
        Open

        function applicable(node: Parent, inLink?: boolean): boolean | null {
  let image: boolean | null = null;
  let children = node.children;
  let length = children.length;
  let index = -1;
        Severity: Minor
        Found in src/plugins/run/unwrap-images.ts - About 2 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

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

            it('converts deprecated code block annotations to meta string', () => {
      const input = `<!--
title: "My example"
lineNumbers: true
highlightLines: [[1,2], 4, [6,7]]
        Severity: Major
        Found in src/reader/__tests__/markdown.spec.ts and 3 other locations - About 2 hrs to fix
        src/reader/__tests__/markdown.spec.ts on lines 64..82
        src/reader/__tests__/markdown.spec.ts on lines 84..102
        src/reader/__tests__/markdown.spec.ts on lines 104..122

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

        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 4 locations. Consider refactoring.
        Open

            it('appends to existing metastring annotations', () => {
      const input = `<!-- lineNumbers: true -->

\`\`\`json title="My title" myRandomProp {1}
{
        Severity: Major
        Found in src/reader/__tests__/markdown.spec.ts and 3 other locations - About 2 hrs to fix
        src/reader/__tests__/markdown.spec.ts on lines 28..62
        src/reader/__tests__/markdown.spec.ts on lines 64..82
        src/reader/__tests__/markdown.spec.ts on lines 84..102

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

        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 4 locations. Consider refactoring.
        Open

            it('ignore falsey lineNumbers', () => {
      const input = `<!-- lineNumbers: false -->

\`\`\`json
{
        Severity: Major
        Found in src/reader/__tests__/markdown.spec.ts and 3 other locations - About 2 hrs to fix
        src/reader/__tests__/markdown.spec.ts on lines 28..62
        src/reader/__tests__/markdown.spec.ts on lines 84..102
        src/reader/__tests__/markdown.spec.ts on lines 104..122

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

        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 4 locations. Consider refactoring.
        Open

            it('support old type: json_schema pattern', () => {
      const input = `<!-- type: json_schema -->

\`\`\`json
{
        Severity: Major
        Found in src/reader/__tests__/markdown.spec.ts and 3 other locations - About 2 hrs to fix
        src/reader/__tests__/markdown.spec.ts on lines 28..62
        src/reader/__tests__/markdown.spec.ts on lines 64..82
        src/reader/__tests__/markdown.spec.ts on lines 104..122

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

        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

        File resolver.spec.ts has 276 lines of code (exceeds 250 allowed). Consider refactoring.
        Open

        import * as fs from 'fs';
import * as path from 'path';
import remarkStringify, { RemarkStringifyOptions } from 'remark-stringify';
import unified from 'unified';
        Severity: Minor
        Found in src/plugins/run/__tests__/resolver.spec.ts - About 2 hrs to fix

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

          const prettyParse = (input: string) => {
  return prettier.format(
    `<>${unified()
      .use(remarkParse)
      .use(remarkParsePreset)
          Severity: Major
          Found in src/plugins/run/__tests__/inline-images.spec.ts and 1 other location - About 2 hrs to fix
          src/plugins/run/__tests__/unwrap-images.spec.ts on lines 11..22

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

          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

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

          const prettyParse = (input: string) => {
  return prettier.format(
    `<>${unified()
      .use(remarkParse)
      .use(remarkParsePreset)
          Severity: Major
          Found in src/plugins/run/__tests__/unwrap-images.spec.ts and 1 other location - About 2 hrs to fix
          src/plugins/run/__tests__/inline-images.spec.ts on lines 11..22

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

          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

          Function captureAnnotations has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
          Open

          function captureAnnotations<T extends Dictionary<any>>(node: MDAST.Content | undefined): T | {} {
  if (!node?.value) return {};

  if (
    // @ts-expect-error
          Severity: Minor
          Found in src/plugins/run/annotations.ts - About 2 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

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

              it('should support annotations placed within tabs', () => {
      const input = fs.readFileSync(path.join(__dirname, 'fixtures/tabs-with-images.md'), 'utf8');

      const mdastTree = mdReader.fromLang(input);
          Severity: Major
          Found in src/reader/__tests__/reader.spec.ts and 1 other location - About 2 hrs to fix
          src/reader/__tests__/reader.spec.ts on lines 289..317

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

          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

          Severity
          Category
          Status
          Source
          Language