adr-cli/dist/locale/en.json

Architecture Decision Records (ADR) command cli

{
    "command": {
        "config": {
            "program": {
                "descriptions": "Command to configure properties for the cli."
            },
            "show": {
                "description": "Command to show key values of configurations. Properties is case sensitive",
                "table": {
                    "columnName": [
                        "Propertie",
                        "Value",
                        "Descriptions"
                    ],
                    "rows": {
                        "adrPath": "folder where is the config file for adr-tools.",
                        "locale": "locale for select default idiom",
                        "markdownEngine": "select engine interpreter for generating markdown. Only supporr github and gitlab"
                    }
                }
            },
            "get": {
                "argument": "Name of property to view value.",
                "description": "Command to get properties value.",
                "messages": {
                    "propertyNotFound": "roperty not found. Please check the help.",
                    "propertyNotValid": "Property is undefined.",
                    "propertyName": "Value to property is: "
                }
            },
            "set": {
                "argument": "Property name to config: property=value",
                "description": "Command to set property value.",
                "messages": {
                    "propertyEntered": "Property entered, $parseProperty, is not valid into the schema. Please tried again.",
                    "propertyChanged": "Property ${parsePropertie[0]} changed to: ${newProp}",
                    "propertyNotFound": "Value to property is: "
                }
            },
            "reset": {
                "description": "Command to reset or regenerate the config file for defaults."
            },
            "path": {
                "description": "Command to get the folder where is the config file for adr-tools."
            }
        },
        "new": {
            "withAnswers": {
                "shortTitle": "short title of solved problem and solution",
                "contextDescription": "Context and Problem Statement: "
            },
            "WithOutAnswers": {},
            "program": {
                "descriptions": "Create a new ADR file into document directory. Considering the relative directory in which it is located.",
                "arguments": "Name of title for ADR"
            }
        },
        "index": {
            "program": {
                "descriptions": "Create index file into document directory. Considering the relative directory in which it is located."
            }
        },
        "show": {
            "program": {
                "descriptions": "Show list of ADR files. For default is \"doc/adr\" in relative directory."
            }
        },
        "status": {
            "program": {
                "descriptions": "Modify the status an ADR by id. The status chooice: proposed, acceptance, rejection, deprecation, superseding",
                "argument": "Default 0",
                "option": "Set or change status for adr. The status chooice: proposed, acceptance, rejection, deprecation, superseding"
            }
        },
        "init": {
            "program": {
                "description": "Initialize the working directory for the ADR`s",
                "messages": {
                    "successfully": "Init directory make successfully!",
                    "wrong": "Init directory make wrong or is exist!"
                }
            }
        },
        "rel": {
            "program": {
                "description": "Mark relation ADR to other/s ADR",
                "argument": "ADR source id",
                "option": "ADR Id to add to source ADR. To add many Id`s, add separate by comma.",
                "argumentError": "Error in some argument, The id must be integer numbers."
            }
        },
        "suppressed": {
            "program": {
                "description": "Delete an ADR for another ADR/s",
                "argument": "ADR Origin ID",
                "option": "ADR ID to add to the source ADR. To add many Id`s add separated by comma.",
                "argumentError": "Error in some argument, The id must be integer numbers."
            }
        }
    },
    "class": {
        "adr": {
            "Add": {
                "checkContextValid": "{Describe the context and problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story. You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems.}"
            },
            "Adr": {
                "validateOrCreateIndex": {
                    "reading": "Reading ADR`s files to generated Index.",
                    "generated": "Index file generated successfully."
                },
                "suppressedAdr": {
                    "okRanameAdrFile": "The file has been superseding successfully"
                }
            }
        }
    }
}