Sign upLogin

clay/handlebars

View on GitHub
Star
docs/generate-readme.js

Summary

Maintainability
A
1 hr
Test Coverage

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

function generateDoc(helper) {
  const rawDoc = _.find(doc.buildSync([helper], { shallow: true }), function (section) {
    // grab the jsdoc for the exported function
    // note: you must do `module.exports = function () {}`,
    // rather than declaring a named function above and referencing it
Severity: Minor
Found in docs/generate-readme.js - About 1 hr to fix

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

    function parseType(obj) {
  if (obj.type === 'NameExpression') {
    // {array}, {string}, {object}, etc
    return obj.name;
  } else if (obj.type === 'AllLiteral') {
    Severity: Minor
    Found in docs/generate-readme.js - 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

    There are no issues that match your filters.

    Category
    Status