Merge pull request #78 from kairu-ms/fix-more-bugs

Support `singular_options` by default.

Author: kairu-ms

src/aaz_dev/cli/controller/az_arg_group_generator.py

@@ -168,15 +168,16 @@ def parse_arg_help(help):
     assert isinstance(help, CMDArgumentHelp)
     if not help.lines and not help.ref_commands:
         if not help.short:
-            raise exceptions.InvalidAPIUsage("Invalid argument help, short summery is miss.")
+            raise exceptions.InvalidAPIUsage("Invalid argument help, short summary is miss.")
         return help.short
     h = {
-        "short-summery": help.short
+        "short-summary": help.short
     }
     if help.lines:
-        h["long-summery"] = '\n'.join(help.lines)
+        h["long-summary"] = '\n'.join(help.lines)
     if help.ref_commands:
         h["populator-commands"] = [*help.ref_commands]
+    return h
 
 
 def parse_arg_enum(enum):

src/aaz_dev/command/controller/specs_manager.py

@@ -393,14 +393,14 @@ def verify_command_tree(self):
             if not group.help or not group.help.short:
                 details[' '.join(group.names)] = {
                     'type': 'group',
-                    'help': "Miss short summery."
+                    'help': "Miss short summary."
                 }
 
         for cmd in self.iter_commands():
             if not cmd.help or not cmd.help.short:
                 details[' '.join(cmd.names)] = {
                     'type': 'command',
-                    'help': "Miss short summery."
+                    'help': "Miss short summary."
                 }
         if details:
             raise exceptions.VerificationError(message="Invalid Command Tree", details=details)

src/aaz_dev/command/model/configuration/_arg_builder.py

@@ -1,17 +1,17 @@
 import re
 
-# import inflect
+import inflect
 from utils.case import to_camel_case
 
 from ._arg import CMDArg, CMDArgBase, CMDArgumentHelp, CMDArgEnum, CMDArgDefault, CMDBooleanArgBase, \
     CMDArgBlank, CMDObjectArgAdditionalProperties
 from ._format import CMDFormat
 from ._schema import CMDObjectSchema, CMDSchema, CMDSchemaBase, CMDObjectSchemaBase, CMDObjectSchemaDiscriminator, \
-    CMDArraySchemaBase, CMDObjectSchemaAdditionalProperties, CMDResourceIdSchema
+    CMDArraySchemaBase, CMDObjectSchemaAdditionalProperties, CMDResourceIdSchema, CMDArraySchema
 
 
 class CMDArgBuilder:
-    # _inflect_engine = inflect.engine()
+    _inflect_engine = inflect.engine()
 
     @classmethod
     def new_builder(cls, schema, parent=None, var_prefix=None, ref_args=None, ref_arg=None, is_update_action=False):
@@ -275,16 +275,14 @@ def get_singular_options(self):
             singular_options = getattr(self._ref_arg, 'singular_options', None)
             if singular_options:
                 return [*singular_options]
-        return None
 
-        # disable to auto generate singular option by default
-        # if not isinstance(self.schema, CMDArraySchema):
-        #     raise NotImplementedError()
-        # opt_name = self._build_option_name(self.schema.name.replace('$', ''))  # some schema name may contain $
-        # singular_opt_name = self._inflect_engine.singular_noun(opt_name) or opt_name
-        # if singular_opt_name != opt_name:
-        #     return [singular_opt_name, ]
-        # return None
+        if isinstance(self.schema, CMDArraySchema):
+            opt_name = self._build_option_name(self.schema.name.replace('$', ''))  # some schema name may contain $
+            singular_opt_name = self._inflect_engine.singular_noun(opt_name) or opt_name
+            if singular_opt_name != opt_name:
+                return [singular_opt_name, ]
+        # TODO: support CMDClsSchema when it reference from array schema
+        return None
 
     def get_help(self):
         if self._ref_arg:

src/aaz_dev/docs/Docs/readme.md

