You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@
4
4
The ES module bundle lives in `src/` with `main.js` assembling provider and location metadata from `data/`. Generated assets resolve to `dist/` (never edit by hand) while validation utilities and scrapers reside in `tools/`. Sample integrations live under `examples/`, and exploratory notebooks plus CSV exports are stored in `notebooks/`. Tests that exercise the published build are in `test/index.test.mjs`.
5
5
6
6
## Build, Test, and Development Commands
7
-
Run `pnpm install` before contributing. `pnpm run prebuild` formats JSON and JavaScript and should precede any commit touching data. Build the distributable bundle with `pnpm run build`, which executes Rollup using `rollup.config.js`. Execute `pnpm test` to load the compiled bundle and assert key lookups. Data sanity checks are available via `pnpm run validate`, and provider maintenance commands such as `pnpm run provider:show vultr` and `pnpm run provider:update vultr ...` drive inventory refreshes.
7
+
Run `bun install` before contributing. `bun run prebuild` formats JSON and JavaScript and should precede any commit touching data. Build the distributable bundle with `bun run build`, which executes `bun build` against `src/main.js`. Execute `bun run test` to load the compiled bundle and assert key lookups. Data sanity checks are available via `bun run validate`, and provider maintenance commands such as `bun run provider:show vultr` and `bun run provider:update vultr ...` drive inventory refreshes.
8
8
9
9
## Coding Style & Naming Conventions
10
-
Contributors write modern ESM JavaScript with 2-space indentation. Favor immutable helpers and array iteration to keep dataset transformations predictable. Prettier 3 enforces formatting; run it through the `prebuild` script rather than manual touches. Provider keys must stay lowercase and hyphen-free, matching entries in `data/providers/*.json`. IATA location identifiers remain uppercase and align with the `iata` map.
10
+
Contributors write modern ESM JavaScript with 2-space indentation. Favor immutable helpers and array iteration to keep dataset transformations predictable. `oxfmt` enforces formatting; run it through the `prebuild` script rather than manual touches. Provider keys must stay lowercase and hyphen-free, matching entries in `data/providers/*.json`. IATA location identifiers remain uppercase and align with the `iata` map.
11
11
12
12
## Testing Guidelines
13
-
Tests rely on Node’s ESM runtime; ensure `dist/bundle.js` exists before running them. When adding new providers or locations, extend `test/index.test.mjs` with representative lookups so regressions surface quickly. Target smoke coverage for every provider touched, and prefer deterministic fixtures over live network calls.
13
+
Tests rely on Bun’s ESM runtime; ensure `dist/bundle.js` exists before running them. When adding new providers or locations, extend `test/index.test.mjs` with representative lookups so regressions surface quickly. Target smoke coverage for every provider touched, and prefer deterministic fixtures over live network calls.
14
14
15
15
## Commit & Pull Request Guidelines
16
-
Follow the Conventional Commit style observed in history (`build(deps-dev): bump rollup…`), using scopes like `data`, `build`, or `docs`. Each PR should describe dataset sources, tooling changes, and any scripts executed. Link tracking issues when available and attach screenshots only when UI artifacts (e.g., notebooks) are affected. Confirm that `pnpm run build` and `pnpm test` succeed before requesting review.
16
+
Follow the Conventional Commit style observed in history (`build(deps-dev): bump rollup…`), using scopes like `data`, `build`, or `docs`. Each PR should describe dataset sources, tooling changes, and any scripts executed. Link tracking issues when available and attach screenshots only when UI artifacts (e.g., notebooks) are affected. Confirm that `bun run build` and `bun run test` succeed before requesting review.
17
17
18
18
## Data & Security Notes
19
19
Document the provenance of new PoP coordinates in the PR body and avoid introducing personally identifiable information. Spotter scripts should only target public endpoints; capture new credentials via repository secrets rather than committed files.
Copy file name to clipboardExpand all lines: README.md
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,11 @@
6
6
7
7
ES Module with geolocation and IATA codes of Content Delivery Networks and hosting companies points of presence. Useful for plotting, planning and network measurements.
8
8
9
-
## 🔨 Install with `yarn` or `npm`
9
+
## 🔨 Install
10
+
11
+
```bash
12
+
bun add @adaptivelink/pops
13
+
```
10
14
11
15
```bash
12
16
yarn add @adaptivelink/pops
@@ -107,6 +111,14 @@ Spotters are scheduled GitHub Actions that continuously monitor CDNs and Hosting
107
111
108
112
Feel free to suggest or PR more networks and PoP locations.
0 commit comments