https://github.com/piperubio/clregions
https://github.com/piperubio/clregions
chile cl communes comunas javascript js npm provinces provincias regiones regions ts typescript
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/piperubio/clregions
- Owner: piperubio
- License: mit
- Created: 2023-02-08T13:53:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-21T17:28:17.000Z (10 months ago)
- Last Synced: 2025-09-30T10:25:35.400Z (8 months ago)
- Topics: chile, cl, communes, comunas, javascript, js, npm, provinces, provincias, regiones, regions, ts, typescript
- Language: Jupyter Notebook
- Homepage:
- Size: 484 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clregions — datos y utilidades de regiones, provincias y comunas de Chile
Monorepo con dos paquetes publicados en npm para trabajar con la división político–administrativa de Chile.
- `@clregions/data`: datos tipados (objeto y arrays) listos para usar en Node, navegador o CDN.
- `@clregions/core`: utilidades inmutables y tipadas para consultar regiones, provincias y comunas.
## Enlaces rápidos
- Paquete core: ./packages/core/README.md
- Paquete data: ./packages/data/README.md
- Ejemplos: ./examples
## Instalación rápida
```bash
npm install @clregions/core
# o
npm install @clregions/data
```
## Uso básico (@clregions/core)
```ts
import { findRegionById } from '@clregions/core';
const rm = findRegionById('13');
```
## Características
- Tipos estrictos para regiones, provincias y comunas
- ESM/CJS; funciona en Node y navegadores (vía bundlers)
- Sin dependencias externas
- Datos mantenidos en `@clregions/data` y consumidos de forma inmutable en `@clregions/core`
## Desarrollo
Requisitos: Node 18+, pnpm.
```bash
pnpm i
pnpm -w -F @clregions/core build
pnpm -w -F @clregions/data build
pnpm -F @clregions/core test
```
Format y lint:
```bash
pnpm biome format --write .
pnpm biome check .
pnpm -F @clregions/core lint
pnpm -F @clregions/data lint
```
## Estructura
- packages/core: API de consulta inmutable sobre los datos.
- packages/data: dataset tipado y exportado en distintos formatos.
- examples: ejemplos HTML, Node y Vite.
## Licencia y contribución
MIT. PRs y discusiones bienvenidas.