@dxdeveloperexperience/hygie/src/rules/ruleResult.ts

Hygie is an easy-to-use Open-Source REST API allowing you to interact with GIT events. This NestJS API expose a set of customizable rules to automate your project's life cycle.

import { GitApiInfos } from '../git/gitApiInfos';

/**
 * Contains the result of the rule `validate()` method.
 */
export class RuleResult {
  /**
   * Specify if the rule succeed
   */
  validated: boolean;
  /**
   * Contains meta-data that can be used by `Runnable` (in the `args` object)
   */
  data: object;
  /**
   * Provide informations to `Runnable` to interact with Git API
   */
  gitApiInfos: GitApiInfos;
  /**
   * Project URL of the caller, used for Analytics
   */
  projectURL: string;

  /**
   * Contains all environment variables set in the current project
   */
  env: object;

  constructor(gitApiInfos: GitApiInfos, url: string = '') {
    this.gitApiInfos = gitApiInfos;
    this.projectURL = url;
  }
}