Skip to content

Release docs, README/config fixes, and dev dependency bumps#191

Merged
bartes merged 3 commits into
masterfrom
docs/releasing-npm
Jun 3, 2026
Merged

Release docs, README/config fixes, and dev dependency bumps#191
bartes merged 3 commits into
masterfrom
docs/releasing-npm

Conversation

@bartes
Copy link
Copy Markdown
Contributor

@bartes bartes commented Jun 2, 2026

  • Update RELEASING.md to npm: npm install, npm run build && npm pack, npm publish; drop src from the git clean step.
  • Add the required author field to the createListItem README example.
  • Fix the searchListItems README example: filters takes an array of { field, op, value }.
  • Widen trustedProxies to (string | RegExp)[]; entries are wrapped in new RegExp(...) in the constructor.
  • Errors section: ConfigurationError and WebhookVerificationError extend Error directly.
  • Bump dev dependencies within their current majors: @eslint/eslintrc 3.3.5, @typescript-eslint/* 8.60.1, eslint-config-prettier 10.1.8, eslint-plugin-prettier 5.5.6, express 5.2.1, jest 30.4.2, prettier 3.8.3, rimraf 6.1.3, ts-jest 29.4.11, tsup 8.5.1.

bartes added 2 commits June 2, 2026 20:14
The repo switched from Yarn to npm in 3.0.0; update the release steps
(`npm install` / `npm run build && npm pack` / `npm publish`) and drop the
now-tracked `src` from the `git clean` step.
- `createListItem` example was missing the required `author` field, so it
  did not type-check against `CreateListItemPayload`.
- `searchListItems` `filters` is an array of filter objects, not an object;
  fix the example accordingly.
- Widen `ConfigurationProperties.trustedProxies` to `(string | RegExp)[]` so
  the documented string form type-checks (the constructor already wraps each
  entry in `new RegExp(...)`); update the config table type to match.
- Clarify in the errors section that `ConfigurationError` and
  `WebhookVerificationError` extend `Error` directly rather than `APIError`.
@bartes bartes changed the title docs: update RELEASING.md to npm docs: modernize release docs; fix README/config inaccuracies Jun 2, 2026
- @eslint/eslintrc 3.3.5
- @typescript-eslint/eslint-plugin, @typescript-eslint/parser 8.60.1
- eslint-config-prettier 10.1.8
- eslint-plugin-prettier 5.5.6
- express 5.2.1
- jest 30.4.2
- prettier 3.8.3
- rimraf 6.1.3
- ts-jest 29.4.11
- tsup 8.5.1
@bartes bartes changed the title docs: modernize release docs; fix README/config inaccuracies Release docs, README/config fixes, and dev dependency bumps Jun 2, 2026
@bartes bartes merged commit 95dbbbe into master Jun 3, 2026
5 checks passed
@bartes bartes deleted the docs/releasing-npm branch June 3, 2026 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants