Sign upLogin

sounisi5011/metalsmith-html-validator

View on GitHub
Star

Showing 8 of 8 total issues

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

    | {
          type: 'error';
          subType?: 'fatal';
          message?: string;
          extract?: string;
Severity: Major
Found in src/schemas/vnu-jar.ts and 1 other location - About 2 hrs to fix
src/schemas/vnu-jar.ts on lines 9..22

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

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

    | {
          type: 'info';
          subType?: 'warning';
          message?: string;
          extract?: string;
Severity: Major
Found in src/schemas/vnu-jar.ts and 1 other location - About 2 hrs to fix
src/schemas/vnu-jar.ts on lines 23..36

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

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

function message2str(
    message: VNuMessageObject,
    chalkCtx: chalk.Chalk | null,
): string {
    let typeColor = (text: string): string => text;
Severity: Minor
Found in src/index.ts - About 2 hrs 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 message2str has 49 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function message2str(
    message: VNuMessageObject,
    chalkCtx: chalk.Chalk | null,
): string {
    let typeColor = (text: string): string => text;
Severity: Minor
Found in src/index.ts - About 1 hr to fix

    Function validateFiles has 37 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export async function validateFiles(
    files: Record<string, FileInterface>,
    options: ReadonlyArray<string> = [],
    javaOptions: ReadonlyArray<string> = [],
): Promise<{
    Severity: Minor
    Found in src/validator.ts - About 1 hr to fix

      Function exec has 36 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export async function exec(
    command: string,
    args?: ReadonlyArray<string>,
    options?: childProcess.SpawnOptions & { input?: string | Buffer },
): Promise<{ stdout: Buffer; stderr: Buffer; status: number; signal: string }> {
      Severity: Minor
      Found in src/utils/index.ts - About 1 hr to fix

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

        export function compareUnicode(a: string, b: string): number {
    const aChars = [...a];
    const bChars = [...b];
    const aLen = aChars.length;
    const bLen = bChars.length;
        Severity: Minor
        Found in src/utils/index.ts - 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

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

        function hiliteExtract(
    message: VNuMessageObject,
    chalkCtx: chalk.Chalk | null,
): string {
    if (!hasProp(message, 'extract')) {
        Severity: Minor
        Found in src/index.ts - 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

        Severity
        Category
        Status
        Source
        Language