Skip to content

Latest commit

 

History

History
84 lines (69 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

84 lines (69 loc) · 3.56 KB

Como contribuir

  • Use o comando yarn dev para juntas todos os arquivos JSON
  • Aperte F5 para abrir um VSCode para testar as suas modificações. Dentro dele aperte CTRL + R para atualizar com as ultima modificações
  1. Baixe a extensao Convert text/code to a snippet. Ela vai ajudar no processo de criação de novos snippets.
  2. Escolha em nossa lista de tarefas alguma propriedade faltando que você deseja contribuir.
  3. Faça uma fork desse projeto
  4. crie uma nova branch
  5. Acesse o a documentação da VTEX no bloco que voce escolheu, e cole esse codigo no navegador:
const $tabelas = document.querySelectorAll(".rdmd-table-inner");

for (let $tabela of $tabelas) {

    let propriedadesEstruturadas = "";
    console.log("Tabela:")
    
    const $linhas = Array.from($tabela.querySelectorAll("tbody tr"));
    for (let $linha of $linhas) {
        const $celulas = Array.from($linha.querySelectorAll("td"));
        const [nomeObjeto, tipo, descricao, valorPadrao] = $celulas.map($celula => {
            return $celula.innerText
        })
        const regrasValorPadrao = {
            '""': '""',
            "undefined": "",
            "false": "false",
            "true": "true",
        }
        const vaiTerVirgula = ($linha == $linhas.at(-1)) ? "":","
        const valor = regrasValorPadrao[`${valorPadrao}`]??`"${valorPadrao}"`;
        const linhaEstruturada = `"${nomeObjeto}": ${valor}${vaiTerVirgula}`
        propriedadesEstruturadas += linhaEstruturada + "\n"
        
    }
    console.log(propriedadesEstruturadas)
}

Este codigo vai gerar retorna no console um rascunho de todas as propriedades que esse bloco recebe diretas da tabela

  1. Com isso monte um template de desse bloco em algum dos arquivos test.* (Deixei esses arquivos para testar tudo sem a necessidade de ficar criando arquivos avulsos)
  2. Depois de criar o template ajuste esse codigo para o formato de snippet JSON.
    Você pode selecionar o seu codigo, apertar F1 e digitar >Convert to Snippet e aperte enter, assim retorar no seu terminal uma verção com o espaçamentos e tabulação ajustados.
  3. Pedir um Pull Request

🧐O que há dentro?

./
├── dist
├── .vscode
├── docs
├── src
├── tools
├── .gitiignore
├── .vscodeignore
├── README.md
├── CHANGELOG.md
├── gulpfile.js
├── icon.png
├── LICENSE
├── package.json
├── package-lock.json
  1. dist -> arquivos gerados pelo build, aqui que estão os arquivos que a extensão vai usar.
  2. .vscode -> configurtaçoes do VS Code para o projeto. Aqui ocultamos algumas pastas e adicionamos uns snippets so para esse projeto
  3. docs -> documentação do projeto.
  4. src -> arquivos base da extensão não compilada (geralmente se voce for contribuir, aqui que voce vai mecher)
  5. tools -> ferramentas que ajudam no desenvolvimento.
  6. .gitignore -> arquivos que serao ignorados no git
  7. .vscodeignore -> arquivos ignorados para a extensão (praticamente dist e docs que vao )
  8. README.md -> primeira pagina de documentação do projeto
  9. CHANGELOG.md -> lista todas as mudanças do projeto
  10. gulpfile.js -> aquivo de configuração do gulp (ferramenta que compilar os arquivos)
  11. icon.png -> icone da extensão
  12. LICENSE -> licença do projeto
  13. package.json -> arquivo de configuração do projeto
  14. package-lock.json -> aquivos com as versões especificas das bibliotecas que vao ser usadas nesse projeto