📝 Nova estrutura de organização de termos do dicionário

[andrepg]

Bom, seguindo a nova implementação da versão 2, uma das melhorias a se abrir discussão é aquela relacionada à estrutura dos verbetes termos (preciso me acostumar ainda, sorry). Fiz um pequeno estudo por agora, e tenho algumas observações a listas antes de propor mudanças.

• Temos, até o momento, 136 termos cadastrados
• Ainda não temos uma palavra para cada letra, ou seja: há letras não catalogadas ainda
• Os termos estão todos localizados num arquivo JSON apenas
• A letra com mais termos tem menos de 15, à data de escrita desta proposição

O dashboard do Looker Studio está disponível para visualização. Por enquanto limitarei a edição a quem precisar.

Os termos acentuados estão aparecendo separados de suas respectivas letras no Looker. Creio que seja apenas uma questão de transformar o parâmetro no painel. Mas é só um aviso.

👀 Considerações

• A estrutura de pastas foi pensada com a possibilidade de internacionalização do projeto.
• Minimizar conflitos ao adicionar ou atualizar termos é uma premissa básica nesta tentativa.
• Organização dos arquivos visa implementar uma lógica básica de dicionário, seguindo a filosofia do projeto

💡 Proposição

📁 Estrutura de pasta

+ src/
 \_ dict/
     \ -- [lang]
	   \-- index.js
       |--- [a, b, c].json

💬 Sobre as pastas

• Uma pasta dictionaries, contendo pastas nomeados conforme a linguagem (pt-BR, en-US, etc.).
• A pasta dictionaries contém uma pasta para cada linguagem disponível — pt-BR, en-US, es-ES, etc.

Cada pasta de linguagem contém um index.js, fazendo uma referência do tipo chave/valor por letra e arquivo. A definição de como importar pode ser planejada durante o desenvolvimento. A proposição de separar um arquivo para cada letra já foi sugerida no issue #116 durante discussão de recurso.

// index.js
import termsA from "./a.json";
...
import termsZ from "./z.json";

const terms = {
  a: termsA,
  b: termsB,
  ...
  z: termsZ
}

Dessa forma podemos garantir uma futura atualização de outras linguagens, adicionando outras pastas correspondentes. A implementação da localização fica por conta do código Javascript no backend.

Acredito que esta estrutura facilitaria o filtro por letras e ordenação personalizada no futuro. A proposta fica, então, aberta a discussão para a comunidade.

[george-gca]

Poderia inclusive fazer um loop por todos os arquivos json na pasta e importar, ao invés de manualmente fazer um import termsA from "./a.json"; pra cada letra. Fica menor o código e menos passível de alguém esquecer de importar algo, já que dentro dessa pasta os json vão ser exclusivamente de dados dos termos mesmo.

[andrepg]

Genial! 🤯

Fiquei no receio de sugerir desta forma por não estar 100% familiarizado com o código JS. Honestamente é uma excelente ideia “automatizar” a importação de arquivos, uma possibilidade também contemplada quando da sugestão de padrões de nomenclatura por linguagem e letra.

Desta forma, ainda, deveria ser possível eliminar a necessidade de um index.js por pasta de linguagem e levá-lo para a pasta [lang] em si, fazendo a importação da linguagem correta de uma só vez;

Eu só não concebi, ainda, como nomear estes imports para declaração (e por isso abrimos discussão 😄)

[george-gca]

Outra coisa, os termos internamente poderiam estar em ordem alfabética por chave.

[george-gca]

O que acham de depois que a #140 for "mergeada" na main, voltarmos nesse ponto? Acho que seria o momento perfeito pra adicionar essas mudanças. Lembrando que como o @andrepg disse:

Minimizar conflitos ao adicionar ou atualizar termos é uma premissa básica nesta tentativa.

Isso ia facilitar a adição de novos termos, visto que cada novo termo atualmente mexe sempre no mesmo arquivo.

[george-gca]

Dividir por letra e ordenar por ordem alfabética pela chave seria legal. E acho que dá até pra fazer o validador de json validar isso também, tem só que ver se dá pra criar um json schema pra isso.

[andrepg]

Olá, colegas.

Estou sumido por razões de deadline muito próximo. Mas continuo pensando nesta implementação. Uma coisa tem me chamado atenção, @levxyca.

Temos o #12 para redesenhar o site, porém está parado pelo Hacktober. Vamos voltar com ele, há possibilidade de isto nos afetar de alguma forma?

Logo após a resposta aqui vou baixar o projeto novamente e configurar no meu VSCode.

[george-gca]

Na verdade ele tinha parado pelo hacktoberfest do ano passado, então acho que podemos considerar ele abandonado haha.

[andrepg]

Perfeito. Guardemos esse trabalho porque fiquei fã dessa UI pra gente implementar 😄

[levxyca]

Exatamente isso, acabou que não houve tempo pra voltar pra essa implementação, mas a issue ainda tá lá registrada pois é uma UI bonitona que eu quero muito que a gente implemente um dia!