chore/setup-code-formatter-and-linting

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 'lts/*'
+          node-version: '20.19.0'
       - run: npm i
       - run: npm audit --production --level-critical
   test:

.github/workflows/publish.yml

@@ -2,7 +2,7 @@ name: Publish Package to npmjs
 on:
   push:
     branches:
-      - main
+      - master
   release:
     types: [published]
 jobs:
@@ -13,7 +13,7 @@ jobs:
       # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v3
         with:
-          node-version: 'lts/*'
+          node-version: '20.19.0'
           registry-url: 'https://registry.npmjs.org'
       - run: |
           if [ -e yarn.lock ]; then

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: Release
 on:
   workflow_run:
     workflows: ['Snyk Security Check']
-    branches: [main]
+    branches: [master]
     types:
       - completed
 jobs:
@@ -17,7 +17,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 'lts/*'
+          node-version: '20.19.0'
       - name: Install dependencies
         run: npm ci
       - name: Release

.husky/pre-commit

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn format
+yarn lint
+yarn test
+yarn build

.npmignore

@@ -0,0 +1,5 @@
+.npmignore
+yarn.lock
+CONTRIBUTING.md
+CONTRIBUTOR_COVENANT.md
+test/*

README.md

@@ -160,6 +160,10 @@ yarn add rwanda
 
 <table>
   <tr>
+    <td align="center"><a href="https://github.com/shyakadavis"><img 
+    style="border-radius:50%"
+    src="https://github.com/shyakadavis.png" width="100px;" alt="Shyaka Davis"/><br /><sub><b>
+Shyaka Davis</b></sub></td>
     <td align="center"><a href="https://github.com/Karlmusingo"><img 
     style="border-radius:50%"
     src="https://github.com/Karlmusingo.png" width="100px;" alt="Karl MUSINGO"/><br /><sub><b>

biome.json

@@ -0,0 +1,12 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.1.3/schema.json",
+	"formatter": {
+	  "enabled": true
+	},
+	"linter": {
+	  "enabled": true,
+	  "rules": {
+		"recommended": true
+	  }
+	}
+  }

package.json

@@ -1,5 +1,6 @@
 {
 	"name": "rwanda",
+	"version": "3.0.1",
 	"description": "This package provides you access to provinces, districts, sectors, villages and cells found in Rwanda",
 	"type": "module",
 	"files": [
@@ -19,22 +20,44 @@
 		"build": "tsc && vite build",
 		"preview": "vite preview",
 		"test": "vitest run",
-		"test:watch": "vitest watch"
+		"test:watch": "vitest watch",
+		"format": "biome format src/ test/ --write",
+		"format:check": "biome format --check src/ test/",
+		"lint": "biome lint src/ test/",
+		"lint:fix": "biome lint --apply src/ test/",
+		"prepare": "husky install"
 	},
 	"devDependencies": {
+		"@biomejs/biome": "^2.1.4",
 		"husky": "^9.1.7",
-		"pathe": "^1.1.1",
-		"typescript": "^5.0.2",
-		"vite": "^4.4.5",
-		"vite-plugin-dts": "^3.6.0",
-		"vitest": "^0.34.6"
+		"pathe": "^2.0.3",
+		"typescript": "^5.9.2",
+		"vite": "^7.1.1",
+		"vite-plugin-dts": "^4.5.4",
+		"vitest": "^3.2.4"
+	},
+	"engines": {
+		"node": "20.19.0"
 	},
 	"license": "MIT",
-	"version": "3.0.0",
 	"repository": {
 		"type": "git",
 		"url": "git://github.com/knowbee/rwanda.git"
 	},
+	"keywords": [
+		"rwanda",
+		"urwanda",
+		"u rwanda",
+		"intara",
+		"uturere",
+		"akarere",
+		"imirenge",
+		"umurenge",
+		"utugari",
+		"akagari",
+		"imidugudu",
+		"umudugudu"
+	],
 	"author": "Igwaneza Bruce <knowbeeinc@gmail.com>",
 	"homepage": "https://github.com/knowbee/rwanda"
 }

src/data/provinces/west/districts/rubavu/sectors/kanama/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Kamuhoza: Cell = [
 	"Bambiro",

src/data/provinces/west/districts/rubavu/sectors/kanzenze/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Kanyirabigogo: Cell = ["Giramata", "Kabana", "Mizingo", "Murambi"];
 

src/data/provinces/west/districts/rubavu/sectors/mudende/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Bihungwe: Cell = ["Bihungwe", "Bivumu", "Bunyove", "Mwirima", "Rukeri"];
 

src/data/provinces/west/districts/rubavu/sectors/nyakiriba/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Bisizi: Cell = [
 	"Bweza",

src/data/provinces/west/districts/rubavu/sectors/nyamyumba/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Burushya: Cell = [
 	"Kaberamo",

src/data/provinces/west/districts/rubavu/sectors/nyundo/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Bahimba: Cell = [
 	"Bahimba",

src/data/provinces/west/districts/rubavu/sectors/rubavu/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Buhaza: Cell = ["Dufatanye", "Gabiro", "Murambi"];
 

src/data/provinces/west/districts/rubavu/sectors/rugerero/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Basa: Cell = [
 	"Buranga",

src/data/provinces/west/districts/rusizi/sectors/bugarama/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Nyange: Cell = [
 	"Cité",

src/data/provinces/west/districts/rusizi/sectors/butare/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Butanda: Cell = [
 	"Buganzo",

src/data/provinces/west/districts/rusizi/sectors/bweyeye/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Gikungu: Cell = ["Kibonajoro", "Rwamagare"];
 

src/data/provinces/west/districts/rusizi/sectors/gashonga/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Birembo: Cell = ["Mariba", "Burama"];
 

src/data/provinces/west/districts/rusizi/sectors/giheke/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Cyendajuru: Cell = ["Burembo", "Kabeza", "Kibakure", "Murinzi"];
 

src/data/provinces/west/districts/rusizi/sectors/gihundwe/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Burunga: Cell = [
 	"Burunga",

src/data/provinces/west/districts/rusizi/sectors/gikundamvura/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Kizura: Cell = [
 	"Gasharu",

src/data/provinces/west/districts/rusizi/sectors/gitambi/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Cyingwa: Cell = [
 	"Kabucuku",

src/data/provinces/west/districts/rusizi/sectors/kamembe/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Cyangugu: Cell = [
 	"Gatovu",

src/data/provinces/west/districts/rusizi/sectors/muganza/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Cyarukara: Cell = [
 	"Gashinjano",

src/data/provinces/west/districts/rusizi/sectors/mururu/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Gahinga: Cell = [
 	"Birogo",

src/data/provinces/west/districts/rusizi/sectors/nkanka/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Gitwa: Cell = [
 	"Buganda",

src/data/provinces/west/districts/rusizi/sectors/nkombo/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Bigoga: Cell = [
 	"Gisunyu",

src/data/provinces/west/districts/rusizi/sectors/nkungu/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Gatare: Cell = [
 	"Bahuro",

src/data/provinces/west/districts/rusizi/sectors/nyakabuye/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Gasebeya: Cell = [
 	"Biteri",

src/data/provinces/west/districts/rusizi/sectors/nyakarenzo/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Gatare: Cell = ["Bigando", "Kabumbwe", "Rwindare"];
 

src/data/provinces/west/districts/rusizi/sectors/nzahaha/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Butambamo: Cell = [
 	"Gashagwa",

src/data/provinces/west/districts/rusizi/sectors/rwimbogo/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Karenge: Cell = [
 	"Batura",

src/data/provinces/west/districts/rutsiro/sectors/boneza/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Bushaka: Cell = [
 	"Bikono",

src/data/provinces/west/districts/rutsiro/sectors/gihango/index.ts

@@ -4,7 +4,7 @@
  * -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  */
 
-import { Cell, Sector } from "@rwanda/types";
+import type { Cell, Sector } from "@rwanda/types";
 
 const Bugina: Cell = ["Gishushu", "Gitarama", "Kagarama", "Karambi"];