vanduynslagerp/sr-release-notes-generator

View on GitHub

Showing 3 of 3 total issues

Function generateNotes has 55 lines of code (exceeds 25 allowed). Consider refactoring.
Open

async function generateNotes(pluginConfig, context) {
  const {commits, lastRelease, nextRelease, options, cwd} = context;
  const repositoryUrl = options.repositoryUrl.replace(/\.git$/i, '');
  const {parserOpts, writerOpts} = await loadChangelogConfig(pluginConfig, context);

Severity: Major
Found in index.js - About 2 hrs to fix

    Function generateNotes has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

    async function generateNotes(pluginConfig, context) {
      const {commits, lastRelease, nextRelease, options, cwd} = context;
      const repositoryUrl = options.repositoryUrl.replace(/\.git$/i, '');
      const {parserOpts, writerOpts} = await loadChangelogConfig(pluginConfig, context);
    
    
    Severity: Minor
    Found in index.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 exports has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    module.exports = async ({preset, config, parserOpts, writerOpts, presetConfig}, {cwd}) => {
      let loadedConfig;
    
      if (preset) {
        const presetPackage = `conventional-changelog-${preset.toLowerCase()}`;
    Severity: Minor
    Found in lib/load-changelog-config.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

    Severity
    Category
    Status
    Source
    Language