types.d.ts

/**
 * @description The root element of a dictatable configuration file.
 */
export interface DictatableConfig {
  /**
   * @type string
   * @description Optional message. Can be used to explain this dictatable.
   */
  message?: string;
  /**
   * @description Conditions that, if met, makes this dictatable run. Empty triggers means it will always run.
   */
  triggers?: DictatableConfigTrigger[];
  /**
   * @description Actions to perform if triggered.
   */
  actions?: DictatableConfigAction[];
}

export interface DictatableConfigTrigger {
  /**
   * @type string
   * @description The file to trigger on.
   */
  target?: string;

  haveJsonPathValue?: DictatableConfigActionExpression;

  /**
   * @items.type string
   * @items.minimum 1
   * @description can be regular expression.
   */
  haveLineContaining?: string;
  /**
   * @type string
   * @description A path that should EXIST or NOT_EXIST.
   */
  itShould?: DictatableConfigTriggerItShould;
  haveEnvironmentVariable?: DictatableConfigActionEnvironmentVariable;
  /**
   * @items.type string
   * @items.minimum 1
   * @description Trigger when running on platform. process.platform. https://nodejs.org/api/process.html#process_process_platform
   */
  runningOnPlatform?: PLATFORM_TYPE;

  /**
   * @description Negate the following triggers.
   */
  not?: DictatableConfigTrigger[];
  /**
   * @description Or any of these triggers.
   */
  or?: DictatableConfigTrigger[];
  /**
   * @description And all these triggers.
   */
  and?: DictatableConfigTrigger[];
}

export type DictatableConfigTriggerItShould = 'NOT_EXIST' | 'EXIST';

export type PLATFORM_TYPE =
  | 'aix'
  | 'darwin'
  | 'freebsd'
  | 'linux'
  | 'openbsd'
  | 'sunos'
  | 'win32';

export interface DictatableConfigAction {
  /**
   * @type string
   * @description Optional message. Can be used to explain this requirement.
   */
  message?: string;
  /**
   * @type string Can be a file or folder, if it does not exists it will be treated as a folder.
   */
  target: string;
  /**
   * @type string
   * @description Can be a glob pattern to match many files or folders. Target will always be
   * considered a folder preserving original filenames.
   */
  copyFrom?: string;
  notHaveJsonPathNodes?: string[];
  haveJsonPathValues?: DictatableConfigActionExpression[];
  /**
   * @type string
   * @description A file that should contain a superset of the target file.
   */
  beSupersetOfJsonFile?: string;
  /**
   * @items.type string
   * @items.minimum 1
   * @description Will be added to the end of the file if not found.
   */
  haveLineContaining?: string[];
  /**
   * @items.type string
   * @items.minimum 1
   * @description Will be added to the end of the file if not found. This works just like haveLineContaining
   * but will respect the .dictatorConfig.json ignore.
   */
  haveLineContainingFile?: string[];
  /**
   * @description The target should have this chmod.
   */
  chmod?: string;
  /**
   * @type string
   * @description A path that should EXIST or NOT_EXIST.
   */
  itShould?: DictatableConfigActionItShould;
}

export type DictatableConfigActionItShould = 'NOT_EXIST' | 'NOT_BE_IN_GIT';

/**
 * @description These may be used to make the tool behave differently, perhaps
 * copy or patch different files, depending on operating system.
 */
export interface DictatableConfigActionEnvironmentVariable {
  /**
   * @type string
   * @description Name of environment variable
   */
  name: string;
  /**
   * @type string
   * @description Optional value of variable
   */
  value?: string;
}

export interface DictatableConfigActionExpression {
  /**
   * @type string
   * @description Expression
   */
  expression: string;
  /**
   * @type string
   * @description A value that should match.
   */
  value?: string;
}

/**
 * @description This describes the .dictatorconfig that can be placed in the dictated folder.
 */
export interface DictatorConfig {
  /**
   * @description List of glob patterns in the folder to ignore.
   * @items.type string
   * @items.minimum 1
   */
  ignore?: string[];
  options?: DictatorConfigOptions;
}

export interface DictatorConfigOptions {
  /**
   * @description This indentation will be used when/if manipulating json files.
   */
  jsonIndentation?: number;
}