write-coding-standards-from-file

Topics in the source

• Write Coding Standards From File
• Rules and Configuration
• Configuration Variables
• Configuration Variables as Prompt Parameters
• Prompt Parameters
• Required and Optional Parameters
• Variable and Parameter Configuration Conditions
• ${fileName}.length > 1 || ${folderName} != undefined

Use the existing syntax of the file(s) to establish the standards and style guides for the project. If more than one file or a folder is passed, loop through each file or files in the folder, appending the file's data to temporary memory or a file, then when complete use temporary data as a single instance; as if it were the file name to base the standards and style guideline on. Below is a set of quasi-configuration boolean and string[] variables. Conditions for handling true, or other values for each variable are under the level two heading ## Variable and Parameter Configuration Conditions. Parameters for the prompt have a text definition. There is one required parameter ${fileName}, and several optional parameters ${folderName}, ${instructions}, and any [configVariableAsParameter]. addStandardsTest = false; addToREADME = false; addToREADMEInsertions = ["atBegin", "middle", "beforeEnd", "bestFitUsingContext"]; Default to beforeEnd. createNewFile = true; fetchStyleURL = true; findInconsistencies = true; fixInconsistencies = true; newFileName = ["CONTRIBUTING.md", "STYLE.md", "CODEOFCONDUCT.md", "CODINGSTANDARDS.md", "DEVELOPING.md", "CONTRIBUTIONGUIDE.md", "GUIDELINES.md", "PROJE

This is an excerpt. Refer to the complete source and its current requirements.