Merge branch 'master' into RGP-localization

* master:
  Fix workflow names
  chore: autopublish 2024-01-31T02:13:19Z
  fix tie.lua issue exposed by de-linting. (Note to RGP: The Tie Mover test case "V2-across-system-Fin27.musx" illustrates the bug that this change fixes.)
  chore: autopublish 2024-01-27T17:31:36Z
  Put back references to mixin
  Update staff_rename.lua
  Fix for mixin_helper
  Ignore warning in tie.lua for now
  Fixes for globals with RetainLuaState via FCXCustomLuaWindow
  Fix issues with unused variables
  Luacheck hinting and fixes
  Add linting workflow and config

# Conflicts:
#	src/transpose_chromatic.lua

Author: rpatters1

.github/workflows/deploy.yml

@@ -1,4 +1,4 @@
-name: Build and deploy scripts/docs
+name: Build and optionally deploy scripts/docs
 
 on:
     push:

.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Lint all src files
+
+on:
+  push:
+  pull_request:
+    branches:
+      - "master"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Luacheck linter
+        uses: lunarmodules/luacheck@v1

.luacheckrc

@@ -0,0 +1,36 @@
+-- luacheck: ignore 131
+include_files = { "src/**/*.lua"}
+exclude_files = {
+    "mobdebug.lua",
+    "src/lunajson/**/*.lua",
+}
+globals = {
+    "finale",
+    "finenv",
+    "finaleplugin",
+    "coll2table",
+    "dumpproperties",
+    "each",
+    "eachbackwards",
+    "eachcell",
+    "eachentry",
+    "eachentrysaved",
+    "eachstaff",
+    "loadall",
+    "loadallforregion",
+    "pairsbykeys",
+    "bit32",
+    "utf8",
+    "socket",
+    "tinyxml2",
+    "xmlelements",
+    "xmlattributes",
+    "prettyformatjson",
+    "plugindef"
+}
+codes = true
+ignore = { 
+    "6..",           -- formatting
+    "131/plugindef"  -- ignore plugindef errors; seems to be needed just for VS Code
+}
+allow_defined_top = true

.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-    "recommendations": ["Koihik.vscode-lua-format", "sumneko.lua"]
+    "recommendations": ["Koihik.vscode-lua-format", "sumneko.lua", "rog2.luacheck"]
 }

.vscode/recommended_settings.json

@@ -29,6 +29,7 @@
         "dist/**": true
     },
     "editor.formatOnSave": true,
