@solvro/config
v2.0.7
Published
Solvro's engineering style guide
Readme
@solvro/config
Instalacja
Wszystkie konfiguracje są zawarte w jednej paczce @solvro/config. Aby zainstalować:
Tryb interaktywny (zalecany)
npx @solvro/configI przeklikaj się przez kreatora, polecam klikać cały czas enter, to dostaniesz zalecane konfiguracje. Można uruchamiać pare razy :3
Tryb nieinteraktywny (z flagami CLI)
Jeśli pracujesz w środowisku bez interaktywnej powłoki (np. CI/CD), możesz użyć flag CLI:
# Zainstaluj wszystkie narzędzia
npx @solvro/config --all
# Zainstaluj wybrane narzędzia
npx @solvro/config --eslint --prettier --commitlint
# Wymuś instalację bez sprawdzania Git
npx @solvro/config --force --allDostępne flagi
--all,-a- zainstaluj wszystkie narzędzia (ESLint, Prettier, GitHub Actions, Commitlint)--eslint- zainstaluj konfigurację ESLint--prettier- zainstaluj konfigurację Prettier--gh-action- zainstaluj GitHub Actions--commitlint- zainstaluj konfigurację Commitlint--force,-f- pomiń sprawdzenie czy Git jest czysty--help- wyświetl pomoc
Prettier
Aby użyć configu dodaj to pole w package.json:
{
"prettier": "@solvro/config/prettier"
}Eslint
Wymagany jest eslint w wersji 9 lub nowszej oraz package.json powinien mieć pole
{
"type": "module"
}Konfiguracja eslinta:
// eslint.config.js
import { solvro } from "@solvro/config/eslint";
export default solvro();Config sam wykryje czy używasz NextJSa czy Adonisa.
Development & Testing
Integration Tests
Projekt zawiera kompleksowe testy integracyjne, które testują instalację i działanie konfiguracji na świeżej aplikacji Next.js:
# Uruchom testy integracyjne lokalnie
npm run test:integration
# Lub bezpośrednio
./scripts/test-integration.shContinuous Integration
Testy integracyjne są automatycznie uruchamiane w CI/CD dla:
- Różnych wersji Node.js (20, 22)
- Różnych wersji Next.js (latest, canary)
- Testowania poszczególnych narzędzi (ESLint, Prettier, Commitlint, GitHub Actions)
- Warunków błędów i edge cases
Testy obejmują:
- ✅ Tworzenie świeżej aplikacji Next.js
- ✅ Instalację @solvro/config
- ✅ Konfigurację wszystkich narzędzi
- ✅ Uruchamianie ESLint i Prettier
- ✅ Weryfikację formatowania kodu
- ✅ Build aplikacji Next.js
- ✅ Testowanie warunków błędów
