Sign upLogin

nodaguti/word-quiz-generator

View on GitHub
Star

Showing 30 of 30 total issues

Function findWordIndexesWithinLemmatizedSentence has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  findWordIndexesWithinLemmatizedSentence({ lemmatizedSentence, phrase }) {
    const sentence = lemmatizedSentence;
    const phraseRegExp = this.getPhraseRegExp(phrase);
    const wordIndexes = [];
Severity: Minor
Found in src/quiz-generator.js - About 1 hr to fix

    Function default has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    export default async function (text) {
  // ---- Remove annotations
  const textWithoutAnnotations = removeAnnotations(text);

  const emended = textWithoutAnnotations
    Severity: Minor
    Found in src/preprocessors/ojp.js - 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 quiz has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      async quiz({ sections, size }) {
    const [min = 0, max] = sections.split('-').map((num) => Number(num));
    const phrasesToTest = _.shuffle(this._phrases.filter((phrase) =>
      _.inRange(phrase.section, min, (max || min) + 1),
    ));
    Severity: Minor
    Found in src/quiz-generator.js - About 1 hr to fix

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

        const generator = new QuizGenerator({
    material,
    sources,
    lang,
    sentenceSeparator,
      Severity: Minor
      Found in src/commands/coverage.js and 1 other location - About 50 mins to fix
      src/commands/generate.js on lines 107..116

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

      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 generator = new QuizGenerator({
    material,
    sources,
    lang,
    sentenceSeparator,
      Severity: Minor
      Found in src/commands/generate.js and 1 other location - About 50 mins to fix
      src/commands/coverage.js on lines 102..111

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

      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 parseQuestionSentence has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

        parseQuestionSentence({ sentence, wordIndexes }) {
    // Here we assume word divider is space.
    // If you are dealing with a language it is not the case (e.g. Japanese),
    // firstly you have to convert a text using a preprocessor.
    const tokenRegExp = new RegExp(`(${this._wordRegExp.source})(\\s*)`, 'g');
      Severity: Minor
      Found in src/quiz-generator.js - About 45 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

        async getText() {
    if (this._text) {
      return this._text;
    }
      Severity: Minor
      Found in src/source.js and 1 other location - About 40 mins to fix
      src/source.js on lines 58..65

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

      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

        async getReference() {
    if (this._reference) {
      return this._reference;
    }
      Severity: Minor
      Found in src/source.js and 1 other location - About 40 mins to fix
      src/source.js on lines 79..86

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

      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 default has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      export default async function (text) {
  const paragraphs = text.replace(/ /g, '').split(/\n/);

  const lemmatizedParagraphs = paragraphs.map((paragraph) => (async () => {
    const sentences = paragraph.split('。');
      Severity: Minor
      Found in src/lemmatizers/ojp.js - 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

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

      export const fetchFileList = (paths, pattern = /(?:)/) =>
  Promise.all(
    paths.split(',').map((p) => (async () => {
      const ap = path.resolve(p);
      const stat = await fs.statAsync(ap);
      Severity: Minor
      Found in src/utils.js - 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

      Severity
      Category
      Status
      Source
      Language