opensheetmusicdisplay/opensheetmusicdisplay

View on GitHub
src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts

Summary

Maintainability
F
3 days
Test Coverage

Function readChordSymbol has a Cognitive Complexity of 38 (exceeds 5 allowed). Consider refactoring.
Open

    public static readChordSymbol(xmlNode: IXmlElement, musicSheet: MusicSheet, activeKey: KeyInstruction): ChordSymbolContainer {
        const root: IXmlElement = xmlNode.element("root");
        const kind: IXmlElement = xmlNode.element("kind");
        const kindText: IXmlAttribute = kind.attribute("text");

Severity: Minor
Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.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

Function readChordSymbol has 131 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static readChordSymbol(xmlNode: IXmlElement, musicSheet: MusicSheet, activeKey: KeyInstruction): ChordSymbolContainer {
        const root: IXmlElement = xmlNode.element("root");
        const kind: IXmlElement = xmlNode.element("kind");
        const kindText: IXmlAttribute = kind.attribute("text");

Severity: Major
Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts - About 5 hrs to fix

    Avoid too many return statements within this function.
    Open

                        return undefined;
    Severity: Major
    Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

                          return undefined;
      Severity: Major
      Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                            return undefined;
        Severity: Major
        Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                              return undefined;
          Severity: Major
          Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return new ChordSymbolContainer(rootPitch, chordKind, bassPitch, degrees, musicSheet.Rules);
            Severity: Major
            Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                                  return undefined;
              Severity: Major
              Found in src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts - About 30 mins to fix

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

                        if (rootAlter) {
                            try {
                                rootAlteration = Pitch.AccidentalFromHalfTones(parseInt(rootAlter.value, 10));
                            } catch (ex) {
                                const errorMsg: string = ITextTranslation.translateText("ReaderErrorMessages/ChordSymbolError",
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 95..104

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

                            if (bassAlter) {
                                try {
                                    bassAlteration = Pitch.AccidentalFromHalfTones(parseInt(bassAlter.value, 10));
                                } catch (ex) {
                                    const errorMsg: string = ITextTranslation.translateText("ReaderErrorMessages/ChordSymbolError",
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 40..50

                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

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

                                try {
                                    value = parseInt(degreeValue.value.trim(), 10);
                                } catch (ex) {
                                    const errorMsg: string = ITextTranslation.translateText("ReaderErrorMessages/ChordSymbolError",
                                                                                            "Invalid chord symbol");
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 28..36
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 66..74
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 84..92
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 132..140
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 143..153

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

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

                                try {
                                    text = ChordDegreeText[degreeType.value.trim().toLowerCase()];
                                } catch (ex) {
                                    const errorMsg: string = ITextTranslation.translateText(
                                        "ReaderErrorMessages/ChordSymbolError",
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 28..36
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 66..74
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 84..92
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 121..129
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 132..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 59.

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

                                try {
                                    alter = Pitch.AccidentalFromHalfTones(parseInt(degreeAlter.value, 10));
                                } catch (ex) {
                                    const errorMsg: string = ITextTranslation.translateText("ReaderErrorMessages/ChordSymbolError",
                                                                                            "Invalid chord symbol");
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 28..36
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 66..74
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 84..92
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 121..129
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 143..153

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

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

                        try {
                            rootNote = NoteEnum[rootStep.value.trim()];
                        } catch (ex) {
                            const errorMsg: string = ITextTranslation.translateText("ReaderErrorMessages/ChordSymbolError",
                                                                                    "Invalid chord symbol");
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 66..74
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 84..92
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 121..129
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 132..140
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 143..153

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

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

                                try {
                                    bassNote = NoteEnum[bassStep.value.trim()];
                                } catch (ex) {
                                    const errorMsg: string = ITextTranslation.translateText("ReaderErrorMessages/ChordSymbolError",
                                                                                            "Invalid chord symbol");
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 28..36
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 66..74
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 121..129
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 132..140
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 143..153

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

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

                        try {
                            chordKind = ChordSymbolEnum[kindValue];
                        } catch (ex) {
                            const errorMsg: string = ITextTranslation.translateText("ReaderErrorMessages/ChordSymbolError",
                                                                                    "Invalid chord symbol");
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 28..36
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 84..92
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 121..129
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 132..140
                src/MusicalScore/ScoreIO/MusicSymbolModules/ChordSymbolReader.ts on lines 143..153

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

                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