private function getOptions()

in src/configuration/ArcanistSettings.php [5:302]


  private function getOptions() {
    return array(
      'default' => array(
        'type' => 'string',
        'help' => pht(
          'The URI of a Phabricator install to connect to by default, if '.
          '%s is run in a project without a Phabricator URI or run outside '.
          'of a project.',
          'arc'),
        'example' => '"http://phabricator.example.com/"',
      ),
      'base' => array(
        'type' => 'string',
        'help' => pht(
          'Base commit ruleset to invoke when determining the start of a '.
          'commit range. See "Arcanist User Guide: Commit Ranges" for '.
          'details.'),
        'example' => '"arc:amended, arc:prompt"',
      ),
      'load' => array(
        'type' => 'list',
        'legacy' => 'phutil_libraries',
        'help' => pht(
          'A list of paths to phutil libraries that should be loaded at '.
          'startup. This can be used to make classes available, like lint '.
          'or unit test engines.'),
        'default' => array(),
        'example' => '["/var/arc/customlib/src"]',
      ),
      'repository.callsign' => array(
        'type' => 'string',
        'example' => '"X"',
        'help' => pht(
          'Associate the working copy with a specific Phabricator repository. '.
          'Normally, %s can figure this association out on its own, but if '.
          'your setup is unusual you can use this option to tell it what the '.
          'desired value is.',
          'arc'),
      ),
      'phabricator.uri' => array(
        'type' => 'string',
        'legacy' => 'conduit_uri',
        'example' => '"https://phabricator.mycompany.com/"',
        'help' => pht(
          'Associates this working copy with a specific installation of '.
          'Phabricator.'),
      ),
      'lint.engine' => array(
        'type' => 'string',
        'legacy' => 'lint_engine',
        'help' => pht(
          'The name of a default lint engine to use, if no lint engine is '.
          'specified by the current project.'),
        'example' => '"ExampleLintEngine"',
      ),
      'unit.engine' => array(
        'type' => 'string',
        'legacy' => 'unit_engine',
        'help' => pht(
          'The name of a default unit test engine to use, if no unit test '.
          'engine is specified by the current project.'),
        'example' => '"ExampleUnitTestEngine"',
      ),
      'arc.feature.start.default' => array(
        'type' => 'string',
        'help' => pht(
          'The name of the default branch to create the new feature branch '.
          'off of.'),
        'example' => '"develop"',
      ),
      'arc.land.onto.default' => array(
        'type' => 'string',
        'help' => pht(
          'The name of the default branch to land changes onto when '.
          '`%s` is run.',
          'arc land'),
        'example' => '"develop"',
      ),
      'arc.lint.cache' => array(
        'type' => 'bool',
        'help' => pht(
          'Enable the lint cache by default. When enabled, `%s` attempts to '.
          'use cached results if possible. Currently, the cache is not always '.
          'invalidated correctly and may cause `%s` to report incorrect '.
          'results, particularly while developing linters. This is probably '.
          'worth enabling only if your linters are very slow.',
          'arc lint',
          'arc lint'),
        'default' => false,
        'example' => 'false',
      ),
      'history.immutable' => array(
        'type' => 'bool',
        'legacy' => 'immutable_history',
        'help' => pht(
          'If true, %s will never change repository history (e.g., through '.
          'amending or rebasing). Defaults to true in Mercurial and false in '.
          'Git. This setting has no effect in Subversion.',
          'arc'),
        'example' => 'false',
      ),
      'editor' => array(
        'type' => 'string',
        'help' => pht(
          'Command to use to invoke an interactive editor, like `%s` or `%s`. '.
          'This setting overrides the %s environmental variable.',
          'nano',
          'vim',
          'EDITOR'),
        'example' => '"nano"',
      ),
      'https.cabundle' => array(
        'type' => 'string',
        'help' => pht(
          "Path to a custom CA bundle file to be used for arcanist's cURL ".
          "calls. This is used primarily when your conduit endpoint is ".
          "behind HTTPS signed by your organization's internal CA."),
        'example' => 'support/yourca.pem',
      ),
      'https.blindly-trust-domains' => array(
        'type' => 'list',
        'help' => pht(
          'List of domains to blindly trust SSL certificates for. '.
          'Disables peer verification.'),
        'default' => array(),
        'example' => '["secure.mycompany.com"]',
      ),
      'browser' => array(
        'type' => 'string',
        'help' => pht('Command to use to invoke a web browser.'),
        'example' => '"gnome-www-browser"',
      ),
      'events.listeners' => array(
        'type' => 'list',
        'help' => pht('List of event listener classes to install at startup.'),
        'default' => array(),
        'example' => '["ExampleEventListener"]',
      ),
      'http.basicauth.user' => array(
        'type' => 'string',
        'help' => pht('Username to use for basic auth over HTTP transports.'),
        'example' => '"bob"',
      ),
      'http.basicauth.pass' => array(
        'type' => 'string',
        'help' => pht('Password to use for basic auth over HTTP transports.'),
        'example' => '"bobhasasecret"',
      ),
      'arc.autostash' => array(
        'type' => 'bool',
        'help' => pht(
          'Whether %s should permit the automatic stashing of changes in the '.
          'working directory when requiring a clean working copy. This option '.
          'should only be used when users understand how to restore their '.
          'working directory from the local stash if an Arcanist operation '.
          'causes an unrecoverable error.',
          'arc'),
        'default' => false,
        'example' => 'false',
      ),
      'aliases' => array(
        'type' => 'aliases',
        'help' => pht(
          'Configured command aliases. Use "arc alias" to define aliases.'),
      ),
      'uber.land.buildables-check' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, `%s` will check that changes you are about to land '.
          'does not land if you have failed harbormaster buildables. ',
          'arc land'),
        'default' => false,
        'example' => 'false',
      ),
      'uber.land.prevent-unaccepted-changes' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, `%s` will prevent developers to land changes that'.
          'are not accepted.',
          'arc land'),
        'default' => false,
        'example' => 'false',
      ),
      'uber.land.review-check' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, `%s` will check that local changes you are about to land '.
          'match diff that was submitted for review to Differential.',
          'arc land'),
        'default' => false,
        'example' => 'false',
      ),
      'uber.land.run.unit' => array(
        'type' => 'bool',
        'help' => pht('If true, `arc land` will run arc unit before landing'),
        'default' => false,
        'example' => 'false',
      ),
      'uber.land.submitqueue.regex' => array(
        'type' => 'string',
        'help' => pht(
          'If set, the regex will be used to filter the set of diffs that '.
          'need to go through SubmitQueue during arc land.'),
        'default' => '',
        'example' => '/apps\/iphone/'
      ),
      'uber.land.submitqueue.enable' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, `arc land` will merge changes on the server-side using'.
          'submitqueue'),
        'default' => false,
        'example' => 'false',
      ),
      'uber.land.submitqueue.uri' => array(
        'type' => 'string',
        'help' => pht('URI to use for the submitqueue backend'),
        'example' => '"https://submitqueue.uberinternal.com"',
      ),
      'uber.land.submitqueue.shadow' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, `arc land` will submit requests to submitqueue with'.
          'shadow_option=true, and on success land the request using the '.
          'arcanist gitland engine'
        ),
        'default' => false,
        'example' => 'false',
      ),
      'uber.land.submitqueue.tags' => array(
        'type' => 'list',
        'help' => pht('List of tags to be used when creating tbr excuse tasks.'),
        'default' => array(),
        'example' => '["SubmitQueue-Mobile"]',
      ),
      'uber.land.submitqueue.owners' => array(
        'type' => 'list',
        'help' => pht(
          'List of owners for the given repository who need to be tagged'.
          'on tbr excuse tasks.'),
        'default' => array(),
        'example' => '["X, Y, Z"]',
      ),
      'uber.diff.git.push.verify' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, `arc diff` will run `git push` with `--verify` flag, '.
          'and if missing (or false), `arc diff` will run `git push` with '.
          '`--no-verify` flag.'),
        'default' => false,
      ),
      'uber.diff.staging.uri.replace' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, and staging environment is setup, then it will replace '.
          'staging uri with git remote name defined for it. It parses '.
          '"git remote -v" output and uses first remote name where remote url '.
          'matches staging uri.'),
        'default' => false,
      ),
      'uber.diff.prompt.allow-empty-binary' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, diff with empty binary upload will produce exceptions'.
          'unless diff explicitly with `--skip-binaries` option'),
        'default' => true,
      ),
      'uber.arcanist.use_non_tag_refs' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, arc will use non-tag refs for base and diff, both during arc diff and arc patch'),
        'default' => false,
      ),
      'differential.lookup-jira-issues' => array(
        'type' => 'bool',
        'help' => pht(
          'If true, arc will query jira for issues and display it for user selection'),
        'default' => true,
      ),
      'uber.differential.autoland-prompt' => array(
        'type' => 'string',
        'help' => pht('Set to default-yes / default-no for tagging change with #autoland'),
        'default' => null,
      ),
      'uber.differential.autoland-prompt-message' => array(
        'type' => 'string',
        'help' => pht('Message to show in prompt for #autoland'),
        'default' => 'Autoland after builds pass and reviewers approve?',
      ),
      'uber.differential.autoland-if-building' => array(
        'type' => 'bool',
        'help' => pht(
          'Add #autoland tag if user decides to proceed landing with ongoing '.
          'builds'),
        'default' => false,
      ),
    );
  }