Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 | 1x 1x 1x 1x 1x 14550x 14550x 14550x 1x 1x 1x 1x 7278x 21690x 15x 11x 4x 7013x 122x 127x 145x 145x 145x 38x 2x 36x 11x 11x 11x 25x 4x 4x 4x 145x | import {Issue} from "../issue";
import {IObject} from "../objects/_iobject";
import {IRegistry} from "../_iregistry";
import {MethodLengthStats} from "../utils/method_length_stats";
import {IRule, IRuleMetadata, RuleTag} from "./_irule";
import {BasicRuleConfig} from "./_basic_rule_config";
export class MethodLengthConf extends BasicRuleConfig {
/** Maximum method length in statements */
public statements: number = 100;
/** Checks for empty methods. */
public errorWhenEmpty: boolean = true;
/** Option to ignore test classes for this check. */
public ignoreTestClasses: boolean = false;
}
enum IssueType {
EmptyMethod,
MaxStatements,
}
export class MethodLength implements IRule {
private conf = new MethodLengthConf();
public getMetadata(): IRuleMetadata {
return {
key: "method_length",
title: "Method Length",
shortDescription: `Checks relating to method length.`,
extendedInformation: `https://github.com/SAP/styleguides/blob/main/clean-abap/CleanABAP.md#keep-methods-small`,
tags: [RuleTag.Styleguide, RuleTag.SingleFile],
};
}
private getDescription(issueType: IssueType, actual: string): string {
switch (issueType) {
case IssueType.EmptyMethod: {
return "Empty method";
}
case IssueType.MaxStatements: {
return "Reduce method length to max " + this.conf.statements + " statements, currently " + actual;
}
default: {
return "";
}
}
}
public getConfig() {
return this.conf;
}
public setConfig(conf: MethodLengthConf) {
this.conf = conf;
}
public initialize(_reg: IRegistry) {
return this;
}
public run(obj: IObject): Issue[] {
const issues: Issue[] = [];
const stats = MethodLengthStats.run(obj);
for (const s of stats) {
if ((this.conf.ignoreTestClasses === true)
&& s.file.getFilename().includes(".testclasses.")) {
continue;
}
if (s.count === 0 && this.conf.errorWhenEmpty === true) {
const issue = Issue.atPosition(s.file, s.pos, this.getDescription(IssueType.EmptyMethod, "0"), this.getMetadata().key, this.conf.severity);
issues.push(issue);
continue;
}
if (s.count > this.conf.statements) {
const message = this.getDescription(IssueType.MaxStatements, s.count.toString());
const issue = Issue.atPosition(s.file, s.pos, message, this.getMetadata().key, this.conf.severity);
issues.push(issue);
}
}
return issues;
}
} |