Showing 24 of 24 total issues
Function getImports
has 91 lines of code (exceeds 25 allowed). Consider refactoring. Open
private getImports(sourceFile: SourceFile, statements: Statement[]): Imports {
return statements.reduce((imports, statement) => {
let sourceFileImports: string[] | undefined;
if (TypeGuards.isImportTypeNode(statement)) {
Function generateLayers
has 59 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected generateLayers(
output: OutputSchema,
allComponents: Components
): Layers {
const groups = array(output.groups) || [{}];
Function resolveConflictingComponentNames
has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring. Open
protected resolveConflictingComponentNames(
components: Components
): Components {
const componentsByName: { [name: string]: Component[] } = {};
- Read upRead up
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 generateLayers
has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring. Open
protected generateLayers(
output: OutputSchema,
allComponents: Components
): Layers {
const groups = array(output.groups) || [{}];
- Read upRead up
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 getExports
has 44 lines of code (exceeds 25 allowed). Consider refactoring. Open
private getExports(sourceFile: SourceFile, statements: Statement[]): Exports {
return statements.reduce((exports, statement) => {
if (
TypeGuards.isExportableNode(statement) &&
statement.hasExportKeyword()
Function getPaths
has 39 lines of code (exceeds 25 allowed). Consider refactoring. Open
export const getPaths = (
mainDirectory: string,
directory: string,
includePatterns: string[],
excludePatterns: string[],
Function generatePlantUMLComponent
has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring. Open
private generatePlantUMLComponent(
component: Component,
context: Context
): string {
const puml: string[] = [];
- Read upRead up
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 generateComponents
has 34 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected generateComponents(output: OutputSchema): Components {
const components = Object.keys(this.files).reduce(
(components, filename) => {
const filepath = filename.endsWith("**")
? path.dirname(filename)
Function getOutputs
has 32 lines of code (exceeds 25 allowed). Consider refactoring. Open
export const getOutputs = (config: Config): Promise<SavedString[]> => {
const files = new Parser(config).parse();
trace("Parsed files");
trace(files);
Function convert
has 32 lines of code (exceeds 25 allowed). Consider refactoring. Open
convert(pathOrType: string, puml: string): Promise<SavedString> {
const fullExportPath = path.resolve(this.config.directory, pathOrType);
const ext = path.extname(fullExportPath);
const shouldConvertAndSave = Object.values<any>(OutputFormat).includes(
ext.replace(".", "")
Function findComponentSchema
has 28 lines of code (exceeds 25 allowed). Consider refactoring. Open
protected findComponentSchema(
output: OutputSchema,
filename: string
): ComponentSchema | undefined {
const componentSchemas = this.config.final.components as ComponentSchema[];
Function generateComponents
has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open
protected generateComponents(output: OutputSchema): Components {
const components = Object.keys(this.files).reduce(
(components, filename) => {
const filepath = filename.endsWith("**")
? path.dirname(filename)
- Read upRead up
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 request
has 27 lines of code (exceeds 25 allowed). Consider refactoring. Open
export const request = (path, payload): Promise<Buffer> => {
return new Promise((resolve, reject) => {
const req = https
.request(
{
Similar blocks of code found in 2 locations. Consider refactoring. Open
if (hasLayer) {
puml.push(`[${name}]`);
} else if (context === Context.RELATIONSHIP) {
puml.push(safeName);
} else {
- Read upRead up
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 55.
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
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Similar blocks of code found in 2 locations. Consider refactoring. Open
} else if (!component.isClass) {
puml.push(`(${name})`);
} else if (context === Context.RELATIONSHIP) {
puml.push(safeName);
} else {
- Read upRead up
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 55.
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
- Extract Method
- Extract Class
- Form Template Method
- Introduce Null Object
- Pull Up Method
- Pull Up Field
- Substitute Algorithm
Further Reading
- Don't Repeat Yourself on the C2 Wiki
- Duplicated Code on SourceMaking
- Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76
Function convert
has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring. Open
convert(pathOrType: string, puml: string): Promise<SavedString> {
const fullExportPath = path.resolve(this.config.directory, pathOrType);
const ext = path.extname(fullExportPath);
const shouldConvertAndSave = Object.values<any>(OutputFormat).includes(
ext.replace(".", "")
- Read upRead up
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
Avoid deeply nested control flow statements. Open
if (importStructure.namedImports instanceof Array) {
sourceFileImports.push(
...importStructure.namedImports.map(namedImport =>
typeof namedImport === "string" ? namedImport : namedImport.name
)
Avoid deeply nested control flow statements. Open
if (importStructure.namespaceImport) {
sourceFileImports.push(importStructure.namespaceImport);
}
Avoid deeply nested control flow statements. Open
if (!sourceFileImports.length && !importStructure.namedImports) {
warn("IMPORT", sourceFile.getBaseName(), structure);
}
Avoid deeply nested control flow statements. Open
if (importStructure.defaultImport) {
sourceFileImports.push(importStructure.defaultImport);
}