Merge branch 'develop' into master

Author: KristjanESPERANTO

.yamllint.yml .yamllint.yaml.yamllint.yml renamed to .yamllint.yaml

@@ -105,9 +105,13 @@ Thank you for contributing!
 [i18next]: https://www.i18next.com
 [Vim folds]: https://vimhelp.org/fold.txt.html#folding
 
-[ohlib.opening_hours.js]: /index.js
+[opening_hours_map]: https://github.com/opening-hours/opening_hours_map
+[ohlib.docs.holiday]: /holidays/README.md
+[ohlib.holidays]: README.md#holidays
 [ohlib.js/locales/opening_hours_resources.yaml]: src/locales/opening_hours_resources.yaml
 [ohlib.js/i18n-resources.js]: site/js/i18n-resources.js
-[site/index.html]: site/index.html
+[ohlib.makefile]: /Makefile
+[ohlib.opening_hours.js]: /index.js
 [ohlib.test.js]: test/test.js
 [ohlib.testing]: README.md#testing
+[site/index.html]: site/index.html

CONTRIBUTING.md

@@ -105,13 +105,7 @@ An around-the-clock shop with some breaks.
 - [Related links](#related-links)
 - [ToDo](#todo)
 - [How to contribute](#how-to-contribute)
-  - [Translating the evaluation tool and the map](#translating-the-evaluation-tool-and-the-map)
-  - [Translating error messages and warnings](#translating-error-messages-and-warnings)
-  - [Holiday Data](#holiday-data)
-  - [Core code](#core-code)
-    - [Commit hooks](#commit-hooks)
-    - [Documentation](#documentation)
-- [Authors](#authors)
+- [Maintainers](#maintainers)
 - [Contributors](#contributors)
 - [Credits](#credits)
 - [Stats](#stats)
@@ -188,15 +182,15 @@ Check [releases on GitHub] for a list of the releases and their Changelog.
 
 ```js
 const opening_hours = require("opening_hours");
-var oh = new opening_hours("We 12:00-14:00");
+let oh = new opening_hours("We 12:00-14:00");
 
-var from = new Date("01 Jan 2012");
-var to = new Date("01 Feb 2012");
+let from = new Date("01 Jan 2012");
+let to = new Date("01 Feb 2012");
 
 // high-level API
 {
-  var intervals = oh.getOpenIntervals(from, to);
-  for (var i in intervals)
+  let intervals = oh.getOpenIntervals(from, to);
+  for (let i in intervals)
     console.log(
       "We are " +
         (intervals[i][2] ? "maybe " : "") +
@@ -208,7 +202,7 @@ var to = new Date("01 Feb 2012");
         "."
     );
 
-  var duration_hours = oh.getOpenDuration(from, to).map(function (x) {
+  let duration_hours = oh.getOpenDuration(from, to).map(function (x) {
     return x / 1000 / 60 / 60;
   });
   if (duration_hours[0])
@@ -228,7 +222,7 @@ function getReadableState(startString, endString, oh, past) {
   if (past === true) past = "d";
   else past = "";
 
-  var output = "";
+  let output = "";
   if (oh.getUnknown()) {
     output +=
       " maybe open" +
@@ -246,10 +240,10 @@ function getReadableState(startString, endString, oh, past) {
 
 // simple API
 {
-  var state = oh.getState(); // we use current date
-  var unknown = oh.getUnknown();
-  var comment = oh.getComment();
-  var nextchange = oh.getNextChange();
+  let state = oh.getState(); // we use current date
+  let unknown = oh.getUnknown();
+  let comment = oh.getComment();
+  let nextchange = oh.getNextChange();
 
   console.log(getReadableState("We're", "", oh, true));
 
@@ -267,7 +261,7 @@ function getReadableState(startString, endString, oh, past) {
 
 // iterator API
 {
-  var iterator = oh.getIterator(from);
+  let iterator = oh.getIterator(from);
 
   console.log(getReadableState("Initially, we're", "", iterator, true));
 
@@ -283,7 +277,7 @@ function getReadableState(startString, endString, oh, past) {
 
 ## Library API
 
-- `var oh = new opening_hours('We 12:00-14:00', nominatim_object, mode);`
+- `let oh = new opening_hours('We 12:00-14:00', nominatim_object, mode);`
 
   - `value (mandatory, type: string)`: Constructs opening_hours object, given the opening_hours tag value. Throws an error string if the expression is malformed or unsupported.
 
@@ -328,13 +322,13 @@ function getReadableState(startString, endString, oh, past) {
 
     - 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."
 
-- `var warnings = oh.getWarnings();`
+- `let warnings = oh.getWarnings();`
 
   Get warnings which appeared during parsing as human readable string array with one element per violation. Almost all warnings can be auto-corrected and are probably interpreted as intended by the mapper. However, this is not a granite of course.
 
   This function performs some additional testing and can thus also theoretically throw an error like all other functions which parse the time.
 
-- `var prettified = oh.prettifyValue(argument_hash);`
+- `let prettified = oh.prettifyValue(argument_hash);`
 
   Return a prettified version of the opening_hours value. The value is generated by putting the tokens back together to a string.
 
@@ -355,11 +349,11 @@ function getReadableState(startString, endString, oh, past) {
 
   If the key 'get_internals' is true then an object containing internal stuff will be returned instead. The format of this internal object may change in minor release.
 
-- `var every_week_is_same = oh.isWeekStable();`
+- `let every_week_is_same = oh.isWeekStable();`
 
   Checks whether open intervals are same for every week. Useful for giving a user hint whether time table may change for another week.
 
-- `var is_equal_to = oh.isEqualTo(new opening_hours('We 12:00-16:00'), start_date);`
+- `let is_equal_to = oh.isEqualTo(new opening_hours('We 12:00-16:00'), start_date);`
 
   Check if this opening_hours object has the same meaning as the given
   opening_hours object (evaluates to the same state for every given time).
@@ -391,51 +385,51 @@ function getReadableState(startString, endString, oh, past) {
 
 This API is useful for one-shot checks, but for iteration over intervals you should use the more efficient [iterator API][ohlib.iterator-api].
 
-- `var is_open = oh.getState(date);`
+- `let is_open = oh.getState(date);`
 
   Checks whether the facility is open at the given *date*. You may omit *date* to use current date.
 
-- `var unknown = oh.getUnknown(date);`
+- `let unknown = oh.getUnknown(date);`
 
   Checks whether the opening state is conditional or unknown at the given *date*. You may omit *date* to use current date.
   Conditions can be expressed in comments.
   If unknown is true then is_open will be false since it is not sure if it is open.
 
-- `var state_string = oh.getStateString(date, past);`
+- `let state_string = oh.getStateString(date, past);`
 
   Return state string at given *date*. Either 'open', 'unknown' or 'closed?'. You may omit *date* to use current date.
 
   If the boolean parameter `past` is true you will get 'closed' else you will get 'close'.
 
-- `var comment = oh.getComment(date);`
+- `let comment = oh.getComment(date);`
 
   Returns the comment (if one is specified) for the facility at the given *date*. You may omit *date* to use current date.
   Comments can be specified for any state.
 
   If no comment is specified this function will return undefined.
 
-- `var next_change = oh.getNextChange(date, limit);`
+- `let next_change = oh.getNextChange(date, limit);`
 
   Returns date of next state change. You may omit *date* to use current date.
 
   Returns undefined if the next change cannot be found. This may happen if the state won't ever change (e.g. `24/7`) or if search goes beyond *limit* (which is *date* + ~5 years if omitted).
 
-- `var rule_index = oh.getMatchingRule(date);`
+- `let rule_index = oh.getMatchingRule(date);`
 
   Returns the internal rule number of the matching rule. You may omit *date* to use current date.
   A opening_hours string can consist of multiple rules from which one of them is used to evaluate the state for a given point in time. If no rule applies, the state will be closed and this function returns undefined.
 
   To prettify this rule, you can specify `rule_index` as parameter for `oh.prettifyValue` like this:
 
   ```js
-  var matching_rule = oh.prettifyValue({ rule_index: rule_index });
+  let matching_rule = oh.prettifyValue({ rule_index: rule_index });
   ```
 
 ### High-level API
 
 Here and below, unless noted otherwise, all arguments are expected to be and all output will be in the form of Date objects.
 
-- `var intervals = oh.getOpenIntervals(from, to);`
+- `let intervals = oh.getOpenIntervals(from, to);`
 
   Returns array of open intervals in a given range, in a form of
 
@@ -445,49 +439,49 @@ Here and below, unless noted otherwise, all arguments are expected to be and all
 
   Intervals are cropped with the input range.
 
-- `var duration = oh.getOpenDuration(from, to);`
+- `let duration = oh.getOpenDuration(from, to);`
 
   Returns an array with two durations for a given date range, in milliseconds. The first element is the duration for which the facility is open and the second is the duration for which the facility is maybe open (unknown is used).
 
 ### Iterator API
 
-- `var iterator = oh.getIterator(date);`
+- `let iterator = oh.getIterator(date);`
 
   Constructs an iterator which can go through open/close points, starting at *date*. You may omit *date* to use current date.
 
-- `var current_date = iterator.getDate();`
+- `let current_date = iterator.getDate();`
 
   Returns current iterator position.
 
 - `iterator.setDate(date);`
 
   Set iterator position to date.
 
-- `var is_open = iterator.getState();`
+- `let is_open = iterator.getState();`
 
   Returns whether the facility is open at the current iterator position.
 
-- `var unknown = iterator.getUnknown();`
+- `let unknown = iterator.getUnknown();`
 
   Checks whether the opening state is conditional or unknown at the current iterator position.
 
-- `var state_string = iterator.getStateString(past);`
+- `let state_string = iterator.getStateString(past);`
 
   Return state string. Either 'open', 'unknown' or 'closed?'.
 
   If the boolean parameter `past` is true you will get 'closed' else you will get 'close'.
 
-- `var comment = iterator.getComment();`
+- `let comment = iterator.getComment();`
 
   Returns the comment (if one is specified) for the facility at the current iterator position in time.
 
   If no comment is specified this function will return undefined.
 
-- `var matching_rule = iterator.getMatchingRule();`
+- `let matching_rule = iterator.getMatchingRule();`
 
   Returns the index of the matching rule starting with zero.
 
-- `var had_advanced = iterator.advance(limit);`
+- `let had_advanced = iterator.advance(limit);`
 
   Advances an iterator to the next position, but not further than *limit* (which is current position + ~5 years if omitted and is used to prevent infinite loop on non-periodic opening_hours, e.g. `24/7`), returns whether the iterator was moved.
 
@@ -586,7 +580,7 @@ Almost everything from opening_hours definition is supported, as well as some ex
     - [Croatia][ph-hr]
     - [Czech Republic][ph-cz]
     - [Denmark][ph-dk]
-    - [England and Wales][ph-gb]
+    - [England, Wales, Scotland and Northern Ireland][ph-gb]
     - [France][ph-fr]
     - Finland
     - [Germany][ph-de] ([footnotes][ph-de] are ignored)
@@ -849,7 +843,7 @@ Note that the original work from Dmitry Marakasov is published under the BSD 2-c
 
 <https://reuse.software> is used. The year of initial publication is used and not updated. When you as new author make copyrightable changes, you are free of course to add a `SPDX-FileCopyrightText` line to the file(s) you changed with the year of the contribution. Please use a format like this:
 
-```
+```text
 SPDX-FileCopyrightText: © 2021 Humble Hacker <hh@example.org>
 ```
 
@@ -878,12 +872,9 @@ Edit: This does also work on npmjs in this short version … -->
 [ohlib.iterator-api]: #iterator-api
 [ohlib.time-ranges]: #time-ranges
 [ohlib.states]: #states
-[ohlib.holidays]: #holidays
 [ohlib.contribute.holidays]: /src/holidays/
 [ohlib.evaluation-tool]: #evaluation-tool
 [ohlib.library-api]: #library-api
-[ohlib.docs.holiday]: /holidays/README.md
-[ohlib.makefile]: /Makefile
 [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

README.md

@@ -168,6 +168,6 @@ The most inner array represents one token:
 ]
 ```
 
-# ToDo
+## ToDo
 
 * Make implementation of weekday and holiday interaction clearer.

docs/README.md

@@ -1,44 +1,37 @@
-import eslint from '@eslint/js'
-import globals from "globals";
+import { defineConfig, globalIgnores } from 'eslint/config'
+import globals from 'globals'
+import js from '@eslint/js'
+import markdown from '@eslint/markdown'
+import stylistic from '@stylistic/eslint-plugin'
 import tseslint from 'typescript-eslint'
 
-export default tseslint.config(
-  eslint.configs.recommended,
+export default defineConfig([
+  globalIgnores(['build/*', 'submodules/*', '**/yohours_model.js']),
   {
-    files: ['**/*.ts'],
-    extends: [
-      eslint.configs.recommended,
-      tseslint.configs.recommended,
-    ],
-    rules: {
-      '@typescript-eslint/array-type': 'error',
-      '@typescript-eslint/consistent-type-imports': 'error',
-    },
-  },
-  {
-    "files": ["**/*.js", "**/*.mjs"],
-    "languageOptions": {
-      "ecmaVersion": "latest",
-      "globals": {
+    files: ['**/*.js', '**/*.mjs'],
+    extends: [js.configs.recommended],
+    plugins: { '@stylistic': stylistic },
+    languageOptions: {
+      ecmaVersion: 'latest',
+      globals: {
         ...globals.browser,
-        ...globals.node
+        ...globals.node,
       },
-      "sourceType": "module"
+      sourceType: 'module',
     },
     rules: {
-      'no-cond-assign': 'warn',
-      'no-constant-binary-expression': 'warn',
-      'no-empty': 'warn',
-      'no-empty-function': 'warn',
-      'no-func-assign': 'warn',
-      'no-prototype-builtins': 'warn',
-      'no-redeclare': 'warn',
-      'no-undef': 'warn',
-      'no-unused-vars': 'warn',
-      'no-useless-escape': 'warn',
-    }
+      '@stylistic/quotes': [ 'error', 'single' ],
+      'prefer-const': 'error',
+      'no-var': 'error'
+    },
   },
+  { files: ['**/*.md'], plugins: { markdown }, language: 'markdown/gfm', extends: ['markdown/recommended'] },
   {
-    ignores: ['build/*', 'submodules/*', '**/yohours_model.js']
-  }
-)
+    files: ['**/*.ts'],
+    extends: [tseslint.configs.recommended],
+    rules: {
+      '@typescript-eslint/array-type': 'error',
+      '@typescript-eslint/consistent-type-imports': 'error',
+    },
+  },
+])