Plato - escomplex-commons/src/module/report/HalsteadData.ts

/**
 * Provides all Halstead metric data / parameters.
 * @see https://en.wikipedia.org/wiki/Halstead_complexity_measures
 */
export default class HalsteadData {
  /**
   * Measures an estimate for the number of potential errors.
   */
  bugs: number;
  /**
   * Measures the difficulty of the program to write or understand.
   */
  difficulty: number;
  /**
   * Measures the maintenance effort of the program.
   */
  effort: number;
  /**
   * Defines the number of operands and operators.
   */
  length: number;
  /**
   * Measures potential coding time.
   */
  time: number;
  /**
   * Defines the unique number of operands and operators.
   */
  vocabulary: number;
  /**
   * Measures how much information a reader of the code potential has to absorb to understand its meaning.
   */
  volume: number;
  /**
   * In general an operand participates in actions associated with operators. A distinct and total count is provided with all identifiers.
   */
  operands: { distinct: number; total: number; identifiers: never[] };
  /**
   * In general an operator carries out an action. A distinct and total count is provided with all identifiers.
   */
  operators: { distinct: number; total: number; identifiers: never[] };

/**
   * Initializes the default Halstead data.
   */
  constructor() {
    this.bugs = 0;
    this.difficulty = 0;
    this.effort = 0;
    this.length = 0;
    this.time = 0;
    this.vocabulary = 0;
    this.volume = 0;
    this.operands = { distinct: 0, total: 0, identifiers: [] };
    this.operators = { distinct: 0, total: 0, identifiers: [] };
  }

/**
   * Resets the state of all Halstead data metrics without removing any operand or operator data.
   *
   * @param clearIdentifiers - Clears operands / operators; default: false.
   *
   */
  reset(clearIdentifiers = false): HalsteadData {
    Object.keys(this).forEach((key) => {
      if (typeof (this as any)[key] === "number") {
        (this as any)[key] = 0;
      }
    });

if (clearIdentifiers) {
      this.operands = { distinct: 0, total: 0, identifiers: [] };
      this.operators = { distinct: 0, total: 0, identifiers: [] };
    }

return this;
  }
}

escomplex-commons/src/module/report/HalsteadData.ts

Maintainability

Lines of code

Difficulty

Estimated Errors

Function weight

By Complexity

By SLOC