sounisi5011/metalsmith-pug-extra

View on GitHub

Showing 7 of 7 total issues

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

export function getCompileOptions<T extends CompileOptionsInterface>(
    options: T,
): CompileOptionsInterface & {
    otherOptions: Omit<T, keyof CompileOptionsInterface>;
} {
Severity: Major
Found in src/compile.ts and 1 other location - About 3 hrs to fix
src/render.ts on lines 73..80

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

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

export function getRenderOptions<T extends RenderOptionsInterface>(
    options: T,
): RenderOptionsInterface & {
    otherOptions: Omit<T, keyof RenderOptionsInterface>;
} {
Severity: Major
Found in src/render.ts and 1 other location - About 3 hrs to fix
src/compile.ts on lines 39..52

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

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 convert has 41 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const convert = createPluginGeneratorWithPugOptions((opts = {}) => {
    const options = {
        ...convertDefaultOptions,
        ...opts,
    };
Severity: Minor
Found in src/convert.ts - About 1 hr to fix

    Function getCompileTemplate has 29 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function getCompileTemplate(
        filename: string,
        files: Metalsmith.Files,
        metalsmith: Metalsmith,
        options: CompileOptionsInterface & pug.Options,
    Severity: Minor
    Found in src/compile.ts - About 1 hr to fix

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

      export const render = createPluginGenerator((opts = {}) => {
          return (files, metalsmith, done) => {
              const options = normalizeRenderOptions(
                  metalsmith,
                  renderDefaultOptions,
      Severity: Minor
      Found in src/render.ts - About 1 hr to fix

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

        export const compile = createPluginGeneratorWithPugOptions((opts = {}) => {
            const options = {
                ...compileDefaultOptions,
                ...opts,
            };
        Severity: Minor
        Found in src/compile.ts - About 1 hr to fix

          Function getRenderedText has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

              compileTemplate: pug.compileTemplate,
              filename: string,
              data: FileInterface,
              metalsmith: Metalsmith,
              options: RenderOptionsInterface,
          Severity: Minor
          Found in src/render.ts - About 35 mins to fix
            Severity
            Category
            Status
            Source
            Language