+    "Lua.diagnostics.enable": false,
     "Lua.diagnostics.disable": [
         "lowercase-global",
         "luadoc-miss-cate-name"

dist/UI_switch_to_selected_part.lua

@@ -267,7 +267,7 @@ package.preload["library.general_library"] = package.preload["library.general_li
     function library.get_page_format_prefs()
         local current_part = library.get_current_part()
         local page_format_prefs = finale.FCPageFormatPrefs()
-        local success = false
+        local success
         if current_part:IsScore() then
             success = page_format_prefs:LoadScore()
         else
@@ -370,7 +370,7 @@ package.preload["library.general_library"] = package.preload["library.general_li
         local str = finale.FCString()
         local min_width = 160
 
-        function format_ctrl(ctrl, h, w, st)
+        local function format_ctrl(ctrl, h, w, st)
             ctrl:SetHeight(h)
             ctrl:SetWidth(w)
             if st then
@@ -379,11 +379,11 @@ package.preload["library.general_library"] = package.preload["library.general_li
             end
         end
 
-        title_width = string.len(title) * 6 + 54
+        local title_width = string.len(title) * 6 + 54
         if title_width > min_width then
             min_width = title_width
         end
-        text_width = string.len(text) * 6
+        local text_width = string.len(text) * 6
         if text_width > min_width then
             min_width = text_width
         end
@@ -508,7 +508,7 @@ function plugindef()
     finaleplugin.NoStore = true
     finaleplugin.Author = "CJ Garcia"
     finaleplugin.Copyright = "© 2022 CJ Garcia Music"
-    finaleplugin.Version = "1.3"
+    finaleplugin.Version = "1.3.1"
     finaleplugin.Date = "February 14, 2022"
     finaleplugin.CategoryTags = "UI"
     finaleplugin.HashURL = "https://raw.githubusercontent.com/finale-lua/lua-scripts/master/hash/UI_switch_to_selected_part.hash"
@@ -532,8 +532,8 @@ function ui_switch_to_selected_part()
                 part_ID = part:GetID()
 
                 local found_staff = false
-                local part = finale.FCPart(part_ID)
-                part:SwitchTo()
+                local this_part = finale.FCPart(part_ID)
+                this_part:SwitchTo()
                 local systems = finale.FCStaffSystems()
                 systems:LoadAll()
                 local system = systems:FindMeasureNumber(top_cell.Measure)
@@ -542,7 +542,7 @@ function ui_switch_to_selected_part()
                     staves:LoadAllForItem(system.ItemNo)
                     found_staff = staves:FindStaff(top_cell.Staff) ~= nil
                 end
-                part:SwitchBack()
+                this_part:SwitchBack()
                 if found_staff then break end
             end
         end

dist/accidental_simplify.lua

@@ -317,7 +317,7 @@ package.preload["library.configuration"] = package.preload["library.configuratio
     end
 
     function configuration.get_parameters(file_name, parameter_list)
-        local path = ""
+        local path
         if finenv.IsRGPLua then
             path = finenv.RunningLuaFolderPath()
         else
@@ -425,7 +425,7 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
 
     function note_entry.get_top_note_position(entry, entry_metrics)
         local retval = -math.huge
-        local loaded_here = false
+        local loaded_here
         entry_metrics, loaded_here = use_or_get_passed_in_entry_metrics(entry, entry_metrics)
         if nil == entry_metrics then
             return retval
@@ -449,7 +449,7 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
 
     function note_entry.get_bottom_note_position(entry, entry_metrics)
         local retval = math.huge
-        local loaded_here = false
+        local loaded_here
         entry_metrics, loaded_here = use_or_get_passed_in_entry_metrics(entry, entry_metrics)
         if nil == entry_metrics then
             return retval
@@ -498,11 +498,11 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
         if entry:CalcStemUp() then
             return 0
         end
-        local left, right = note_entry.calc_widths(entry)
+        local left, _ = note_entry.calc_widths(entry)
         return -left
     end
 
-    function note_entry.calc_left_of_primary_notehead(entry)
+    function note_entry.calc_left_of_primary_notehead()
         return 0
     end
 
@@ -527,7 +527,7 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
         if not entry:CalcStemUp() then
             return 0
         end
-        local left, right = note_entry.calc_widths(entry)
+        local left, _ = note_entry.calc_widths(entry)
         return left
     end
 
@@ -898,7 +898,7 @@ package.preload["library.transposition"] = package.preload["library.transpositio
         local curr_disp = note.Displacement
         local curr_alt = note.RaiseLower
         local key = get_key(note)
-        local number_of_steps, diatonic_steps, fifth_steps = get_key_info(key)
+        local _, diatonic_steps, _ = get_key_info(key)
         local interval_normalized = signed_modulus(interval, #diatonic_steps)
         local steps_in_alteration = calc_steps_in_alteration(key, interval, alteration)
         local steps_in_interval = calc_steps_in_normalized_interval(key, interval_normalized)

dist/articulation_autoposition_rolled_chords.lua

@@ -35,7 +35,7 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
 
     function note_entry.get_top_note_position(entry, entry_metrics)
         local retval = -math.huge
-        local loaded_here = false
+        local loaded_here
         entry_metrics, loaded_here = use_or_get_passed_in_entry_metrics(entry, entry_metrics)
         if nil == entry_metrics then
             return retval
@@ -59,7 +59,7 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
 
     function note_entry.get_bottom_note_position(entry, entry_metrics)
         local retval = math.huge
-        local loaded_here = false
+        local loaded_here
         entry_metrics, loaded_here = use_or_get_passed_in_entry_metrics(entry, entry_metrics)
         if nil == entry_metrics then
             return retval
@@ -108,11 +108,11 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
         if entry:CalcStemUp() then
             return 0
         end
-        local left, right = note_entry.calc_widths(entry)
+        local left, _ = note_entry.calc_widths(entry)
         return -left
     end
 
-    function note_entry.calc_left_of_primary_notehead(entry)
+    function note_entry.calc_left_of_primary_notehead()
         return 0
     end
 
@@ -137,7 +137,7 @@ package.preload["library.note_entry"] = package.preload["library.note_entry"] or
         if not entry:CalcStemUp() then
             return 0
         end
-        local left, right = note_entry.calc_widths(entry)
+        local left, _ = note_entry.calc_widths(entry)
         return left
     end
 
@@ -339,7 +339,6 @@ package.preload["library.articulation"] = package.preload["library.articulation"
             top_pos = math.floor(((10000 * top_pos) / cell_metrics.StaffScaling) + 0.5)
             return curr_pos.Y >= top_pos
         end
-        return false
     end
 
     function articulation.calc_main_character_dimensions(artic_def)
@@ -456,7 +455,7 @@ function articulation_autoposition_rolled_chords()
                                 artic.Visible = false
                             else
                                 local this_bottom = note_entry.get_bottom_note_position(entry)
-                                staff_scale = mm.StaffScaling / 10000
+                                local staff_scale = mm.StaffScaling / 10000
                                 top_page_pos = top_page_pos / staff_scale
                                 bottom_page_pos = bottom_page_pos / staff_scale
                                 left_page_pos = left_page_pos / staff_scale

dist/articulation_delete_duplicates.lua

@@ -17,18 +17,18 @@ function articulation_delete_duplicates()
         end
         local sort_list = {}
         local unique_list = {}
-        for k,v in ipairs(art_list) do
+        for _, v in ipairs(art_list) do
             if (not sort_list[v]) then
                 unique_list[#unique_list + 1] = v
                 sort_list[v] = true
             end
         end
-        for key, value in pairs(art_list) do
+        for _, _ in pairs(art_list) do
             for a in each(arts) do
                 a:DeleteData()
             end
         end
-        for key, value in pairs(unique_list) do
+        for _, value in pairs(unique_list) do
             local art = finale.FCArticulation()
             art:SetNoteEntry(note_entry)
             art:SetID(value) art:SaveNew()