opening_hours 3.10.0 → 3.12.0

package/CHANGELOG.md

@@ -8,6 +8,100 @@ SPDX-License-Identifier: LGPL-3.0-only
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [3.12.0](https://github.com/opening-hours/opening_hours.js/compare/v3.11.0...v3.12.0) (2026-03-21)
+
+
+### Features
+
+* add error tolerance tests for languages with Unicode characters and ambiguous words ([3f9fe33](https://github.com/opening-hours/opening_hours.js/commit/3f9fe33ba5a613959b13b34942434f27a93cd0b3))
+* also use short names for weeks and months ([44d059a](https://github.com/opening-hours/opening_hours.js/commit/44d059a9bf7d9d69a66c6c64a398fc4e400c12c7))
+* expand locale pattern discovery to 3-letter codes ([032c18a](https://github.com/opening-hours/opening_hours.js/commit/032c18a779dc7a06254409413bd74dde2edbec78))
+* implement dynamic word error correction generator with zero dependencies ([361ca2d](https://github.com/opening-hours/opening_hours.js/commit/361ca2d4e5a5ccb408be32d7168bc832cb5ab891))
+
+
+### Documentation
+
+* rename develop branch to main (overwrites main) ([5cde3f5](https://github.com/opening-hours/opening_hours.js/commit/5cde3f57cc18898ef0ad995fcd4126d709c1b86a)), closes [#554](https://github.com/opening-hours/opening_hours.js/issues/554)
+* update localization documentation to include word error correction system details ([957cc5c](https://github.com/opening-hours/opening_hours.js/commit/957cc5cbc2bd5ea0d6d50189fc6ccf81cd426f60))
+
+
+### Code Refactoring
+
+* adapt yargs calls to v18 API ([f0ea1c7](https://github.com/opening-hours/opening_hours.js/commit/f0ea1c7b70ab1b2114a6fd255b91e1db3ac4b352))
+* remove non-functional concept script `scripts/gen_word_error_correction.js`` ([c22fff9](https://github.com/opening-hours/opening_hours.js/commit/c22fff9bac62a540e7953304fed26c68be41bd0b))
+* remove redundant entries from manual word corrections ([b5fc898](https://github.com/opening-hours/opening_hours.js/commit/b5fc8986ccf725d0a1610690dc0112d7cb7cff37))
+* replace String.prototype patching with c namespace for style helpers ([8e384bd](https://github.com/opening-hours/opening_hours.js/commit/8e384bd969072773a46b723dd4a88934fe40b420))
+
+## [3.11.0](https://github.com/opening-hours/opening_hours.js/compare/v3.10.0...v3.11.0) (2026-01-25)
+
+
+### Features
+
+* add helpful error message for invalid variable time offset syntax ([c817897](https://github.com/opening-hours/opening_hours.js/commit/c8178976b7e5868f3b02e309f3af57af3735ba1c))
+* **evaluation-tool:** improve diff comparison UX and dark mode ([b63ca2d](https://github.com/opening-hours/opening_hours.js/commit/b63ca2d51e7c818dacfcd9c15ff6d602efa7f347))
+* **evaluation-tool:** improve language selection UX ([d2e8dec](https://github.com/opening-hours/opening_hours.js/commit/d2e8dec6a1153253e330663b8daac8dae52f4722))
+* **evaluation-tool:** modernize UI with dark mode and responsive design ([f706813](https://github.com/opening-hours/opening_hours.js/commit/f7068138da13e7a51a63fb710241914b9411b6bb))
+* **evaluation-tool:** redesign status display with timeline and improved table ([5d060a8](https://github.com/opening-hours/opening_hours.js/commit/5d060a8d7831d2122d02c098dc6f5a4bc71ea28f))
+* **holidays:** migrate school holidays to OpenHolidays data ([b9b48f0](https://github.com/opening-hours/opening_hours.js/commit/b9b48f01eddbec261ccdb4d2de9f2319129e965c))
+
+
+### Bug Fixes
+
+* add missing else in formatWarnErrorMessage function ([4c41166](https://github.com/opening-hours/opening_hours.js/commit/4c41166f3e3dbcf80fa95722d5b6ad330f19594e))
+* **evaluation-tool:** fix specification links in value_explanation ([6807459](https://github.com/opening-hours/opening_hours.js/commit/680745923629cfa15a8051d9e045d95141910b86)), closes [#546](https://github.com/opening-hours/opening_hours.js/issues/546)
+* remove redundant console logs from formatWarnErrorMessage function ([78d6395](https://github.com/opening-hours/opening_hours.js/commit/78d63952fc62bd581aaae31a2c0a1204015d5e09))
+* **scripts:** handle empty/invalid JSON files in real_test.js ([bab7f5a](https://github.com/opening-hours/opening_hours.js/commit/bab7f5a093eedff14a1ec5e88fd2a7117916564e))
+* **tooling:** fix taginfo downloads with pagination support ([7b5d777](https://github.com/opening-hours/opening_hours.js/commit/7b5d777d75be33d5d5f14b186602428e70bbfe05))
+
+
+### Data Updates
+
+* **fr:** add 2026-2027 school holidays and fix 2024 dates ([383525e](https://github.com/opening-hours/opening_hours.js/commit/383525eac0a45dbc23e5fd484f6b2c44566ededb))
+* update Argentina 2026 public holidays ([73eb195](https://github.com/opening-hours/opening_hours.js/commit/73eb195d2b59b6b2d1727da694de31539e5a6b0e))
+
+
+### Documentation
+
+* `build` is not a valid commit scope to avoid `build(build)` ([f26b82b](https://github.com/opening-hours/opening_hours.js/commit/f26b82b6ef82d75a171f1c5f63fcc9fe9421e3a2))
+* add `evaluation-tool` as common git commit scope ([93a13d7](https://github.com/opening-hours/opening_hours.js/commit/93a13d72eb19461bed053e2b93c57d71a51e53ae))
+* do not overuse the term "main" to avoid confusion ([4bf17d8](https://github.com/opening-hours/opening_hours.js/commit/4bf17d8be6e082c8fc0b56c19c55691154732030))
+* **evaluation-tool:** remove term "GPG" from noscript HTML tag ([aa8e75c](https://github.com/opening-hours/opening_hours.js/commit/aa8e75c621154f2067dc65620b15d8efa8625e16))
+* give more specific commit message example ([972558c](https://github.com/opening-hours/opening_hours.js/commit/972558c0a1ff7d29faf09c0b7fb4ca445b4a527c))
+* **readme:** mention Major Evaluation Tool Redesign under Maintainers ([5d076c8](https://github.com/opening-hours/opening_hours.js/commit/5d076c84f8dffa75621c9e53fd02569ec68c827f)), closes [#542](https://github.com/opening-hours/opening_hours.js/issues/542)
+* update osm-tag-data-check to osm-tag-data-taginfo-check ([25812d6](https://github.com/opening-hours/opening_hours.js/commit/25812d6c6c3da2d89966e5f6d523cd480d0044b1))
+* update Releasing section ([7c0da2f](https://github.com/opening-hours/opening_hours.js/commit/7c0da2f554275cca35d99cafdd3dfb2c4b99a324))
+* update VCS URL of YoHours ([6974460](https://github.com/opening-hours/opening_hours.js/commit/6974460d052b7ef3e29ae6934c1001c36afea401))
+
+
+### Code Refactoring
+
+* **evaluation-tool:** export module state from helpers/main instead of window globals ([acb9393](https://github.com/opening-hours/opening_hours.js/commit/acb9393717711b5226477d9ebdb78ae0adfca973))
+* **evaluation-tool:** extract inline scripts ([680d323](https://github.com/opening-hours/opening_hours.js/commit/680d32328ca3d5f992ef29b05d8f03a3e7beb998))
+* **evaluation-tool:** improve handleDiffComparison type safety and readability ([84fa9a8](https://github.com/opening-hours/opening_hours.js/commit/84fa9a8711b78c7084c528c7794085fa63d7e0f7))
+* **evaluation-tool:** improve readability of generateValueExplanation ([73ac361](https://github.com/opening-hours/opening_hours.js/commit/73ac36193f18df4408de1297e5850b986d94008d))
+* **evaluation-tool:** merge example lists ([1ec616a](https://github.com/opening-hours/opening_hours.js/commit/1ec616a34f6bfeacc314454e1d08339d7de613d9)), closes [#103](https://github.com/opening-hours/opening_hours.js/issues/103)
+* **evaluation-tool:** migrate to ES modules ([714eb22](https://github.com/opening-hours/opening_hours.js/commit/714eb22d25c044dc664b0486b3afe6b015f3a7de))
+* **evaluation-tool:** modernize Nominatim geocoding ([4e0b3d8](https://github.com/opening-hours/opening_hours.js/commit/4e0b3d8b9ac108c1261fe02383aab8329bbb32a6))
+* **evaluation-tool:** move script tags to head with defer ([18b0499](https://github.com/opening-hours/opening_hours.js/commit/18b049999a65f2d2eaaaa885a739af119121c5fb))
+* **evaluation-tool:** remove unused hidden iframe ([9f7bced](https://github.com/opening-hours/opening_hours.js/commit/9f7bced69f33d3cb67aafc23b543678f296cde8d))
+* **evaluation-tool:** rename printDate func to toISODateString ([d15af56](https://github.com/opening-hours/opening_hours.js/commit/d15af566a8664fd3ac47cd6ced03999894f18b66))
+* **evaluation-tool:** replace `javascript:` URLs with event delegation ([3172e07](https://github.com/opening-hours/opening_hours.js/commit/3172e0768d8f90fe20a8e5c2fb974455a1e7ed8d))
+* **evaluation-tool:** replace jQuery with modern vanilla JavaScript ([7e450d0](https://github.com/opening-hours/opening_hours.js/commit/7e450d099103c012d512f81f65115ed60326c024))
+* **evaluation-tool:** replace repetitive inline handlers with event delegation ([b3cf85f](https://github.com/opening-hours/opening_hours.js/commit/b3cf85fca535d3cd09a5930c1208b89ffe14e52b))
+* **evaluation-tool:** replace XMLHttpRequest with fetch API ([190989d](https://github.com/opening-hours/opening_hours.js/commit/190989d6ed14ef1cb9af4456aa30bde064fa9a4e))
+* **evaluation-tool:** simplify and modernize permalink generation ([aa06419](https://github.com/opening-hours/opening_hours.js/commit/aa06419823316da6fe2a22a55afb7fcfbc77920f))
+* **evaluation-tool:** simplify initialization flow ([72f5e9c](https://github.com/opening-hours/opening_hours.js/commit/72f5e9c4d6e3f8a549455de58cde899e75d00405))
+* **evaluation-tool:** streamline DOM manipulation by removing unnecessary checks ([1ca6e20](https://github.com/opening-hours/opening_hours.js/commit/1ca6e20ed826eee2fa4c6452e29479a1e83597f3))
+* **evaluation-tool:** use semantic HTML elements ([b5b8fe7](https://github.com/opening-hours/opening_hours.js/commit/b5b8fe799dc30957ca8ab28bae805fb7801b4f1c))
+* **evaluation-tool:** use template literals and const/let ([386d600](https://github.com/opening-hours/opening_hours.js/commit/386d600aeeb87ad7d41551beb39ada16ce713781))
+* **evaluation-tool:** use URLSearchParams in page initialization ([3851dfb](https://github.com/opening-hours/opening_hours.js/commit/3851dfb21711a2b62a98b02c9949496b7a2c0ddf))
+* **holiday:** extract parseSingleHolidayToken and simplify main loop ([3b593f9](https://github.com/opening-hours/opening_hours.js/commit/3b593f9ab9eb0e9a4ade675af5a6931213dcc79e))
+* **PH:** extract public holiday selector as standalone function ([e5d4aa1](https://github.com/opening-hours/opening_hours.js/commit/e5d4aa1b6f332f004f7f9fd8a6cbf2ae95ce59d6))
+* replace i18next with lightweight custom i18n in core library ([96972fd](https://github.com/opening-hours/opening_hours.js/commit/96972fda2ee702767b8928024531071a37db193a))
+* **SH:** extract helper functions for date/range handling ([217b4e9](https://github.com/opening-hours/opening_hours.js/commit/217b4e9fda4279c861e71a4ba1548c8518684934))
+* **SH:** extract school holiday selector as standalone function ([85692a1](https://github.com/opening-hours/opening_hours.js/commit/85692a1f8c2e891a5934ddd6747fa332f1240a89)), closes [#75](https://github.com/opening-hours/opening_hours.js/issues/75)
+* **SH:** make school holiday parsing independent of data order ([7320458](https://github.com/opening-hours/opening_hours.js/commit/7320458df7426a41c226448fd76d9583bbf8acab))
+
 ## [3.10.0](https://github.com/opening-hours/opening_hours.js/compare/v3.10.0-rc.1...v3.10.0) (2025-12-22)
 
 ## [3.10.0-rc.1](https://github.com/opening-hours/opening_hours.js/compare/v3.10.0-rc.0...v3.10.0-rc.1) (2025-12-21)

package/Makefile

@@ -81,7 +81,7 @@ build/opening_hours.js \
 build/opening_hours.min.js \
 build/opening_hours.esm.mjs \
 build/opening_hours+deps.js \
-build/opening_hours+deps.min.js: src/index.js
+build/opening_hours+deps.min.js: src/index.js src/locales/word_error_correction.yaml
 	node_modules/.bin/rollup -c
 
 .PHONY: check
@@ -213,7 +213,7 @@ benchmark-%.js: build/%.js scripts/benchmark.mjs
 
 .PHONY: check-package.json
 check-package.json: package.json
-	./node_modules/package-json-validator/lib/bin/pjv.js --warnings --recommendations --filename "$<"
+	./node_modules/.bin/package-json-validator-cli --warnings --recommendations --filename "$<"
 
 .PHONY: check-holidays
 check-holidays: scripts/PH_SH_exporter.js
@@ -231,6 +231,7 @@ check-html:
 ## }}}
 
 ## release {{{
+# See CONTRIBUTING.md "Releasing"
 
 .PHONY: release-prepare
 release-prepare: package.json taginfo.json check-holidays doctoc check
@@ -246,10 +247,16 @@ release-local-resign-tag: package.json
 	git tag --delete "v$(shell jq --raw-output '.version' $<)"
 	git tag --sign --local-user="$(RELEASE_OPENPGP_FINGERPRINT)" --message="chore(release): $(shell jq --raw-output '.version' $<)" "v$(shell jq --raw-output '.version' $<)"
 
+# "build" target currently does not guarantee correctness [1].
+# GNU make is not the right tool for this so we just force make as workaround.
+#
+# [1]: https://bazel.build/reference/glossary#correctness
 .PHONY: release-publish
 release-publish:
-	git push --follow-tags
+	$(MAKE) $(MAKE_OPTIONS) --always-make build
+	git push --follow-tags origin
 	npm publish
+	@echo "Manually create release on https://github.com/opening-hours/opening_hours.js/releases"
 	# $(MAKE) $(MAKE_OPTIONS) publish-website-on-all-servers
 
 .PHONY: release
@@ -281,8 +288,11 @@ export.happy_hours.json:
 export.opening_hours.json:
 export.lit.json:
 
+# Downloads taginfo data for the specified key.
+# By default, all values are downloaded. To limit:
+# make osm-tag-data-taginfo-check MAX_VALUES=10000
 export.%.json:
-	wget $(WGET_OPTIONS) --output-document="$(shell echo "$@" | sed 's/\\//g' )" "$(API_URL_TAGINFO)/4/key/values?key=$(shell echo "$@" | sed 's/^export\.\(.*\)\.json/\1/;s/\\//g' )" 2>&1
+	@$(NODEJS) scripts/download_taginfo_data.mjs "$@" "$(shell echo "$@" | sed 's/^export\.\(.*\)\.json/\1/;s/\\//g' )" "$(MAX_VALUES)"
 ## }}}
 
 ## OSM data from the overpass API {{{
@@ -494,6 +504,10 @@ osm-tag-data-gen-stats-sort:
 	done
 ## }}}
 
+src/locales/word_error_correction.yaml: scripts/gen_word_error_correction.mjs
+	@echo "Generating word error correction data..."
+	$(NODEJS) scripts/gen_word_error_correction.mjs >/dev/null
+
 README.html:
 
 %.html: %.md

package/README.md

@@ -318,7 +318,7 @@ function getReadableState(startString, endString, oh, past) {
     7: debug
     ```
 
-    - `locale (type: string, default: i18next.language || 'en')`: Defines the locale for errors and warnings.
+    - `locale (type: string, default: 'en')`: Defines the locale for errors and warnings. Currently, only 'en' (English) and 'de' (German) are supported.
 
     - additional_rule_separator (type boolean, default true)`: Allows to disable the "additional_rule_separator not used after time wrapping midnight" check giving rise to the warning "This rule overwrites parts of the previous rule. This happens because normal rules apply to the whole day and overwrite any definition made by previous rules. You can make this rule an additional rule by using a "," instead of the normal ";" to separate the rules. Note that the overwriting can also be desirable in which case you can ignore this warning."
 
@@ -611,17 +611,13 @@ Almost everything from opening_hours definition is supported, as well as some ex
 
 - Support for school holidays (`SH 10:00-14:00`).
 
-  - Countries with SH definition:
+  School holidays are automatically sourced from the [OpenHolidays API](https://openholidaysapi.org) for 33 countries (from 2020 onwards). Update data by running:
 
-    - Austria (national until 2024, regional until 2021)
-    - Belgium (good until 2026)
-    - Croatia (good until 2022–2023)
-    - France (good until 2025)
-    - Germany, see [hc] and [scripts/update_german_sh.mjs](scripts/update_german_sh.mjs) (good until 2026)
-    - Greece (good until 2020)
-    - Hungary (good until 2024–2025)
-    - Luxembourg (good until 2025–2026)
-    - Romania (good until 2021)
+  ```bash
+  node scripts/fetch-school-holidays.mjs
+  ```
+
+  For details see [src/holidays/README.md](src/holidays/README.md).
 
 - There can be two cases which need to be separated (this applies for PH and SH):
 
@@ -703,10 +699,11 @@ The current results of this test are also tracked in the repository and can be v
 
 #### Large scale
 
-To see how this library performances in the real OpenStreetMap world you can run `make osm-tag-data-check` or `node scripts/real_test.js` (data needs to be exported first) to try to process every value which uses the opening_hours syntax from [taginfo] with this library.
+To see how this library performs in the real OpenStreetMap world you can run `make osm-tag-data-taginfo-check` to test the parser with real data from [taginfo].
+
+By default, the test downloads **all available values** from taginfo. As of December 2025, this library can parse **99.3%** of all opening_hours values in OSM (955,260/978,867 unique values, with duplicates: 4,358,786 total). If identical values appear multiple times, each occurrence counts.
 
-Currently (Mai 2015) this library can parse 97 % (383990/396167) of all opening_hours values in OSM. If identical values appear multiple times then each value counts.
-This test is automated by now. Have a look at the [opening_hours-statistics][].
+For faster testing during development, you can limit the number of values: `make osm-tag-data-taginfo-check MAX_VALUES=10000`
 
 #### Small scale
 
@@ -743,7 +740,7 @@ This library is known to the used by the following projects:
 | [OpenBeerMap](https://openbeermap.github.io)                     | [issue for integration](https://github.com/OpenBeerMap/OpenBeerMap.github.io/issues/25)                                                                                                                                                                             |
 | [opening_hours_map]                                              |
 | [ulm-opening-hours](https://github.com/cmichi/ulm-opening-hours) |
-| [YoHours][]                                                      | A simple editor for OpenStreetMap opening hours, [GitHub](https://github.com/PanierAvide/panieravide.github.io/tree/master/yohours)                                                                                                                                 |
+| [YoHours][]                                                      | A simple editor for OpenStreetMap opening hours, [source code](https://framagit.org/PanierAvide/YoHours)                                                                                                                                 |
 | [opening_hours_server.js]                                        | A little server answering query‘s for opening_hours and check if they can be evaluated.                                                                                                                                                                             |
 | [opening_hours-statistics]                                       | Visualization of the data quality and growth over time in OSM.                                                                                                                                                                                                      |
 | [www.openstreetmap.hu](https://www.openstreetmap.hu/)            | old version of this library, see also <https://github.com/AMDmi3/opening_hours.js/issues/19>                                                                                                                                                                        |
@@ -819,7 +816,7 @@ If you want to contribute to this project, please read the [contribution guideli
 
 * [Dmitry Marakasov](https://github.com/AMDmi3) <amdmi3@amdmi3.ru>: Maintainer from 2012-12 until 2014-05. Initial coding and design and all basic features like time ranges, week ranges, month ranges and week ranges.
 * [Robin Schneider](https://me.ypid.de/) <ypid@riseup.net>: Maintainer from 2013-09 until 2025-05. Added support for years, holidays, unknown, comments, open end, fallback/additional rules (and more), wrote getWarnings, prettifyValue, translated demo page to English and German and extended it to enter values yourself (now called [evaluation tool][ohlib.evaluation-tool]).
-* [Kristjan ESPERANTO](https://github.com/KristjanESPERANTO) [GitHub](https://github.com/KristjanESPERANTO)/[OSM](https://www.openstreetmap.org/user/Kristjan%20ESPERANTO): Maintainer since 2025-05. Switch from CommonJS to ESM. Sharpening the ESLint rules incl. handling the reported issues. HTML/CSS/JS/GitHub CI improvements, keeping the stack up-to-date.
+* [Kristjan ESPERANTO](https://github.com/KristjanESPERANTO) [GitHub](https://github.com/KristjanESPERANTO)/[OSM](https://www.openstreetmap.org/user/Kristjan%20ESPERANTO): Maintainer since 2025-05. Switch from CommonJS to ESM. Sharpening the ESLint rules incl. handling the reported issues. HTML/CSS/JS/GitHub CI improvements, keeping the stack up-to-date. Major [evaluation tool][ohlib.evaluation-tool] Redesign.
 
 ## Contributors
 
@@ -829,7 +826,7 @@ Refer to the [Changelog](https://github.com/opening-hours/opening_hours.js/blob/
 
 - [Netzwolf](https://www.netzwolf.info/) (He developed the first and very feature complete JS implementation for opening_hours (time_domain.js, [mirror](https://openingh.ypid.de/netzwolf_mirror/)). His implementation did not create selector code to go through time as this library does (which is a more advanced design). time_domain.js has been withdrawn in favor of opening_hours.js but a few parts where reused (mainly the error tolerance and the online evaluation for the [evaluation tool][ohlib.evaluation-tool]). It was also very useful as prove and motivation that all those complex things used in the [opening_hours syntax][oh:specification] are possible to evaluate with software :) )
 - Also thanks to FOSSGIS for hosting a public instance of this service. See the [wiki][fossgis-project].
-- The [favicon.png](/img/favicon.png) is based on the file ic_action_add_alarm.png from the [Android Design Icons](https://developer.android.com/downloads/design/Android_Design_Icons_20131106.zip) which is licensed under [Creative Commons Attribution 2.5](https://creativecommons.org/licenses/by/2.5/). It represents a clock next to the most common opening_hours value (by far) which is `24/7` and a check mark.
+- The [favicon.svg](/img/favicon.svg) is based on the file ic_action_add_alarm.png from the [Android Design Icons](https://developer.android.com/downloads/design/Android_Design_Icons_20131106.zip) which is licensed under [Creative Commons Attribution 2.5](https://creativecommons.org/licenses/by/2.5/). It represents a clock next to the most common opening_hours value (by far) which is `24/7` and a check mark.
 
 ## Stats
 
@@ -875,7 +872,6 @@ Edit: This does also work on npmjs in this short version … -->
 [ohlib.library-api]: #library-api
 [ohlib.npmjs]: https://www.npmjs.org/package/opening_hours
 [ohlib.github]: https://github.com/opening-hours/opening_hours.js
-[hc]: https://gitlab.com/ypid/hc
 [evaluation tool]: https://openingh.openstreetmap.de/evaluation_tool/
 [ph-ar]: https://en.wikipedia.org/wiki/Public_holidays_in_Argentina
 [ph-at]: https://de.wikipedia.org/wiki/Feiertage_in_%C3%96sterreich