Escrever Padrões de Código a Partir de Arquivo

Use a sintaxe existente do(s) arquivo(s) para estabelecer os padrões e guias de estilo para o projeto. Se mais de um arquivo ou uma pasta for passado, percorra cada arquivo ou arquivos na pasta, anexando os dados do arquivo à memória temporária ou a um arquivo, e então, quando completo, use os dados temporários como uma única instância; como se fosse o nome do arquivo para basear os padrões e o guia de estilo.

Regras e Configuração

Abaixo está um conjunto de variáveis de boolean e string[] quase de configuração. As condições para lidar com true, ou outros valores para cada variável estão sob o título de nível dois ## Variable and Parameter Configuration Conditions.

Os parâmetros para o prompt têm uma definição de texto. Há um parâmetro obrigatório ${fileName}, e vários parâmetros opcionais ${folderName}, ${instructions}, e qualquer [configVariableAsParameter].

Variáveis de Configuração

• addStandardsTest = false;
• addToREADME = false;
• addToREADMEInsertions = ["atBegin", "middle", "beforeEnd", "bestFitUsingContext"];
  • Padrão para beforeEnd.
• createNewFile = true;
• fetchStyleURL = true;
• findInconsistencies = true;
• fixInconsistencies = true;
• newFileName = ["CONTRIBUTING.md", "STYLE.md", "CODE_OF_CONDUCT.md", "CODING_STANDARDS.md", "DEVELOPING.md", "CONTRIBUTION_GUIDE.md", "GUIDELINES.md", "PROJECT_STANDARDS.md", "BEST_PRACTICES.md", "HACKING.md"];
  • Para cada arquivo em ${newFileName}, se o arquivo não existir, use esse nome de arquivo e break, caso contrário, continue para o próximo nome de arquivo de ${newFileName}.
• outputSpecToPrompt = false;
• useTemplate = "verbose"; // ou "v"
  • Valores possíveis são [["v", "verbose"], ["m", "minimal"], ["b", "best fit"], ["custom"]].
  • Seleciona um dos dois modelos de exemplo na parte inferior do arquivo de prompt sob o título de nível dois ## Coding Standards Templates, ou usa outra composição que seja mais adequada.
  • Se custom, então aplique conforme solicitado.

Variáveis de Configuração como Parâmetros de Prompt

Se algum dos nomes de variável for passado para o prompt como está, ou como um valor de texto semelhante, mas claramente relacionado, então substitua o valor padrão da variável pelo valor passado para o prompt.

Parâmetros de Prompt

• fileName = O nome do arquivo que será analisado em termos de: indentação, nomenclatura de variáveis, comentários, procedimentos condicionais, procedimentos funcionais e outros dados relacionados à sintaxe para a linguagem de programação do arquivo.
• folderName = O nome da pasta que será usada para extrair dados de múltiplos arquivos em um conjunto de dados agregado que será analisado em termos de: indentação, nomenclatura de variáveis, comentários, procedimentos condicionais, procedimentos funcionais e outros dados relacionados à sintaxe para a linguagem de programação dos arquivos.
• instructions = Instruções, regras e procedimentos adicionais que serão fornecidos para casos únicos.
• [configVariableAsParameter] = Se passado, substituirá o estado padrão da variável de configuração. Exemplo:
  • useTemplate = Se passado, substituirá o padrão da configuração ${useTemplate}. Os valores são [["v", "verbose"], ["m", "minimal"], ["b", "best fit"]].

Parâmetros Obrigatórios e Opcionais

• fileName - obrigatório
• folderName - opcional
• instructions - opcional
• [configVariableAsParameter] - opcional

Condições de Configuração de Variáveis e Parâmetros

${fileName}.length > 1 || ${folderName} != undefined

• Se verdadeiro, alterne ${fixInconsistencies} para falso.

${addToREADME} == true

• Insira os padrões de código no README.md em vez de exibir no prompt ou criar um novo arquivo.
• Se verdadeiro, alterne ambos ${createNewFile} e ${outputSpecToPrompt} para falso.

${addToREADMEInsertions} == "atBegin"

• Se ${addToREADME} for verdadeiro, então insira os dados dos padrões de código no início do arquivo README.md após o título.

${addToREADMEInsertions} == "middle"

• Se ${addToREADME} for verdadeiro, então insira os dados dos padrões de código no meio do arquivo README.md, alterando o título dos padrões para corresponder ao da composição README.md.

${addToREADMEInsertions} == "beforeEnd"

• Se ${addToREADME} for verdadeiro, então insira os dados dos padrões de código no fim do arquivo README.md, inserindo uma nova linha após o último caractere, e então inserindo os dados em uma nova linha.

${addToREADMEInsertions} == "bestFitUsingContext"

…