data-clumps-type-context
About
A reporting format for Data-Clumps as used in data-clumps.
import {DataClumpsDetectorContext} from "./DataClumpsDetectorContext";
import {DataClumpTypeContext, Dictionary} from "../index";
export type DataClumpsTypeContext = {
report_version: string,
detector: DataClumpsDetectorContext,
data_clumps: Dictionary<DataClumpTypeContext>,
report_timestamp: string,
target_language: string
report_summary: {
amount_data_clumps: number | null,
amount_files_with_data_clumps: number | null,
amount_classes_or_interfaces_with_data_clumps: number | null,
amount_methods_with_data_clumps: number | null,
fields_to_fields_data_clump: number | null,
parameters_to_fields_data_clump: number | null,
parameters_to_parameters_data_clump: number | null,
additional: any,
}
project_info: {
project_url: string | null,
project_name: string | null,
project_version: string | null,
project_commit_hash: string | null,
project_tag: string | null,
project_commit_date: string | null,
number_of_files: number | null,
number_of_classes_or_interfaces: number | null,
number_of_methods: number | null,
number_of_data_fields: number | null,
number_of_method_parameters: number | null,
additional: any,
}
}
export type DataClumpsDetectorContext = {
name: string,
url: string | null,
version: string,
options: any,
}
import {DataClumpsVariableFromContext, Dictionary} from "../index";
export type DataClumpTypeContext = {
type: string;
key: string;
probability: number | null;
from_file_path: string;
from_class_or_interface_name: string;
from_class_or_interface_key: string;
from_method_name: string | null;
from_method_key: string | null;
to_file_path: string;
to_class_or_interface_name: string;
to_class_or_interface_key: string;
to_method_name: string | null;
to_method_key: string | null;
data_clump_type: string;
data_clump_type_additional?: any;
data_clump_data: Dictionary<DataClumpsVariableFromContext>
}
import {Position, DataClumpsVariableToContext} from "../index";
export type DataClumpsVariableFromContext = {
key: string;
name: string;
type: string;
modifiers: string[] | undefined;
position: Position;
probability: number | null;
to_variable: DataClumpsVariableToContext;
}
import {Position} from "../index";
export type DataClumpsVariableToContext = {
key: string;
name: string;
type: string;
position: Position;
modifiers: string[] | undefined;
}
export type Position = {
startLine: number;
startColumn: number;
endLine: number;
endColumn: number;
}
export interface Dictionary<T> {
[Key: string]: T;
}
License
MIT
Contributors
The FireboltCasters