import { Auth } from '../Providers/GitHubProvider';
import { ParameterInfo } from './ParameterInfo';

const command = 'branch-remover';
const auth = new Auth('sfm-tools', 'branch-remover', 'a1ee8b13');

export const schema: Array<ParameterInfo> = [
  {
    name: 'version',
    aliases: ['v'],
    description: [
      'Displays the version number of the application.',
    ],
    examples: [{
      example: `${command} --version`,
    }],
  },
  {
    name: 'help',
    aliases: ['h'],
    description: [
      'Displays help information.',
      'You can add a parameter name to see detailed',
      'information about that parameter.',
      `For example: ${command} --help help`,
    ],
    examples: [
      {
        title: 'Display general help information:',
        example: `${command} --help`,
      },
      {
        title: 'Display detailed information on the specified command:',
        example: `${command} --help config`,
      },
    ],
  },
  {
    name: 'test',
    aliases: ['t'],
    description: [
      'Test mode, automatic removing branches is disabled.',
    ],
    examples: [{
      example: `${command} --provider github --github.token ${auth.token} --github.owner ${auth.owner} --github.repo ${auth.repo} --test`,
    }],
  },
  {
    name: 'debug',
    description: [
      'Enables the display of extended information.',
    ],
    examples: [{
      example: `${command} --provider github --github.token ${auth.token} --github.owner ${auth.owner} --github.repo ${auth.repo} --debug`,
    }],
  },
  {
    name: 'provider',
    aliases: ['p'],
    description: [
      'Specifies the provider name.',
      'Expected values: github (default).',
    ],
    examples: [{
      example: `${command} --provider github --github.token ${auth.token} --github.owner ${auth.owner} --github.repo ${auth.repo}`,
    }],
  },
  {
    name: 'quiet',
    aliases: ['q'],
    description: [
      'The presence of this parameter disables the confirmation',
      'request to remove branches.',
      'Matching branches will be removed immediately.',
    ],
    examples: [{
      example: `${command} --provider github --github.token ${auth.token} --github.owner ${auth.owner} --github.repo ${auth.repo} --quiet`,
    }],
  },
  {
    name: 'yes',
    aliases: ['y'],
    description: [
      'The default answer to a delete confirmation is YES.',
      'NOTE: Does not work in quiet mode.',
    ],
    examples: [{
      example: `${command} --provider github --github.token ${auth.token} --github.owner ${auth.owner} --github.repo ${auth.repo} --yes`,
    }],
  },
  {
    name: 'no',
    aliases: ['n'],
    description: [
      'The default answer to a delete confirmation is NO (Default).',
      'NOTE: Does not work in quiet mode.',
    ],
    examples: [{
      example: `${command} --provider github --github.token ${auth.token} --github.owner ${auth.owner} --github.repo ${auth.repo} --no`,
    }],
  },
  {
    name: 'ignore',
    aliases: ['i'],
    description: [
      'A regex pattern that allows specifying branches to ignore.',
    ],
    examples: [{
      title: 'The following example prevents the removing of branches named master, beta and release:',
      example: `${command} --provider github --github.token ${auth.token} --github.owner ${auth.owner} --github.repo ${auth.repo} --ignore ^(master|beta|release)$`,
    }],
  },
  {
    name: 'merged',
    aliases: ['m'],
    description: [
      'Allows specifying the time elapsed since the merge.',
      'For example: 2 years (or 2y); 6 months; 5 days (or 5d);',
      '2 hours (or 2h); 30 minutes (or 30m); etc.',
      'Default: all (all merged branches).',
    ],
  },
  {
    name: 'stale',
    aliases: ['s'],
    description: [
      'Allows specifying the time after which the unmerged branch',
      'can be considered obsolete since the last update.',
      'For example: 2 years (or 2y), 6 months, etc.',
      'Default: unset',
    ],
  },
  {
    name: 'details',
    aliases: ['d'],
    description: [
      'Displays detailed information about each branch.',
      'By default, detailed information is displayed only',
      'for branches to be removed.',
    ],
  },
  {
    name: 'before',
    aliases: ['b'],
    description: [
      'The command is to be executed before removing the branch.',
      'If the result of the command execution is the string',
      '"0" or "false",',
      'then removing will be prevented.',
    ],
    examples: [
      {
        title: 'The following example shows creating a backup of a branch before removing:',
        example: `${command} --provider github --github.auth ./.auth.json --before "git -c credential.helper= -c core.quotepath=false -c log.showSignature=false fetch origin {branch}:{branch} --recurse-submodules=no"`,
      }
    ],
  },
  {
    name: 'after',
    aliases: ['a'],
    description: [
      'The command is to be executed after a branch is removed.',
    ],
    examples: [
      {
        title: 'The following example shows a command that writes the name of the removed branch to a file:',
        example: `${command} --provider github --github.auth ./.auth.json --after echo "{branch} >> ./removed-branches.log"`,
      }
    ],
  },
  {
    name: 'cache',
    description: [
      'Allows managing branch caching.',
    ],
    examples: [
      {
        title: 'The following example shows caching to the ".branch-remover.cache" file enabled for 600 seconds:',
        example: `${command} --provider github --github.auth ./.auth.json --cache "./.branch-remover.cache timeout=600"`,
      }
    ],
  },
  {
    name: 'config',
    aliases: ['c'],
    description: [
      'Path to custom js-file containing branch processing parameters.'
    ],
    examples: [
      {
        title: 'The following example shows a simple configuration file:',
        example: `module.exports = {
  ignore: (e) => {
    // ignore branch names: master, beta, and prod*
    return Promise.resolve(
      /(master|beta|prod.*)/.test(e.branchName)
    );
  },
  remove: (e) => {
    // remove all merged branches
    return Promise.resolve(e.branch.merged);
  },
  beforeRemove: (e) => {
    // you can return false to prevent removing
    return Promise.resolve(true);
  },
  afterRemove: (e) => {
    // it doesn't matter what this function returns
    // you can throw an exception to leave further branch processing
    return Promise.resolve(true);
  },
};`,
      }
    ],
  },
  {
    name: 'github.auth',
    description: [
      'The path to the JSON file that contains the repository',
      'access parameters.',
      'Required only for provider "github", when the access',
      'parameters are not specified separately.',
    ],
    examples: [
      {
        title: 'The following example shows the structure of a JSON file containing repository access settings:',
        example: `{
  "github": {
    "token": "%YOUR GITHUB TOKEN HERE%",
    "owner": "%GITHUB USERNAME OR ORGANIZATION NAME HERE%",
    "repo": "%REPOSITORY NAME HERE%"
  }
}`,
      },
      {
        title: 'The following example shows the use of a file containing parameters for accessing the repository:',
        example: `${command} --provider github --github.auth ./.auth.json`,
      },
    ],
  },
  {
    name: 'github.token',
    description: [
      'GitHub access token.',
      'Required only for provider "github",',
      'when github.auth is not specified.',
    ],
  },
  {
    name: 'github.owner',
    description: [
      'Username or organization name on GitHub.',
      'For example: sfm-tools.',
      'Required only for provider "github",',
      'when github.auth is not specified.',
    ],
  },
  {
    name: 'github.repo',
    description: [
      'Repository name on GitHub. For example: branch-remover.',
      'Required only for provider "github",',
      'when github.auth is not specified.',
    ],
  },
].sort(
  (a: ParameterInfo, b: ParameterInfo): number => {
    return a.name.localeCompare(b.name, 'en');
  }
);