Commit 51e2bf0
committed
chore: tighten publish workflow and docs around generated build artifacts
Restructure repository and publishing ergonomics after the TypeScript migration by moving fully to generated build artifacts, improving contributor guidance, and documenting usage with a more explicit developer-first README.
Repository and workflow updates:
- Stop tracking compiled output in git and treat it as generated build output.
- Keep npm package output unchanged by continuing to publish via package and lifecycle build hooks.
- Update with a more complete Node/TS baseline:
- ignore , tsbuildinfo, coverage output, common debug logs, env-local variants, and editor/OS noise.
- Update as a defense-in-depth publish filter for local-only, source-only, and tool metadata files.
- Replace with in so build happens consistently during
> @timmsy/riftjs@3.1.0 prepack
> npm run build
> @timmsy/riftjs@3.1.0 build
> tsc -p tsconfig.json and
> @timmsy/riftjs@3.1.0 prepack
> npm run build
> @timmsy/riftjs@3.1.0 build
> tsc -p tsconfig.json.
Documentation overhaul:
- Rewrite README into a practical, step-by-step guide with clear install/setup flow.
- Add separate quick-start examples for CommonJS and TypeScript users.
- Expand endpoint reference with explicit inputs, outputs, option shapes, and pacing behavior.
- Document supported region routing behavior and normalized error semantics.
- Clarify local development lifecycle (, , optional env vars) and package output structure.
- Link maintainer guidance from the README.
Maintainer guidance and in-code intent notes:
- Add with project scope, API stability expectations, typing standards, rate-limit posture, and release checklist.
- Add maintainability comments in core TS modules to preserve implementation intent around:
- strict region validation
- class API surface wiring
- Data Dragon base URL concurrency handling
- conservative pacing defaults and sequential detail fetching
- test skip semantics for no-match accounts
- Standardize maintainer comment attribution to .
Net effect:
This commit reduces repository noise, keeps published package behavior stable, and significantly improves onboarding/maintenance clarity for both users and contributors without changing the public runtime API surface.1 parent 3116e0e commit 51e2bf0
File tree
19 files changed
+331
-606
lines changed- dist
- endpoints
- src
- endpoints
19 files changed
+331
-606
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
2 | 5 | | |
3 | | - | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
4 | 10 | | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
1 | 2 | | |
| 3 | + | |
| 4 | + | |
2 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
3 | 15 | | |
4 | | - | |
5 | | - | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
6 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
0 commit comments