diff --git a/.codespellignore b/.codespellignore new file mode 100644 index 00000000..7138dfac --- /dev/null +++ b/.codespellignore @@ -0,0 +1,6 @@ +# game abbreviations +som +# variable names +ot +# actual words +dependant diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..dbd52b3a --- /dev/null +++ b/.codespellrc @@ -0,0 +1,3 @@ +[codespell] +skip = ./.git,./packs,./nbproject,./lib,./build,./win32-lib,./win32-lib-src,./scan-build-reports,node_modules,./examples/template_pack/scripts/custom_items/class.lua,*.pem +ignore-words = ./.codespellignore diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 00000000..1421bfda --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,17 @@ +name: Codespell + +on: + push: + pull_request: + +jobs: + codespell: + runs-on: ubuntu-latest + name: Find typos + + steps: + - uses: actions/checkout@v4 + - uses: codespell-project/actions-codespell@v2 + with: + check_filenames: true + check_hidden: true diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 69da7407..d051660c 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -58,7 +58,7 @@ jobs: if: ${{ startsWith(matrix.os, 'macos') }} run: | brew install coreutils SDL2 sdl2_ttf sdl2_image openssl@1.1 googletest || true - - name: Install extra dependencies (brewo) + - name: Install extra dependencies (brew) if: ${{ startsWith(matrix.os, 'macos') && contains(matrix.extra_make_args, 'MACOS_DEPLOYMENT_TARGET') }} run: | brew install boost || true diff --git a/BUILD.md b/BUILD.md index d56e7139..9ce11519 100644 --- a/BUILD.md +++ b/BUILD.md @@ -103,7 +103,7 @@ Dependencies to build the bundle: install git and `brew install automake libtool The release builds for Windows and macOS are very custom since we do not want to force msys or brew on anyone and use a gnu toolchain for development. -* Meson's submodules system would be great, but some of them are very outdated or incomplete and maintinaing the recipes +* Meson's submodules system would be great, but some of them are very outdated or incomplete and maintaining the recipes for all dependencies is too much work. * CMake did fail when trying to create the static windows build, at which point we'd need to modify and maintain CMake files for subprojects. diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b97b66b..ec725032 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -54,7 +54,7 @@ * Lua: Added LocationSection.FullID to get the full location/section string * Added flag "apmanual" to enable sending in Archipelago * Fixes - * Fix map tooltip placement being wrong under certain cirumstances + * Fix map tooltip placement being wrong under certain circumstances * Fix sections with sequence break + inspect not showing up correctly * Fix a race condition in snes autotracking * Ignore "allow_disabled" for items where behavior wasn't documented: toggle, static, toggle_badged diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 979a38bb..3143e900 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,8 +25,8 @@ Send PRs on GitHub. - public member variables should start with a lower case letter - this is to match SDL's structs - public member variables should only be used for simple structs - use getters/setters otherwise - getters start with `get`, setters with `set` -- class names start with a captial letter -- one exception to the above is the Lua Inferface, which uses `T::Lua_CamelCase` +- class names start with a capital letter +- one exception to the above is the Lua Interface, which uses `T::Lua_CamelCase` - loops/iterations use `auto :` or `auto& :` where possible - use `std::string` or `std::string_view` (we target c++17) - there are a ton of violations, but new code should still try to check all the boxes @@ -71,6 +71,11 @@ See [scan-build.yaml](../.github/workflows/scan-build.yaml). Consider testing with ASAN. +### Spell checker + +We use codespell to find typos. You can `pip install codespell` or reply on the GitHub workflow. +See `.codespellrc` if you want to exclude files/folders and `.codespellignore` if you want to exclude a word. + ## Documentation Style Markdown per [Google Markdown style guide](https://google.github.io/styleguide/docguide/style.html) diff --git a/CREDITS.md b/CREDITS.md index 0e857430..84668a38 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,6 +1,6 @@ # Credits -## Code Contibutors +## Code Contributors * [black-sliver](https://github.com/black-sliver) * [sbzappa](https://github.com/sbzappa) @@ -8,9 +8,9 @@ ## Other Contributors -* [Cyb3R](https://github.com/Cyb3RGER) - the new icon + figuring out, testing and brainstorming all teh stuff, also schema. +* [Cyb3R](https://github.com/Cyb3RGER) - the new icon + figuring out, testing and brainstorming all the stuff, also schema. * [jsd1982](https://github.com/JamesDunne) & [total](https://github.com/tewtal) - providing snes/sni/usb2snes infos -* [MisterIbis]( https://github.com/MisterIbis) - doing some documenation +* [MisterIbis]( https://github.com/MisterIbis) - doing some documentation ## Libraries diff --git a/api/lua/definition/poptracker.lua b/api/lua/definition/poptracker.lua index af2f7932..5407ff3e 100644 --- a/api/lua/definition/poptracker.lua +++ b/api/lua/definition/poptracker.lua @@ -162,7 +162,7 @@ function ScriptHost:RemoveWatchForCode(name) end ---callback(store, {variableName, ...}) will be called whenever a remote variable changes. ---See [AUTOTRACKING.md](https://github.com/black-sliver/PopTracker/blob/master/doc/AUTOTRACKING.md#variable-interface-uat) --- and [UAT REDME.md](https://github.com/black-sliver/UAT/blob/master/README.md) for more info. +-- and [UAT README.md](https://github.com/black-sliver/UAT/blob/master/README.md) for more info. ---@param name string identifier/name of this watch ---@param variables string[] array of variable names ---@param callback fun(store:VariableStore, changedKeysArray:table):nil called when any watched variable changes @@ -449,7 +449,7 @@ ImageRef = {} ImageReference = {} ---Create an image reference from filename. ----Note: currently path resultion happens when the ImageRef is being used, so there is no way to detect errors. +---Note: currently path resolution happens when the ImageRef is being used, so there is no way to detect errors. ---@param filename string ---@return ImageRef reference to the image for filename function ImageReference:FromPackRelativePath(filename) end diff --git a/doc/PACKS.md b/doc/PACKS.md index aec92e70..a551ebc6 100644 --- a/doc/PACKS.md +++ b/doc/PACKS.md @@ -123,9 +123,9 @@ The following interfaces are provided: * `require` behaves mostly like Lua require since 0.25.6 * `"foo.baz"` will try `/scripts/foo/baz.lua`, `/scripts/foo/baz/init.lua`, `/foo/baz.lua` and `/foo/baz/init.lua` * `...` contains mod name for relative require since 0.25.6 -* `ref :AddMemoryWatch(name,addr,len,callback,interal)`: add a memory watch for auto-tracking, see [AUTOTRACKING.md](AUTOTRACKING.md) +* `ref :AddMemoryWatch(name,addr,len,callback,interval)`: add a memory watch for auto-tracking, see [AUTOTRACKING.md](AUTOTRACKING.md) * `bool :RemoveMemoryWatch(name)`: remove memory watch by name, available since 0.11.0 -* `ref :AddVariableWatch(name,{variables, ...},callback,interal)`: add a variable watch for auto-tracking, see [AUTOTRACKING.md](AUTOTRACKING.md) +* `ref :AddVariableWatch(name,{variables, ...},callback,interval)`: add a variable watch for auto-tracking, see [AUTOTRACKING.md](AUTOTRACKING.md) * `bool :RemoveVariableWatch(name)`: remove variable watch by name, available since 0.16.0 * `ref :AddWatchForCode(name,code,callback)`: callback(code) will be called whenever an item changed state that canProvide(code). Only available in PopTracker, since 0.11.0, will return a reference (name) to the watch since 0.18.2. Use "*" to trigger for all codes since 0.25.5. * `bool :RemoveWatchForCode(name)`: remove watch by name diff --git a/doc/PackCreation.md b/doc/PackCreation.md index 5c8faf45..485f41f9 100644 --- a/doc/PackCreation.md +++ b/doc/PackCreation.md @@ -105,7 +105,7 @@ As the documentation mentioned, the init.lua script grabs the .json files, and f If you don’t know where to start, items and maps don’t require anything else done first. Any items that have logical implications need to have an item created for them. Anything that you might have to check your inventory for would also be a good candidate. Anything that you never need later should generally not be an item. Bosses that you have to kill can also be an Item – this way they can have a nice icon instead of just being a random chest. -You can start with placeholder images for items. For Maps, best practices are to use a quick placeholder to make sure they’re loading, and you’ll want to have them finalized by the time you’re doing a second pass on the locations file. There's not a requirement to have placeholder images, but iterating on a quick test is generally a good way to prevent major unforseen issues. +You can start with placeholder images for items. For Maps, best practices are to use a quick placeholder to make sure they’re loading, and you’ll want to have them finalized by the time you’re doing a second pass on the locations file. There's not a requirement to have placeholder images, but iterating on a quick test is generally a good way to prevent major unforeseen issues. Reminder again, **valid image types are PNG, GIF, and JPEG.** Generally speaking, you should prefer to create static images as PNG over JPEG since they can include transparency and are lossless. If you’ve already got something in another valid format then it’s probably fine as-is. Item image sizes should generally be 32 x 32, though up to 64 x 64 is still fine if you have text that needs to be readable. - For Future You’s sanity, please pick image names that are concise, descriptive and separate words with an underscore if you need multiple words to be descriptive (eg map_name). This isn't a hard rule, but it'll make life easier for anyone who needs to read the pack later on. diff --git a/examples/template_pack b/examples/template_pack index f686b143..fda870af 160000 --- a/examples/template_pack +++ b/examples/template_pack @@ -1 +1 @@ -Subproject commit f686b14396c2da2558b204eb88c0dda071cb1e49 +Subproject commit fda870af51e94005875d98df6a2dd558e1d55014 diff --git a/examples/uat-example/README.md b/examples/uat-example/README.md index ec3388cc..dd0d8c67 100644 --- a/examples/uat-example/README.md +++ b/examples/uat-example/README.md @@ -7,5 +7,5 @@ PopTracker to auto-track. * Variables are received in [scripts/autotracking.lua](scripts/autotracking.lua) * Sample server is in [util/uat-example-server.py](util/uat-example-server.py) -Load the pack and run the example server for a demonstation. The example server +Load the pack and run the example server for a demonstration. The example server requires python3 and websockets module (`pip install -r util/requirements.txt`). diff --git a/schema/packs/items.json b/schema/packs/items.json index 938ff637..f706f1ef 100644 --- a/schema/packs/items.json +++ b/schema/packs/items.json @@ -79,7 +79,7 @@ "type": "string" }, "img_mods": { - "description": "Modifiers to apply to the image. Multiple values are comma seperated.", + "description": "Modifiers to apply to the image. Multiple values are comma separated.", "examples": [ "@disabled", "overlay|path/to/img.png" @@ -91,7 +91,7 @@ "type": "string" }, "disabled_img_mods": { - "description": "Modifiers to apply to the image when disabled. Multiple values are comma seperated.", + "description": "Modifiers to apply to the image when disabled. Multiple values are comma separated.", "examples": [ "@disabled", "overlay|path/to/img.png" @@ -99,7 +99,7 @@ "type": "string" }, "codes": { - "description": "Code identifier(s) of this item. Multiple values are comma seperated.", + "description": "Code identifier(s) of this item. Multiple values are comma separated.", "examples": [ "code1", "code1,code2", @@ -123,7 +123,7 @@ "$ref": "#/$defs/codes" }, "secondary_codes": { - "description": "Secondary code identifier(s) of this item. Multiple values are comma seperated. Unused at the moment.", + "description": "Secondary code identifier(s) of this item. Multiple values are comma separated. Unused at the moment.", "examples": [ "code1", "code1,code2", @@ -161,7 +161,7 @@ } }, "initial_stage_idx": { - "description": "Initital stage index for the progressive item. Zero indexed.", + "description": "Initial stage index for the progressive item. Zero indexed.", "anyOf": [ { "type": "number", @@ -235,7 +235,7 @@ "$ref": "#/$defs/stages" }, "allow_disabled": { - "description": "Automatically addes a \"off\" stage if set to true.", + "description": "Automatically adds an \"off\" stage if set to true.", "anyOf": [ { "type": "boolean", diff --git a/schema/packs/layouts.json b/schema/packs/layouts.json index f78ad637..59779319 100644 --- a/schema/packs/layouts.json +++ b/schema/packs/layouts.json @@ -152,7 +152,7 @@ ] }, "canvas_top": { - "description": "Distance to top egde of canvas of the item.", + "description": "Distance to top edge of canvas of the item.", "anyOf": [ { "type": "number" @@ -164,7 +164,7 @@ ] }, "canvas_left": { - "description": "Distance to left egde of canvas of the item.", + "description": "Distance to left edge of canvas of the item.", "anyOf": [ { "type": "number" diff --git a/schema/packs/locations.json b/schema/packs/locations.json index d9f49707..dd068d35 100644 --- a/schema/packs/locations.json +++ b/schema/packs/locations.json @@ -9,7 +9,7 @@ "$defs": { "rules_string": { "items": { - "description": "Rules. Comma sperated for AND.", + "description": "Rules. Comma separated for AND.", "type": "string" } }, @@ -48,11 +48,11 @@ "type": "array", "anyOf": [ { - "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] @@ -73,11 +73,11 @@ "type": "array", "anyOf": [ { - "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] @@ -173,11 +173,11 @@ "type": "array", "anyOf": [ { - "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] @@ -198,11 +198,11 @@ "type": "array", "anyOf": [ { - "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] diff --git a/schema/packs/strict/items.json b/schema/packs/strict/items.json index 477ca02a..728681de 100644 --- a/schema/packs/strict/items.json +++ b/schema/packs/strict/items.json @@ -68,7 +68,7 @@ "type": "string" }, "img_mods": { - "description": "Modifiers to apply to the image. Multiple values are comma seperated.", + "description": "Modifiers to apply to the image. Multiple values are comma separated.", "examples": [ "@disabled", "overlay|path/to/img.png" @@ -80,7 +80,7 @@ "type": "string" }, "disabled_img_mods": { - "description": "Modifiers to apply to the image when disabled. Multiple values are comma seperated.", + "description": "Modifiers to apply to the image when disabled. Multiple values are comma separated.", "examples": [ "@disabled", "overlay|path/to/img.png" @@ -88,7 +88,7 @@ "type": "string" }, "codes": { - "description": "Code identifier(s) of this item. Multiple values are comma seperated.", + "description": "Code identifier(s) of this item. Multiple values are comma separated.", "examples": [ "code1", "code1,code2", @@ -112,7 +112,7 @@ "$ref": "#/$defs/codes" }, "secondary_codes": { - "description": "Secondary code identifier(s) of this item. Multiple values are comma seperated. Unused at the moment.", + "description": "Secondary code identifier(s) of this item. Multiple values are comma separated. Unused at the moment.", "examples": [ "code1", "code1,code2", @@ -201,7 +201,7 @@ "$ref": "#/$defs/stages" }, "allow_disabled": { - "description": "Automatically addes a \"off\" stage if set to true.", + "description": "Automatically adds an \"off\" stage if set to true.", "type": "boolean" }, "initial_stage_idx": { diff --git a/schema/packs/strict/layouts.json b/schema/packs/strict/layouts.json index 8dc874d2..e4106818 100644 --- a/schema/packs/strict/layouts.json +++ b/schema/packs/strict/layouts.json @@ -154,11 +154,11 @@ "type": "number" }, "canvas_top": { - "description": "Distance to top egde of canvas of the item.", + "description": "Distance to top edge of canvas of the item.", "type": "number" }, "canvas_left": { - "description": "Distance to left egde of canvas of the item.", + "description": "Distance to left edge of canvas of the item.", "type": "number" }, "width": { diff --git a/schema/packs/strict/locations.json b/schema/packs/strict/locations.json index 978d313b..4d71e26b 100644 --- a/schema/packs/strict/locations.json +++ b/schema/packs/strict/locations.json @@ -9,7 +9,7 @@ "$defs": { "rules_string": { "items": { - "description": "Rules. Comma sperated for AND.", + "description": "Rules. Comma separated for AND.", "type": "string" } }, @@ -47,11 +47,11 @@ "type": "array", "anyOf": [ { - "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Access rules for the section. Section will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the section will be marked as checkable (blue). Children will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] @@ -72,11 +72,11 @@ "type": "array", "anyOf": [ { - "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Visibility rules for the section. Section will only be visible if rules are matched. Children will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] @@ -155,11 +155,11 @@ "type": "array", "anyOf": [ { - "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Access rules for the location. Location will be marked reachable (green) if all rules are matched. Rules inside [] are optional (i.e. glitches work around this rule; marked as yellow). If rules in {} are matched, the location will be marked as checkable (blue). Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] @@ -180,11 +180,11 @@ "type": "array", "anyOf": [ { - "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma sperated rules will be AND-ed.", + "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. Each entry will be OR-ed together, comma separated rules will be AND-ed.", "$ref": "#/$defs/rules_string" }, { - "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimenstion will be OR-ed together, second will be AND-ed.", + "description": "Visibility rules for the location. Location will only be visible if rules are matched. Children/sections will always inherit rules from parents. 2-Dimensional array of rules, first dimension will be OR-ed together, second will be AND-ed.", "$ref": "#/$defs/rules_array" } ] diff --git a/src/core/tracker.cpp b/src/core/tracker.cpp index 8b848e42..1be51a94 100644 --- a/src/core/tracker.cpp +++ b/src/core/tracker.cpp @@ -534,7 +534,7 @@ void Tracker::UiHint(const std::string& name, const std::string& value) template static void eraseDuplicates(std::list& list) { - // This keeps the last occurence. + // This keeps the last occurrence. // FIXME: Complexity is awful. auto it = list.begin(); while (it != list.end()) { diff --git a/src/core/util.h b/src/core/util.h index 91945d68..c627e045 100644 --- a/src/core/util.h +++ b/src/core/util.h @@ -40,7 +40,7 @@ static std::string sanitize_filename(std::string s) { return s; } -/// Replaces non-ASCII and reserved/non-portable symbols by '_'. Returns "_" for empty and resrved folder names. +/// Replaces non-ASCII and reserved/non-portable symbols by '_'. Returns "_" for empty and reserved folder names. static std::string sanitize_dir(std::string s) { if (s.empty()) diff --git a/src/http/README.md b/src/http/README.md index 80534c3f..574669f0 100644 --- a/src/http/README.md +++ b/src/http/README.md @@ -2,8 +2,8 @@ Simple HTTP/S Client around asio / boos::asio. -To enable platform independend certificate checking, set HTTP::certfile to a -file containing the ca certs in PEM fromat.\ +To enable platform-independent certificate checking, set HTTP::certfile to a +file containing the ca certs in PEM format.\ See https://curl.se/docs/caextract.html for an example certfile. Falls back to windows cert store on windows and default openssl paths on other diff --git a/src/luasandbox/luapackio.cpp b/src/luasandbox/luapackio.cpp index 6dd4b18f..0b62ca1d 100644 --- a/src/luasandbox/luapackio.cpp +++ b/src/luasandbox/luapackio.cpp @@ -114,7 +114,7 @@ int LuaPackIO::open(lua_State* L) int LuaPackIO::input(lua_State* L) { if (_input && (lua_gettop(L) == 0 || lua_isnil(L, -1))) { - // NOTE: LuaInterface::Lua_Push can't be used with __gc without addiional ref count + // NOTE: LuaInterface::Lua_Push can't be used with __gc without additional ref count lua_rawgeti(L, LUA_REGISTRYINDEX, _inputRef.ref); luaL_unref(L, LUA_REGISTRYINDEX, _inputRef.ref); _input = nullptr; diff --git a/src/ui/defaulttrackerwindow.h b/src/ui/defaulttrackerwindow.h index 42288bbe..49a924cb 100644 --- a/src/ui/defaulttrackerwindow.h +++ b/src/ui/defaulttrackerwindow.h @@ -57,7 +57,7 @@ class DefaultTrackerWindow : public TrackerWindow { void hideMessage(); }; -} // namspace Ui +} // namespace Ui #endif /* _UI_DEFAULTTRACKERWINDOW_H */ diff --git a/src/ui/maptooltip.cpp b/src/ui/maptooltip.cpp index 4d41fcea..6a93fd4c 100644 --- a/src/ui/maptooltip.cpp +++ b/src/ui/maptooltip.cpp @@ -74,7 +74,7 @@ MapTooltip::MapTooltip(int x, int y, FONT font, FONT smallFont, int quality, Tra c.b = mix(c.b, 0xff, 64); lbl->setTextColor(c); lbl->setTextAlignment(Label::HAlign::RIGHT, Label::VAlign::MIDDLE); - lbl->setSize(lbl->getSize()||lbl->getMinSize()); // FIXME: this should not be neccessary + lbl->setSize(lbl->getSize()||lbl->getMinSize()); // FIXME: this should not be necessary lbl->setMinSize(lbl->getSize()||lbl->getMinSize()); hbox->addChild(lbl); addChild(hbox); @@ -117,7 +117,7 @@ MapTooltip::MapTooltip(int x, int y, FONT font, FONT smallFont, int quality, Tra Widget::Color c = getSectionColor(reachable, cleared); lbl->setTextColor(c); lbl->setTextAlignment(Label::HAlign::LEFT, Label::VAlign::MIDDLE); - lbl->setSize(lbl->getSize()||lbl->getMinSize()); // FIXME: this should not be neccessary + lbl->setSize(lbl->getSize()||lbl->getMinSize()); // FIXME: this should not be necessary lbl->setMinSize(lbl->getSize()||lbl->getMinSize()); container->addChild(lbl); } else { diff --git a/src/uilib/ui.cpp b/src/uilib/ui.cpp index e36c42c5..1847efcb 100644 --- a/src/uilib/ui.cpp +++ b/src/uilib/ui.cpp @@ -333,7 +333,7 @@ bool Ui::render() } } } - #if 0 // this is not neccessary + #if 0 // this is not necessary else if (ev.window.event == SDL_WINDOWEVENT_TAKE_FOCUS) { // focus offered -> grab focus EVENT_LOCK_GUARD(this); diff --git a/test/core/test_locations_parser.cpp b/test/core/test_locations_parser.cpp index 760ea6db..f6d086ca 100644 --- a/test/core/test_locations_parser.cpp +++ b/test/core/test_locations_parser.cpp @@ -8,7 +8,7 @@ using nlohmann::json; TEST(LocationsParserTest, LocationRulesInheritAndEmpty) { - // TODO: validate indirectly by checcking accessibility/visibilty via Tracker + // TODO: validate indirectly by checking accessibility/visibility via Tracker const list> parentAccessRules = {{"a"}}; const list> parentVisibilityRules = {{"b"}}; json childNode = R"( @@ -27,7 +27,7 @@ TEST(LocationsParserTest, LocationRulesInheritAndEmpty) { } TEST(LocationsParserTest, SectionRulesInheritAndEmpty) { - // TODO: validate indirectly by checcking accessibility/visibilty via Tracker + // TODO: validate indirectly by checking accessibility/visibiltiy via Tracker json locationNode = R"( { "name": "location",