@echecs/pgn 3.6.2 → 3.8.0

package/CHANGELOG.md

@@ -8,6 +8,46 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [3.8.0] - 2026-03-15
+
+### Added
+
+- `onWarning` now fires for move number mismatches (e.g. `5. e4` appearing as
+  the first move). Previously emitted unconditionally to `console.warn`; now
+  routed through `onWarning` when provided. `console.warn` is no longer called
+  for move number mismatches — if you relied on it, add an `onWarning` callback.
+- `onWarning` fires when the `[Result "..."]` tag value does not match the game
+  termination marker at the end of the movetext (e.g. `[Result "1/2-1/2"]` with
+  a `1-0` termination marker).
+- `onWarning` fires for duplicate tag names (same tag appearing more than once
+  in the tag pair section). The `line` and `column` fields point to the opening
+  `[` of the duplicate — exact source position, not a nominal placeholder.
+
+### Changed
+
+- Move number mismatch no longer emits to `console.warn` when `onWarning` is not
+  provided. It is now silently ignored, consistent with how missing STR tag
+  warnings are handled.
+
+## [3.7.0] - 2026-03-15
+
+### Added
+
+- `onWarning` option for `parse()` and `stream()`: fires once per missing STR
+  tag. Emitted in alphabetical key order: `Black`, `Date`, `Event`, `Result`,
+  `Round`, `Site`, `White`.
+- `ParseWarning` is now an exported type with the same shape as `ParseError`.
+
+### Fixed
+
+- `parse()` and `stream()` now strip a UTF-8 BOM (`\uFEFF`) at the start of
+  input. Chessbase and Windows editors commonly produce BOM-prefixed PGN files
+  that previously failed silently.
+- Tag values containing escaped quotes (`\"`) or escaped backslashes (`\\`) now
+  parse correctly per PGN spec section 7.
+- Games with no tag pairs (bare move list + result) now parse correctly per PGN
+  spec section 8.1 ("zero or more tag pairs"). These games return `meta: {}`.
+
 ## [3.6.2] - 2026-03-15
 
 ### Performance

package/README.md

@@ -135,6 +135,37 @@ for await (const game of stream(chunks, { onError: console.error })) {
 > (truncated input). Incomplete input at end-of-stream is treated as expected
 > behaviour, not a parse error.
 
+### Warnings
+
+Pass `onWarning` to observe spec-compliance issues that do not prevent parsing:
+
+```typescript
+import parse, { type ParseWarning } from '@echecs/pgn';
+
+const games = parse(input, {
+  onWarning(warn: ParseWarning) {
+    console.warn(warn.message);
+  },
+});
+```
+
+`onWarning` receives a `ParseWarning` with the same fields as `ParseError`:
+`message`, `offset`, `line`, `column`.
+
+Currently fires for:
+
+- Missing STR tags (`Black`, `Date`, `Event`, `Result`, `Round`, `Site`,
+  `White`) — emitted in alphabetical key order; position fields are nominal
+  placeholders
+- Move number mismatch (declared move number in the PGN text doesn't match the
+  move's actual position) — position fields are nominal placeholders
+- Result tag mismatch (`[Result "..."]` tag value differs from the game
+  termination marker) — position fields are nominal placeholders
+- Duplicate tag names — `line` and `column` point to the opening `[` of the
+  duplicate tag
+
+The same option is accepted by `stream()`.
+
 ### PGN object
 
 ```typescript