Skip to content

Link the README to GitHub so it works on npm #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bayasdev merged 1 commit into from
Nov 11, 2026
Merged

Link the README to GitHub so it works on npm #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ Prefer property-based tests, with [Hegel](https://hegel.dev/). The oracle in `te

A comment sits on the code it explains: never a file header, never above or among the imports (`file-comments/no-head-comments`).

## Changes

Every change reaches `main` through a pull request, merged with a squash once CI passes; `main` is protected and nobody pushes to it directly. A commit message is a short plain subject that says what changed, with no body.

## Releases

Bump `version` in `package.json` and add its entry to `CHANGELOG.md`, then push a `vX.Y.Z` tag that matches. `.github/workflows/publish.yml` publishes it with npm's trusted publishing and a provenance statement; no token is stored anywhere. A breaking change to what any function accepts is a major version.
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<p align="center">
<img src=".github/banner.png" alt="validator-ec: cédula, RUC y código postal ecuatorianos" width="720">
<img src="https://raw.githubusercontent.com/bayasdev/validator-ec/main/.github/banner.png" alt="validator-ec: cédula, RUC y código postal ecuatorianos" width="720">
</p>

# validator-ec

Valida cédulas, RUCs y códigos postales ecuatorianos con las reglas que publica el SRI.

[![npm](https://img.shields.io/npm/v/validator-ec)](https://www.npmjs.com/package/validator-ec) [![Descargas](https://img.shields.io/npm/dm/validator-ec)](https://www.npmjs.com/package/validator-ec) [![CI](https://github.com/bayasdev/validator-ec/actions/workflows/ci.yml/badge.svg)](https://github.com/bayasdev/validator-ec/actions/workflows/ci.yml) [![Licencia](https://img.shields.io/npm/l/validator-ec)](LICENSE)
[![npm](https://img.shields.io/npm/v/validator-ec)](https://www.npmjs.com/package/validator-ec) [![Descargas](https://img.shields.io/npm/dm/validator-ec)](https://www.npmjs.com/package/validator-ec) [![CI](https://github.com/bayasdev/validator-ec/actions/workflows/ci.yml/badge.svg)](https://github.com/bayasdev/validator-ec/actions/workflows/ci.yml) [![Licencia](https://img.shields.io/npm/l/validator-ec)](https://github.com/bayasdev/validator-ec/blob/main/LICENSE)

```typescript
import { isCedula, isRUC, parseIdentification } from "validator-ec";
Expand Down Expand Up @@ -115,7 +115,7 @@ Solo comprueba la forma. No hay una lista oficial abierta de los códigos que ex

## Desde la versión 1

La versión 2 cambia algunas respuestas para seguir al SRI. El [registro de cambios](CHANGELOG.md#200) explica cada una y cómo migrar.
La versión 2 cambia algunas respuestas para seguir al SRI. El [registro de cambios](https://github.com/bayasdev/validator-ec/blob/main/CHANGELOG.md#200) explica cada una y cómo migrar.

## Contribuir

Expand All @@ -128,10 +128,10 @@ pnpm test # pruebas
pnpm build # compilación
```

Las pruebas son propiedades con [Hegel](https://hegel.dev/) contra un oráculo escrito en la propia prueba a partir de la regla del SRI, y cada valor fijo cita de dónde sale. [AGENTS.md](AGENTS.md) tiene las reglas completas.
Las pruebas son propiedades con [Hegel](https://hegel.dev/) contra un oráculo escrito en la propia prueba a partir de la regla del SRI, y cada valor fijo cita de dónde sale. [AGENTS.md](https://github.com/bayasdev/validator-ec/blob/main/AGENTS.md) tiene las reglas completas.

Para publicar, sube una etiqueta `vX.Y.Z` que coincida con `package.json`: GitHub Actions publica en npm con la publicación de confianza, sin tokens.

## Licencia

[Apache 2.0](LICENSE). La lista de códigos postales con que se prueba `isZipCode` (`tests/data`) es de [GeoNames](https://www.geonames.org/), bajo [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
[Apache 2.0](https://github.com/bayasdev/validator-ec/blob/main/LICENSE). La lista de códigos postales con que se prueba `isZipCode` (`tests/data`) es de [GeoNames](https://www.geonames.org/), bajo [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
Loading