All files / src config.ts

89.87% Statements 142/158
73.52% Branches 25/34
100% Functions 10/10
89.87% Lines 142/158

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 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 1581x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 10431x 10431x 10431x 1773270x 10431x 10431x 10431x 1783701x 1783701x 10431x 10431x 10431x 258x 258x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 10431x 1x 1x 278x 278x 47538x 47538x 47538x 47538x 44478x 1x 44478x 11x 44477x 44466x 44466x 44466x 44478x 47538x 278x 278x 278x 1x 1x 11506x 11506x       11506x 11506x 11506x     11506x     11506x     11506x   11506x 11506x 11506x 11506x 11506x 15x 15x 11506x 11506x 1x 1x 2112x 2112x 1x 1x 46512x 46512x 46512x     46512x 1x 1x 78x 78x 1x 1x 8445x 8445x 1x 1x 18990x 18990x 1x 1x 20919x     20919x 20919x 1x 1x 11506x     11506x 11506x 11506x 166668x 11505x 11505x 11505x 166668x 11506x 1x 1x 11506x 1x 1x
import {Version, defaultVersion} from "./version";
import {ArtifactsRules} from "./artifacts_rules";
import {IRule} from "./rules/_irule";
import {IConfig, IGlobalConfig, ISyntaxSettings, IConfiguration} from "./_config";
import * as JSON5 from "json5";
 
// assumption: this class is immutable
export class Config implements IConfiguration {
  private readonly config: IConfig;
 
  public static getDefault(ver?: Version): Config {
    const rules: any = {};
 
    const sorted = ArtifactsRules.getRules().sort((a, b) => {
      return a.getMetadata().key.localeCompare(b.getMetadata().key);
    });
 
    for (const rule of sorted) {
      rules[rule.getMetadata().key] = rule.getConfig();
    }
 
    let version = defaultVersion;
    if (ver) {
      version = ver;
    }
 
    // defaults: dont skip anything, report everything. The user can decide to skip stuff
    // its difficult to debug errors not being reported
    const config: IConfig = {
      global: {
        files: "/src/**/*.*",
        exclude: [],
        noIssues: [],
        skipGeneratedBOPFInterfaces: false,
        skipGeneratedFunctionGroups: false,
        skipGeneratedGatewayClasses: false,
        skipGeneratedPersistentClasses: false,
        skipGeneratedProxyClasses: false,
        skipGeneratedProxyInterfaces: false,
        useApackDependencies: false,
        skipIncludesWithoutMain: false,
      },
      dependencies: [{
        url: "https://github.com/abaplint/deps",
        folder: "/deps",
        files: "/src/**/*.*",
      }],
      syntax: {
        version,
        errorNamespace: "^(Z|Y|LCL\_|TY\_|LIF\_)",
        globalConstants: [],
        globalMacros: [],
      },
      rules: rules,
    };
 
    return new Config(JSON.stringify(config));
  }
 
  public getEnabledRules(): IRule[] {
    const rules: IRule[] = [];
    for (const rule of ArtifactsRules.getRules()) {
      const ruleConfig = this.config["rules"]?.[rule.getMetadata().key];
      const ruleExists = ruleConfig !== undefined;
 
      if (ruleExists) {
        if (ruleConfig === false) { // "rule": false
          continue;
        } else if (ruleConfig === true) { // "rule": true
          rules.push(rule);
        } else if (typeof ruleConfig === "object") { // "rule": { ...config }
          rule.setConfig(ruleConfig);
          rules.push(rule);
        }
      }
    }
 
    return rules;
  }
 
  public constructor(json: string) {
    // huh, hack
    if (JSON5.parse === undefined) {
      // @ts-ignore
      JSON5.parse = JSON5.default.parse;
    }
    this.config = JSON5.parse(json);
 
    if (this.config.global === undefined) {
      this.config.global = Config.getDefault().getGlobal();
    }
    if (this.config.syntax === undefined) {
      this.config.syntax = Config.getDefault().getSyntaxSetttings();
    }
    if (this.config.syntax.globalMacros === undefined) {
      this.config.syntax.globalMacros = [];
    }
    if (this.config.syntax.globalConstants === undefined) {
      this.config.syntax.globalConstants = [];
    } else {
      // remove duplicates,
      this.config.syntax.globalConstants = [...new Set(this.config.syntax.globalConstants)];
    }
    if (this.config.global.skipIncludesWithoutMain === undefined) {
      this.config.global.skipIncludesWithoutMain = false;
    }
    this.checkVersion();
  }
 
  public get(): IConfig {
    return this.config;
  }
 
  public readByKey(rule: string, key: string) {
    if (this.config["rules"]) {
      return this.config["rules"][rule] ? this.config["rules"][rule][key] : undefined;
    } else {
      return undefined;
    }
  }
 
  public readByRule(rule: string) {
    return this.config["rules"][rule];
  }
 
  public getGlobal(): IGlobalConfig {
    return this.config.global;
  }
 
  public getSyntaxSetttings(): ISyntaxSettings {
    return this.config.syntax;
  }
 
  public getVersion(): Version {
    if (this.config.global === undefined || this.config.syntax.version === undefined) {
      return defaultVersion;
    }
    return this.config.syntax.version;
  }
 
  private checkVersion() {
    if (this.config.syntax.version === undefined) {
      return; // handled in getVersion
    }
    let match = false;
    const vers: any = Version;
    for (const v in Version) {
      if (vers[v] === this.config.syntax.version) {
        match = true;
        break;
      }
    }
    if (match === false) {
      this.config.syntax.version = defaultVersion;
    }
  }
 
}