0.1.5 • Published 11 months ago
@duaneoli/types-env v0.1.5
Types-env
A Types-env
é uma biblioteca para o Node.js que permite tipar e validar as variáveis de ambiente do seu projeto, utilizando o esquema de validação do Joi.
Instalação
Certifique-se de ter o Node.js instalado em seu sistema. Em seguida, execute o seguinte comando para instalar a biblioteca:
npm install @duaneoli/types-env
ou
yarn @duaneoli/types-env
Uso
Aqui está um exemplo básico de como usar a biblioteca Types-env
:
import { CreateEnvironment, TypesJoi } from '@duaneoli/types-env'
// Defina o esquema de validação utilizando o Joi
const environmentSchema = {
ALLOW_ALL_ORIGINS_ON_CORS: TypesJoi.boolean().default(false),
PORT: TypesJoi.number().default(3000),
}
const ENVIRONMENT = CreateEnvironment(TypesJoi.object(environmentSchema))
export default ENVIRONMENT
// Carregue as variáveis de ambiente e valide-as
import ENVIRONMENT
// Agora você pode acessar as variáveis de ambiente tipadas
console.log(ENVIRONMENT.PORT) // Valor padrão: 3000
console.log(ENVIRONMENT.ALLOW_ALL_ORIGINS_ON_CORS) // Deve ser false
Caso alguma variavel de ambiente esteja faltando o codigo ira executar um process.exit() parando a aplicação
#Recursos A biblioteca Types-env oferece os seguintes recursos:
- Tipagem e validação de variáveis de ambiente usando o esquema de validação do Joi.
- Valores padrão para variáveis não obrigatórias.
- Facilidade de carregar e acessar as variáveis de ambiente tipadas.
- Alguns objetos de validação padrão.
Contribuição
Se você deseja contribuir para a biblioteca, siga estas etapas:
- Faça um fork do repositório.
- Crie uma branch para a sua nova feature (
git checkout -b feature/nova-feature
). - Faça commit das suas alterações utilizando o padrão de commit "Git CZ". Para criar um commit, você pode usar o seguinte comando:
- Utilizando Yarn:
yarn commit
- Utilizando npx:
O padrão "Git CZ" oferece um guia interativo para criar mensagens de commit padronizadas.npx run commit
- Utilizando Yarn:
- Faça push para a branch (
git push origin feature/nova-feature
). - Abra um Pull Request.
Suporte
Se você tiver algum problema ou dúvida relacionada à biblioteca, abra uma issue no repositório do GitHub.