Aprimorando a seleção de versículos bíblicos #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a JSON schema to validate the structure and uniqueness of verses. This addition not only provides intellisense for future contributors but also ensures that each item contains the necessary: abbreviation, chapter, and verse, and that there are no duplicate verses. This promotes greater data integrity within the project.
This addition implements validation of `verses.json` against `verses.schema.json` using ajv-cli in Husky's pre-commit. This ensures the integrity and consistency of the verses in the project with each commit, ensuring that only "valid" data is sent to the repository. Additionally, the execution of the linting script has been included in the pre-commit to maintain code quality. The setup of @commitlint/cli and @commitlint/config-conventional has also been configured, providing a consistent pattern for commit messages ensured by Husky.
Now, the API URL is defined through an environment variable, allowing flexibility to use different URLs according to the execution environment. Also implements type and validation of environment variables. Additionally, adds a function to facilitate and abstract requests to our API routes for better code organization and readability.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Estou empolgado em mostrar essas melhorias na seleção dos versículos, olha o que fizemos:
Adicionamos uma lista de versículos pré-selecionados para resolver o problema da falta de contexto em alguns versículos, conforme descrito na issue #2.
Implementamos um schema JSON para validar o arquivo
verses.json(lista de versículos), garantindo consistência e prevenindo erros de formatação. Além disso, o arquivo agora conta com suporte a intellisense para facilitar a edição.Antes de realizar um commit, o husky executa um script para garantir que o arquivo de versículos esteja de acordo com o schema JSON. Além disso, são executados lint e verificação do padrão de commit (Conventional Commits). Qualquer falha nesses processos resultará no bloqueio do commit.
Adicionamos uma nova variável de ambiente chamada
API_BASE_URLpara permitir uma URL a cada ambiente. Isso se tornou necessário por conta de uma nova rota (/api/random-verse) para buscar um versículo aleatório da lista (verses.json) e, em seguida, fazer a requisição deste versículo na API do @omarciovsena. Também implementamos validação e tipagem das variáveis de ambiente.Por favor, se puder dar uma olhada, pode ser que deixei passar algo nestas modificações… além disso você pode ver algum ponto a ser melhorado!
Se estiver com dúvida ou precisar de alguma informação, não hesite em deixar um comentário aqui!