azure-devops/azext_devops/dev/boards/arguments.py

# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

from azure.cli.core.commands.parameters import get_enum_type, get_three_state_flag
_EXPAND_TYPES = ['none', 'relations', 'fields', 'links', 'all']


def load_work_arguments(self, _):
    with self.argument_context('boards') as context:
        context.argument('project', options_list=('--project', '-p'))

    with self.argument_context('boards work-item create') as context:
        context.argument('work_item_type', type=str, options_list='--type')
        context.argument('fields', nargs='*', options_list=('--fields', '-f'))
        context.argument('description', options_list=('--description', '-d'))

    with self.argument_context('boards work-item update') as context:
        context.argument('fields', nargs='*', options_list=('--fields', '-f'))
        context.argument('description', options_list=('--description', '-d'))

    with self.argument_context('boards work-item delete') as context:
        context.argument('yes', options_list=['--yes', '-y'], action='store_true',
                         help='Do not prompt for confirmation.')

    with self.argument_context('boards work-item show') as context:
        context.argument('expand', arg_type=get_enum_type(_EXPAND_TYPES))
        context.argument('fields', options_list=('--fields', '-f'))

    with self.argument_context('boards work-item relation') as context:
        context.argument('id', help='The ID of the work item')

    with self.argument_context('boards work-item relation add') as context:
        context.argument('relation_type', help='Relation type to create. Example: parent, child ')
        context.argument('target_id', help='ID(s) of work-items to create relation with. \
                         Multiple values can be passed comma separated. Example: 1,2 ')
        context.argument('target_url', help='URL(s) of work-items to create relation with. \
                         Multiple values can be passed comma separated.')

    with self.argument_context('boards work-item relation remove') as context:
        context.argument('relation_type', help='Relation type to remove. Example: parent, child ')
        context.argument('target_id', help='ID(s) of work-items to remove relation from. \
                         Multiple values can be passed comma separated. Example: 1,2 ')

    with self.argument_context('boards iteration project') as context:
        context.argument('path', help='Absolute path of an iteration. '
                         'Example:' + r'\ProjectName\Iteration\IterationName')
        context.argument('start_date',
                         help='Start date of the iteration. Example : "2019-06-03"')
        context.argument('finish_date',
                         help='Finish date of the iteration. Example : "2019-06-21"')

    with self.argument_context('boards iteration project show') as context:
        context.argument('id', type=int)

    with self.argument_context('boards iteration project create') as context:
        context.argument('path', help='Absolute path of an iteration. '
                                      'Creates an iteration at root level if --path is not specified. '
                                      'Example:' + r'\ProjectName\Iteration\IterationName.')

    with self.argument_context('boards area') as context:
        context.argument('path', help='Absolute path of an area. Example:' + r'\ProjectName\Area\AreaName')

    with self.argument_context('boards area project create') as context:
        context.argument('path', help='Absolute path of an area. '
                                      'Creates an area at root level if --path is not specified. '
                                      'Example:' + r'\ProjectName\Area\AreaName.')

    with self.argument_context('boards area team') as context:
        context.argument('team', help='The name or id of the team.')
        context.argument('include_sub_areas', arg_type=get_three_state_flag(),
                         help='Include child nodes of this area.')
        context.argument('path', help='Area path. Example:' + r'\ProjectName\AreaName')