Merge branch 'linting' of fbrinker/elderscrolls-addon-achievementInfo into master

.drone.yml

@@ -11,9 +11,16 @@ steps:
   commands:
   - git clone https://git.f-brinker.de/fbrinker/elderscrolls-addon-achievementInfo.git sources
   - cd sources && git checkout $DRONE_COMMIT
-  when:
-    event: 
-      - tag
+
+- name: lint
+  image: alpine
+  commands:
+    - apk update
+    - apk add --no-cache build-base curl unzip
+    - apk add --no-cache lua5.1 lua5.1-dev luarocks5.1
+    - luarocks-5.1 install luacheck
+    - cd sources
+    - luacheck ./*.lua
 
 - name: build
   image: alpine
@@ -25,7 +32,7 @@ steps:
     # Set Version and AddonVersion
     - export VERSION=$DRONE_TAG
     - export ADDON_VERSION=$(echo $DRONE_TAG | sed -E 's/(0|)\.//g')
-    - sed -i "s/%VERSION%/$VERSION/g" sources/AchievementInfoCommon.lua
+    - sed -i "s/\"%VERSION%\"/$VERSION/g" sources/AchievementInfoCommon.lua
     - sed -i "s/%VERSION%/$VERSION/g" sources/AchievementInfo.txt
     - sed -i "s/%ADDON_VERSION%/$ADDON_VERSION/g" sources/AchievementInfo.txt
     # Rename and zip

.luacheckrc

@@ -0,0 +1,23 @@
+compat = true
+allow_defined = true
+max_line_length = false
+
+read_globals = {
+    "GetAchievementId",
+    "GetAchievementCategoryInfo",
+    "GetAchievementCriterion",
+    "GetAchievementLink",
+    "GetAchievementNumCriteria",
+    "GetCategoryInfoFromAchievementId",
+    "GetCVar",
+    "GetNumAchievementCategories",
+    "GetPreviousAchievementInLine",
+    "CHAT_SYSTEM", 
+    "EVENT_ACHIEVEMENT_UPDATED",
+    "EVENT_ADD_ON_LOADED",
+    "EVENT_MANAGER", 
+    "LibStub",
+    "LINK_STYLE_BRACKET", 
+    "zo_callLater",
+    "ZO_SavedVars",
+}

AchievementInfo.lua

@@ -7,7 +7,7 @@
 
 -- Init
 AchievementInfo.hijackedFirstLoad = false
-function AchievementInfo.initialize(eventCode, addOnName)
+function AchievementInfo.initialize(_, addOnName)
     if (addOnName ~= AchievementInfo.name) then return end
 
     --

AchievementInfoApplication.lua

@@ -6,7 +6,7 @@
 
 
 -- Do the magic
-function AchievementInfo.onAchievementUpdated(eventCode, achId)
+function AchievementInfo.onAchievementUpdated(_, achId)
     local output            = ""
 
     -- addOn enabled?
@@ -50,7 +50,6 @@ function AchievementInfo.onAchievementUpdated(eventCode, achId)
     local percentageStepSize    = AchievementInfo.settingGet("genShowUpdateSteps")
 
     local link = GetAchievementLink(achId, LINK_STYLE_BRACKET)
-    local name, description = GetAchievementInfo(achId)
     local catName = "/"
 
     if categoryId ~= false then
@@ -61,14 +60,14 @@ function AchievementInfo.onAchievementUpdated(eventCode, achId)
 
     local numCriteria = GetAchievementNumCriteria(achId)
     for i = 1, numCriteria, 1 do
-        local name, numCompleted, numRequired = GetAchievementCriterion(achId, i)
+        local description, numCompleted, numRequired = GetAchievementCriterion(achId, i)
         local tmpOutput = ""
 
         if i > 1 and AchievementInfo.settingGet("genOnePerLine") == false then
             tmpOutput = tmpOutput .. ", "
         end
 
-        tmpOutput = tmpOutput .. name .. " "
+        tmpOutput = tmpOutput .. description .. " "
         tmpOutput = tmpOutput .. AchievementInfo.calcCriteriaColor(numCompleted, numRequired) .. numCompleted .. "|r"
         tmpOutput = tmpOutput .. AchievementInfo.clrDefault .. "/" .. "|r"
         tmpOutput = tmpOutput .. AchievementInfo.clrCriteriaComplete .. numRequired .. "|r"
@@ -163,13 +162,11 @@ end
 -- Get the correct achievement category
 function AchievementInfo.getCorrectAchievementCategoryId(achId)
     local previousAchievementId = GetPreviousAchievementInLine(achId)
-    local categoryId            = 0
 
     if AchievementInfo.checkForValidCategory(achId) == false and previousAchievementId ~= 0 then
         return AchievementInfo.getCorrectAchievementCategoryId(previousAchievementId)
     elseif AchievementInfo.checkForValidCategory(achId) then
-        categoryId = GetCategoryInfoFromAchievementId(achId)
-        return categoryId
+        return GetCategoryInfoFromAchievementId(achId)
     else
         return false
     end

AchievementInfoCommon.lua

@@ -8,7 +8,7 @@
 AchievementInfo             = {}
 AchievementInfo.name        = "AchievementInfo"
 AchievementInfo.author      = "Asto, @Astarax"
-AchievementInfo.version     = %VERSION%
+AchievementInfo.version     = "%VERSION%"
 AchievementInfo.savedVars   = nil
 AchievementInfo.LangStore   = {}
 

AchievementInfoSettings.lua

@@ -122,10 +122,9 @@ function AchievementInfo.createSettingsPanel()
 
     -- Add categories dynamically
     local numCats = GetNumAchievementCategories()
-    local catCount = 1
 
     for i = 1, numCats, 1 do
-        catName, numSubCats = GetAchievementCategoryInfo(i)
+        catName = GetAchievementCategoryInfo(i)
 
         table.insert(optionsTable, {
             type = "checkbox",

README.md

@@ -17,3 +17,6 @@ I'll still be available here and be able to update the ESOUI page.
 **IMPORTANT: Github is a mirror.** Please contribute at [git.f-brinker.de/elderscrolls-addon-achievementInfo](https://git.f-brinker.de/fbrinker/elderscrolls-addon-achievementInfo) - You can login with your Github or Gitlab account (OAuth2).
 
 Then, create a fork of the repository, do what you have to do and create a pull-request afterwards. Feel free to contact me any time.
+
+#### Linting
+Luacheck is used to check the LUA code. [Documentation](https://luacheck.readthedocs.io/en/stable/index.html)