From 9a276526effa5f888c0cd2404686381e1b04f2af Mon Sep 17 00:00:00 2001 From: ChillerDragon Date: Sun, 17 Sep 2023 17:31:10 +0200 Subject: [PATCH] Use git for versioning not folder names --- README.md | 2 +- docs/{v0.0.1 => }/README.md | 0 docs/{v0.0.1 => }/classes/ChatMessage.md | 0 docs/{v0.0.1 => }/classes/Context.md | 0 docs/{v0.0.1 => }/classes/Player.md | 0 docs/{v0.0.1 => }/classes/Snapshot.md | 0 docs/{v0.0.1 => }/classes/TeeworldsClient.md | 0 docs/{v0.0.1 => }/classes/messages/ClEmoticon.md | 0 docs/{v0.0.1 => }/classes/messages/ClSay.md | 0 docs/{v0.0.1 => }/classes/messages/ClientInfo.md | 0 docs/{v0.0.1 => }/classes/messages/GameInfo.md | 0 docs/{v0.0.1 => }/classes/messages/InputTiming.md | 0 .../{v0.0.1 => }/classes/messages/MaplistEntryAdd.md | 0 .../{v0.0.1 => }/classes/messages/MaplistEntryRem.md | 0 docs/{v0.0.1 => }/classes/messages/RconCmdAdd.md | 0 docs/{v0.0.1 => }/classes/messages/RconCmdRem.md | 0 docs/{v0.0.1 => }/classes/messages/RconLine.md | 0 docs/{v0.0.1 => }/classes/messages/ServerInfo.md | 0 docs/{v0.0.1 => }/classes/messages/ServerSettings.md | 0 docs/{v0.0.1 => }/classes/messages/StartInfo.md | 0 docs/{v0.0.1 => }/classes/messages/SvClientDrop.md | 0 scripts/hooks.sh | 9 +-------- scripts/messages.sh | 12 ++---------- scripts/update_docs_index.sh | 8 ++++---- scripts/update_docs_methods.sh | 9 +-------- 25 files changed, 9 insertions(+), 31 deletions(-) rename docs/{v0.0.1 => }/README.md (100%) rename docs/{v0.0.1 => }/classes/ChatMessage.md (100%) rename docs/{v0.0.1 => }/classes/Context.md (100%) rename docs/{v0.0.1 => }/classes/Player.md (100%) rename docs/{v0.0.1 => }/classes/Snapshot.md (100%) rename docs/{v0.0.1 => }/classes/TeeworldsClient.md (100%) rename docs/{v0.0.1 => }/classes/messages/ClEmoticon.md (100%) rename docs/{v0.0.1 => }/classes/messages/ClSay.md (100%) rename docs/{v0.0.1 => }/classes/messages/ClientInfo.md (100%) rename docs/{v0.0.1 => }/classes/messages/GameInfo.md (100%) rename docs/{v0.0.1 => }/classes/messages/InputTiming.md (100%) rename docs/{v0.0.1 => }/classes/messages/MaplistEntryAdd.md (100%) rename docs/{v0.0.1 => }/classes/messages/MaplistEntryRem.md (100%) rename docs/{v0.0.1 => }/classes/messages/RconCmdAdd.md (100%) rename docs/{v0.0.1 => }/classes/messages/RconCmdRem.md (100%) rename docs/{v0.0.1 => }/classes/messages/RconLine.md (100%) rename docs/{v0.0.1 => }/classes/messages/ServerInfo.md (100%) rename docs/{v0.0.1 => }/classes/messages/ServerSettings.md (100%) rename docs/{v0.0.1 => }/classes/messages/StartInfo.md (100%) rename docs/{v0.0.1 => }/classes/messages/SvClientDrop.md (100%) diff --git a/README.md b/README.md index 8765189..f4ed17c 100644 --- a/README.md +++ b/README.md @@ -38,4 +38,4 @@ client.connect('localhost', 8303, detach: false) ## Documentation -Checkout [docs/v0.0.1/READE.md](docs/v0.0.1/README.md) for a full library documentation. +Checkout [docs/READE.md](docs/README.md) for a full library documentation. diff --git a/docs/v0.0.1/README.md b/docs/README.md similarity index 100% rename from docs/v0.0.1/README.md rename to docs/README.md diff --git a/docs/v0.0.1/classes/ChatMessage.md b/docs/classes/ChatMessage.md similarity index 100% rename from docs/v0.0.1/classes/ChatMessage.md rename to docs/classes/ChatMessage.md diff --git a/docs/v0.0.1/classes/Context.md b/docs/classes/Context.md similarity index 100% rename from docs/v0.0.1/classes/Context.md rename to docs/classes/Context.md diff --git a/docs/v0.0.1/classes/Player.md b/docs/classes/Player.md similarity index 100% rename from docs/v0.0.1/classes/Player.md rename to docs/classes/Player.md diff --git a/docs/v0.0.1/classes/Snapshot.md b/docs/classes/Snapshot.md similarity index 100% rename from docs/v0.0.1/classes/Snapshot.md rename to docs/classes/Snapshot.md diff --git a/docs/v0.0.1/classes/TeeworldsClient.md b/docs/classes/TeeworldsClient.md similarity index 100% rename from docs/v0.0.1/classes/TeeworldsClient.md rename to docs/classes/TeeworldsClient.md diff --git a/docs/v0.0.1/classes/messages/ClEmoticon.md b/docs/classes/messages/ClEmoticon.md similarity index 100% rename from docs/v0.0.1/classes/messages/ClEmoticon.md rename to docs/classes/messages/ClEmoticon.md diff --git a/docs/v0.0.1/classes/messages/ClSay.md b/docs/classes/messages/ClSay.md similarity index 100% rename from docs/v0.0.1/classes/messages/ClSay.md rename to docs/classes/messages/ClSay.md diff --git a/docs/v0.0.1/classes/messages/ClientInfo.md b/docs/classes/messages/ClientInfo.md similarity index 100% rename from docs/v0.0.1/classes/messages/ClientInfo.md rename to docs/classes/messages/ClientInfo.md diff --git a/docs/v0.0.1/classes/messages/GameInfo.md b/docs/classes/messages/GameInfo.md similarity index 100% rename from docs/v0.0.1/classes/messages/GameInfo.md rename to docs/classes/messages/GameInfo.md diff --git a/docs/v0.0.1/classes/messages/InputTiming.md b/docs/classes/messages/InputTiming.md similarity index 100% rename from docs/v0.0.1/classes/messages/InputTiming.md rename to docs/classes/messages/InputTiming.md diff --git a/docs/v0.0.1/classes/messages/MaplistEntryAdd.md b/docs/classes/messages/MaplistEntryAdd.md similarity index 100% rename from docs/v0.0.1/classes/messages/MaplistEntryAdd.md rename to docs/classes/messages/MaplistEntryAdd.md diff --git a/docs/v0.0.1/classes/messages/MaplistEntryRem.md b/docs/classes/messages/MaplistEntryRem.md similarity index 100% rename from docs/v0.0.1/classes/messages/MaplistEntryRem.md rename to docs/classes/messages/MaplistEntryRem.md diff --git a/docs/v0.0.1/classes/messages/RconCmdAdd.md b/docs/classes/messages/RconCmdAdd.md similarity index 100% rename from docs/v0.0.1/classes/messages/RconCmdAdd.md rename to docs/classes/messages/RconCmdAdd.md diff --git a/docs/v0.0.1/classes/messages/RconCmdRem.md b/docs/classes/messages/RconCmdRem.md similarity index 100% rename from docs/v0.0.1/classes/messages/RconCmdRem.md rename to docs/classes/messages/RconCmdRem.md diff --git a/docs/v0.0.1/classes/messages/RconLine.md b/docs/classes/messages/RconLine.md similarity index 100% rename from docs/v0.0.1/classes/messages/RconLine.md rename to docs/classes/messages/RconLine.md diff --git a/docs/v0.0.1/classes/messages/ServerInfo.md b/docs/classes/messages/ServerInfo.md similarity index 100% rename from docs/v0.0.1/classes/messages/ServerInfo.md rename to docs/classes/messages/ServerInfo.md diff --git a/docs/v0.0.1/classes/messages/ServerSettings.md b/docs/classes/messages/ServerSettings.md similarity index 100% rename from docs/v0.0.1/classes/messages/ServerSettings.md rename to docs/classes/messages/ServerSettings.md diff --git a/docs/v0.0.1/classes/messages/StartInfo.md b/docs/classes/messages/StartInfo.md similarity index 100% rename from docs/v0.0.1/classes/messages/StartInfo.md rename to docs/classes/messages/StartInfo.md diff --git a/docs/v0.0.1/classes/messages/SvClientDrop.md b/docs/classes/messages/SvClientDrop.md similarity index 100% rename from docs/v0.0.1/classes/messages/SvClientDrop.md rename to docs/classes/messages/SvClientDrop.md diff --git a/scripts/hooks.sh b/scripts/hooks.sh index 3e35a99..66b7664 100755 --- a/scripts/hooks.sh +++ b/scripts/hooks.sh @@ -150,15 +150,8 @@ function check_file() { local ruby_file="$2" local hooks local hook - local version local got_err=0 - version="$(grep TEEWORLDS_NETWORK_VERSION lib/version.rb | cut -d"'" -f2)" hooks="$(get_hooks "$ruby_file")" - if [ "$version" == "" ] - then - echo "Error: failed to get library version" - exit 1 - fi # self testing the test # if the test finds no hooks the test is wrong not the code @@ -175,7 +168,7 @@ function check_file() { echo -n "[*] checking hook: $hook" # check documentation local mdfile - mdfile="docs/$version/classes/$ruby_class.md" + mdfile="docs/classes/$ruby_class.md" if [ ! -f "$mdfile" ] then echo "ERROR: documentation not found $mdfile" diff --git a/scripts/messages.sh b/scripts/messages.sh index 4ab0f09..47453cb 100755 --- a/scripts/messages.sh +++ b/scripts/messages.sh @@ -19,7 +19,6 @@ done function missing_doc() { local rb_file="$1" - local version="$2" local line local ifs="$IFS" local dir='' @@ -65,7 +64,7 @@ function missing_doc() { fi done < "$rb_file" IFS="$ifs" - dst_file="docs/$version/classes/messages/$class_name.md" + dst_file="docs/classes/messages/$class_name.md" if [ -f "$dst_file" ] then return 1 @@ -85,18 +84,11 @@ function missing_doc() { } function generate_msg_docs() { - local version - version="$(grep TEEWORLDS_NETWORK_VERSION lib/version.rb | cut -d"'" -f2)" - if [ "$version" == "" ] - then - echo "Error: failed to get library version" - exit 1 - fi local rb_file for rb_file in ./lib/messages/*.rb do echo -n "[*] $(basename "$rb_file") .. " - if missing_doc "$rb_file" "$version" + if missing_doc "$rb_file" then echo "ERROR: missing doc try --fix" else diff --git a/scripts/update_docs_index.sh b/scripts/update_docs_index.sh index c34e859..3b8105c 100755 --- a/scripts/update_docs_index.sh +++ b/scripts/update_docs_index.sh @@ -41,16 +41,16 @@ function print_instance_methods() { hook_slug="${hook_slug%%\?*}" echo "" echo "[#$hook](classes/$class.md#$hook_slug)" - done < <(grep '###