patrickarlt/acetate

View on GitHub

Showing 27 of 27 total issues

Function done has 27 lines of code (exceeds 25 allowed). Consider refactoring.
Open

      const done = (error, filepaths) => {
        if (error) {
          callback(error);
        }

Severity: Minor
Found in lib/Acetate.js - About 1 hr to fix

    Function fromTemplate has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    function fromTemplate(src, templatePath, defaultMetadata = {}, options) {
      const filename = path.basename(templatePath, path.extname(templatePath));
      const dirname = path.dirname(templatePath);
      const yamlMetadataPath = path.join(dirname, `${filename}.metadata.yaml`);
      const jsonMetadataPath = path.join(dirname, `${filename}.metadata.json`);
    Severity: Minor
    Found in lib/createPage.js - About 1 hr to fix

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

          this._pageWatcher.on("change", src => {
            src = src.replace(/\\+/g, "/");
            this._handlePageWatcherEvent(src, "change", "changed");
          });
      Severity: Minor
      Found in lib/Acetate.js and 1 other location - About 50 mins to fix
      lib/Acetate.js on lines 487..490

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

      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

          this._pageWatcher.on("add", src => {
            src = src.replace(/\\+/g, "/");
            this._handlePageWatcherEvent(src, "add", "added");
          });
      Severity: Minor
      Found in lib/Acetate.js and 1 other location - About 50 mins to fix
      lib/Acetate.js on lines 492..495

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

      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

        constructor(name, handler, defaults) {
          this.name = name;
          this.tags = [name];
          this.handler = handler;
          this.defaults = defaults;
      Severity: Minor
      Found in lib/custom-tags/Block.js and 1 other location - About 45 mins to fix
      lib/custom-tags/Helper.js on lines 6..11

      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

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

        constructor(name, handler, defaults = {}) {
          this.name = name;
          this.tags = [name];
          this.handler = handler;
          this.defaults = defaults;
      Severity: Minor
      Found in lib/custom-tags/Helper.js and 1 other location - About 45 mins to fix
      lib/custom-tags/Block.js on lines 6..11

      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

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

        constructor(error, page) {
          error = typeof error === "string" ? new Error(error) : error;
          let originalMessage = _.trim(_.last(error.message.split("\n")));
          if (/ \[(Line) \d+, Column \d+\]/.test(error.message)) {
            let originalErrorLocation = error.message.match(/.*: \((.*)\)/);
      Severity: Minor
      Found in lib/error-types/PageRenderError.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