@@ -193,11 +193,11 @@ The data of command tree is in [Commands/tree.json](https://github.com/kairu-ms/
 
 ![CommandTreeNode](/Docs/images/aaz_command_tree_folder.png)
 
-Each folder represents each node of the tree and also represents a command group. Its readme.md file shows the summery, subgroups and commands of this group. And the links in the file help us to browse quickly.
+Each folder represents each node of the tree and also represents a command group. Its readme.md file shows the summary, subgroups and commands of this group. And the links in the file help us to browse quickly.
 
 ![CommandTreeLeaf](/Docs/images/aaz_command_tree_command_md.png)
 
-Each Markdown files starts with '_' represents each leaf of the tree which also represents a command. Its contains the summery, versions and examples of this command. And each version links to a command configuration in Resources folder. 
+Each Markdown files starts with '_' represents each leaf of the tree which also represents a command. Its contains the summary, versions and examples of this command. And each version links to a command configuration in Resources folder. 
 
 ### 5.2 Command Configuration
 

src/web/src/views/workspace/WSEditorCommandArgumentsContent.tsx

@@ -354,7 +354,7 @@ function ArgNavBar(props: {
 }
 
 const spliceArgOptionsString = (arg: CMDArg, depth: number) => {
-    return arg.options.map((option) => {
+    let optionsString = arg.options.map((option) => {
         if (depth === 0) {
             if (option.length === 1) {
                 return '-' + option;
@@ -364,7 +364,37 @@ const spliceArgOptionsString = (arg: CMDArg, depth: number) => {
         } else {
             return '.' + option;
         }
-    }).join(" ")
+    }).join(" ");
+
+    if ((arg as CMDArrayArg).singularOptions) {
+        let singularOptionString = (arg as CMDArrayArg).singularOptions!.map((option) => {
+            if (depth === 0) {
+                if (option.length === 1) {
+                    return '-' + option;
+                } else {
+                    return '--' + option;
+                }
+            } else {
+                return '.' + option;
+            }
+        }).join(" ");
+        optionsString += ` (${singularOptionString})`;
+    } else if ((arg as CMDClsArg).singularOptions) {
+        let singularOptionString = (arg as CMDArrayArg).singularOptions!.map((option) => {
+            if (depth === 0) {
+                if (option.length === 1) {
+                    return '-' + option;
+                } else {
+                    return '--' + option;
+                }
+            } else {
+                return '.' + option;
+            }
+        }).join(" ");
+        optionsString += ` (${singularOptionString})`;
+    }
+
+    return optionsString;
 }
 
 
@@ -473,7 +503,7 @@ function ArgumentReviewer(props: {
                 {`Choices: ` + choices.join(', ')}
             </ArgChoicesTypography>}
             {props.arg.help?.short && <ShortHelpTypography sx={{ ml: 6, mt: 1.5 }}> {props.arg.help?.short} </ShortHelpTypography>}
-            {!(props.arg.help?.short) && <ShortHelpPlaceHolderTypography sx={{ ml: 6, mt: 2 }}>Please add argument short summery!</ShortHelpPlaceHolderTypography>}
+            {!(props.arg.help?.short) && <ShortHelpPlaceHolderTypography sx={{ ml: 6, mt: 2 }}>Please add argument short summary!</ShortHelpPlaceHolderTypography>}
             {props.arg.help?.lines && <Box sx={{ ml: 6, mt: 1, mb: 1 }}>
                 {props.arg.help.lines.map((line, idx) => (<LongHelpTypography key={idx}>{line}</LongHelpTypography>))}
             </Box>}
@@ -541,7 +571,7 @@ function ArgumentDialog(props: {
         }
 
         if (sHelp.length < 1) {
-            setInvalidText(`Field 'Short Summery' is required.`)
+            setInvalidText(`Field 'Short Summary' is required.`)
             return undefined
         }
 
@@ -760,8 +790,8 @@ function ArgumentDialog(props: {
                         />
                     </>}
                     <TextField
-                        id="shortSummery"
-                        label="Short Summery"
+                        id="shortSummary"
+                        label="Short Summary"
                         type="text"
                         fullWidth
                         variant='standard'
@@ -773,8 +803,8 @@ function ArgumentDialog(props: {
                         required
                     />
                     <TextField
-                        id="longSummery"
-                        label="Long Summery"
+                        id="longSummary"
+                        label="Long Summary"
                         helperText="Please add long summer in lines."
                         type="text"
                         fullWidth
@@ -1098,7 +1128,7 @@ const PropHiddenArgOptionTypography = styled(Typography)<TypographyProps>(({ the
     fontWeight: 700,
 }))
 
-const PropArgShortSummeryTypography = styled(Typography)<TypographyProps>(({ theme }) => ({
+const PropArgShortSummaryTypography = styled(Typography)<TypographyProps>(({ theme }) => ({
     color: theme.palette.primary.main,
     fontFamily: "'Roboto Condensed', sans-serif",
     fontSize: 14,
@@ -1197,7 +1227,7 @@ function ArgumentPropsReviewer(props: {
                 {arg.help && <Box sx={{
                     ml: 4
                 }}>
-                    <PropArgShortSummeryTypography>{arg.help.short}</PropArgShortSummeryTypography>
+                    <PropArgShortSummaryTypography>{arg.help.short}</PropArgShortSummaryTypography>
                 </Box>}
             </Box>
 

src/web/src/views/workspace/WSEditorCommandContent.tsx

@@ -287,7 +287,7 @@ class WSEditorCommandContent extends React.Component<WSEditorCommandContentProps
                                 {name}
                             </NameTypography>
                             {shortHelp && <ShortHelpTypography sx={{ ml: 6, mt: 2 }}> {shortHelp} </ShortHelpTypography>}
-                            {!shortHelp && <ShortHelpPlaceHolderTypography sx={{ ml: 6, mt: 2 }}>Please add command short summery!</ShortHelpPlaceHolderTypography>}
+                            {!shortHelp && <ShortHelpPlaceHolderTypography sx={{ ml: 6, mt: 2 }}>Please add command short summary!</ShortHelpPlaceHolderTypography>}
                             {longHelp && <Box sx={{ ml: 6, mt: 1, mb: 1 }}>
                                 {lines.map((line, idx) => (<LongHelpTypography key={idx}>{line}</LongHelpTypography>))}
                             </Box>}
@@ -562,7 +562,7 @@ class CommandDialog extends React.Component<CommandDialogProps, CommandDialogSta
 
         if (shortHelp.length < 1) {
             this.setState({
-                invalidText: `Field 'Short Summery' is required.`
+                invalidText: `Field 'Short Summary' is required.`
             })
             return
         }
@@ -668,8 +668,8 @@ class CommandDialog extends React.Component<CommandDialogProps, CommandDialogSta
                         required
                     />
                     <TextField
-                        id="shortSummery"
-                        label="Short Summery"
+                        id="shortSummary"
+                        label="Short Summary"
                         type="text"
                         fullWidth
                         variant='standard'
@@ -683,8 +683,8 @@ class CommandDialog extends React.Component<CommandDialogProps, CommandDialogSta
                         required
                     />
                     <TextField
-                        id="longSummery"
-                        label="Long Summery"
+                        id="longSummary"
+                        label="Long Summary"
                         helperText="Please add long summer in lines."
                         type="text"
                         fullWidth

src/web/src/views/workspace/WSEditorCommandGroupContent.tsx

@@ -147,7 +147,7 @@ class WSEditorCommandGroupContent extends React.Component<WSEditorCommandGroupCo
                                 {name}
                             </NameTypography>
                             {shortHelp && <ShortHelpTypography sx={{ ml: 6, mt: 2 }}> {shortHelp} </ShortHelpTypography>}
-                            {!shortHelp && <ShortHelpPlaceHolderTypography sx={{ ml: 6, mt: 2 }}>Please add command group short summery!</ShortHelpPlaceHolderTypography>}
+                            {!shortHelp && <ShortHelpPlaceHolderTypography sx={{ ml: 6, mt: 2 }}>Please add command group short summary!</ShortHelpPlaceHolderTypography>}
                             {longHelp && <Box sx={{ ml: 6, mt: 1, mb: 1 }}>
                                 {lines.map((line, idx) => (<LongHelpTypography key={idx}>{line}</LongHelpTypography>))}
                             </Box>}
@@ -308,7 +308,7 @@ class CommandGroupDialog extends React.Component<CommandGroupDialogProps, Comman
 
         if (shortHelp.length < 1) {
             this.setState({
-                invalidText: `Field 'Short Summery' is required.`
+                invalidText: `Field 'Short Summary' is required.`
             })
         }
 
@@ -414,8 +414,8 @@ class CommandGroupDialog extends React.Component<CommandGroupDialogProps, Comman
                         required
                     />
                     <TextField
-                        id="shortSummery"
-                        label="Short Summery"
+                        id="shortSummary"
+                        label="Short Summary"
                         type="text"
                         fullWidth
                         variant='standard'
@@ -429,8 +429,8 @@ class CommandGroupDialog extends React.Component<CommandGroupDialogProps, Comman
                         required
                     />
                     <TextField
-                        id="longSummery"
-                        label="Long Summery"
+                        id="longSummary"
+                        label="Long Summary"
                         helperText="Please add long summer in lines."
                         type="text"
                         fullWidth