From 30df59c83c25e57578207e6f9a0ee62d0f04bd7c Mon Sep 17 00:00:00 2001 From: plague006 Date: Thu, 22 Nov 2018 14:59:32 -0500 Subject: [PATCH] Add stickler_ci --- .luacheckrc | 1003 +++++++++++++++++++++++++++++++++++++++++++++++++ .stickler.yml | 7 + 2 files changed, 1010 insertions(+) create mode 100644 .luacheckrc create mode 100644 .stickler.yml diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 00000000..c174afed --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,1003 @@ +------------------------------------------------------------------------------- +--[LICENSE]-- +------------------------------------------------------------------------------- +-- .luacheckrc +-- This file is free and unencumbered software released into the public domain. +-- +-- Anyone is free to copy, modify, publish, use, compile, sell, or +-- distribute this file, either in source code form or as a compiled +-- binary, for any purpose, commercial or non-commercial, and by any +-- means. +-- +-- In jurisdictions that recognize copyright laws, the author or authors +-- of this file dedicate any and all copyright interest in the +-- software to the public domain. We make this dedication for the benefit +-- of the public at large and to the detriment of our heirs and +-- successors. We intend this dedication to be an overt act of +-- relinquishment in perpetuity of all present and future rights to this +-- software under copyright law. +-- +-- THE FILE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +-- IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +-- OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +-- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +-- OTHER DEALINGS IN THE SOFTWARE. +-- +-- For more information, please refer to +-- ]] + +------------------------------------------------------------------------------- +--[.luacheckrc]-- Current Factorio Version .16 +------------------------------------------------------------------------------- +-- Set up the the standards for this file. +files['.luacheckrc'] = { + std = 'lua52c', + globals = {'files', 'exclude_files', 'not_globals', 'stds', 'std', 'max_line_length', 'ignore', 'quiet', "max_cyclomatic_complexity", "codes", "globals"}, + max_line_length = false --turn of line length warnings for this file +} + +------------------------------------------------------------------------------- +--[Set Defaults]-- +------------------------------------------------------------------------------- +local LINE_LENGTH = 170 -- It is 2017 limits on length are a waste +local IGNORE = {'21./%w+_$', '21./^_%w+$', '213/[ijk]', '213/index', '213/key'} +local NOT_GLOBALS = {'coroutine', 'io', 'socket', 'dofile', 'loadfile'} -- These globals are not available to the factorio API + +local STD_CONTROL = 'lua52c+factorio+factorio_control+stdlib+factorio_defines' +local STD_DATA = 'lua52c+factorio+factorio_data+stdlib+stdlib_data+factorio_defines' + +-- In a perfect world these would be STD_DATA and STD_CONTROL (mostly) +local STD_BASE_DATA = 'lua52c+factorio+factorio_data+factorio_defines+factorio_base_data' +local STD_BASE_CONTROL = 'lua52c+factorio+factorio_control+factorio_defines+factorio_base_control' + +------------------------------------------------------------------------------- +--[Assume Factorio Control stage as default]-- +------------------------------------------------------------------------------- +std = STD_CONTROL +globals = {'math', 'table', '_DEBUG', 'MARKET_ITEM', 'newline'} -- RedMew-specific globals +max_line_length = LINE_LENGTH + +not_globals = NOT_GLOBALS +ignore = IGNORE +quiet = 1 -- pass -q option +max_cyclomatic_complexity = 75 +codes = true + +--List of files and directories to exclude +exclude_files = { + --Ignore special folders + '**/.*/*', --Ignore if path starts with . + '**/mod/stdlib/', --Ignore from symlinked + '**/vendor/', + + --Ignore development mods + '**/combat-tester/', + '**/test-maker/', + '**/trailer/', +} + +------------------------------------------------------------------------------- +--[Mod Prototypes]-- +------------------------------------------------------------------------------- +--Set default prototype files +files['**/data.lua'].std = STD_DATA +files['**/data-updates.lua'].std = STD_DATA +files['**/data-final-fixes.lua'].std = STD_DATA +files['**/settings.lua'].std = STD_DATA +files['**/settings-updates.lua'].std = STD_DATA +files['**/settings-final-fixes.lua'].std = STD_DATA +files['**/prototypes/'].std = STD_DATA +files['**/settings/'].std = STD_DATA + +------------------------------------------------------------------------------- +--[Base]-- +------------------------------------------------------------------------------- +--Find and replace ignores *.cfg, migrations, *.txt, control.lua, *.json, trailer, scenarios, campaigns, *.glsl + +local base_scenarios = { + std = STD_BASE_CONTROL .. '+factorio_base_scenarios+factorio_base_story', + --Ignore these, Klonan is on his own! + --ignore = {'212/event', '111', '112', '113', '211', '212', '213', '311', '411', '412', '421', '422', '423', '431', '432', '512'} + ignore = {'...'} +} +files['**/base/scenarios/'] = base_scenarios +files['**/base/tutorials/'] = base_scenarios +files['**/base/campaigns/'] = base_scenarios +files['**/wip-scenario/'] = base_scenarios + +files['**/base/migrations/'] = {std = STD_BASE_CONTROL} + +files['**/core/lualib/'] = {std = STD_BASE_CONTROL} +files['**/core/lualib/util.lua'] = {globals = {'util', 'table'}, ignore = {'432/object'}} +files['**/core/lualib/silo-script.lua'] = {globals = {'silo_script'}, ignore = {'4../player'}} +files['**/core/lualib/production-score.lua'] = {globals = {'production_score', 'get_price_recursive'}, ignore = {'4../player'}} +files['**/core/lualib/story*'] = {std = '+factorio_base_story', ignore = {'42./k', '42./filter'}} +files['**/core/lualib/mod-gui.lua'] = {globals = {'mod_gui'}} +files['**/core/lualib/camera.lua'] = {globals = {'camera'}} +files['**/core/lualib/builder.lua'] = {globals = {'Builder', 'builder', 'action', 'down', 'right'}} + +files['**/core/lualib/bonus-gui-ordering/'] = {std = STD_BASE_DATA} +files['**/core/lualib/dataloader.lua'] = {globals = {'data'}} +files['**/core/lualib/circuit-connector-*'] = {std = STD_BASE_DATA..'+factorio_circuit_connector_generated'} +files['**/core/lualib/bonus-gui-ordering.lua'] = {globals = {'bonus_gui_ordering'}} + +files['**/base/prototypes/'] = {std = STD_BASE_DATA} +files['**/core/prototypes/'] = {std = STD_BASE_DATA} +files['**/core/prototypes/noise-programs.lua'] = {ignore = {'212/x', '212/y', '212/tile', '212/map'}} + +------------------------------------------------------------------------------- +--[Set STDLIB project modules]-- +------------------------------------------------------------------------------- +local stdlib_control = { + std = 'lua52c+factorio+factorio_control+stdlib+factorio_defines', + max_line_length = LINE_LENGTH +} + +local stdlib_data = { + std = 'lua52c+factorio+factorio_data+stdlib+factorio_defines', + max_line_length = LINE_LENGTH +} + +-- Assume control stage for stdlib +files['**/stdlib/'] = stdlib_control + +files['**/stdlib/utils/math.lua'].std = 'lua52c' +files['**/stdlib/utils/string.lua'].std = 'lua52c' +files['**/stdlib/utils/table.lua'].std = 'lua52c' +files['**/stdlib/utils/iterator.lua'].std = 'lua52c' +files['**/stdlib/utils/is.lua'].std = 'lua52c' + +-- STDLIB data files +files['**/stdlib/data/'] = stdlib_data +files['**/creative'].ignore = {'...'} + +-- STDLIB Busted Spec +files['**/spec/**'] = { + globals = {'serpent', 'log', 'SLOG', 'RESET'}, + std = 'lua52c+busted+factorio_defines+factorio_control+stdlib' +} + + +------------------------------------------------------------------------------- +--[STDS FACTORIO]-- +------------------------------------------------------------------------------- +stds.factorio = { + --Set the read only variables + read_globals = { + -- @log@: Gives writing access to Factorio's logger instance. + "log", + -- @serpent@: Lua serializer and pretty printer. (https://github.com/pkulchenko/serpent) + "serpent", + -- @table_size@: Returns the number of elements inside an LUA table + "table_size", + util = { + fields = { + "by_pixel", "distance", "findfirstentity", "positiontostr", "formattime", "moveposition", "oppositedirection", + "ismoduleavailable", "multiplystripes", "format_number", "increment", "color", "make_color", "conditional_return", + "add_shift", + table = { + fields = { + "compare", "deepcopy" + }, + }, + }, + }, + table = { + fields = { + "compare", "deepcopy" + }, + }, + }, +} + +stds.factorio_control = { + read_globals = { + + -- @settings@: + settings = { + fields = { + "get_player_settings", + startup = {read_only = false, other_fields = true}, + global = {read_only = false, other_fields = true}, + player = {read_only = false, other_fields = true}, + }, + }, + + -- @script@: Provides an interface for registering event handlers. + -- (http://lua-api.factorio.com/latest/LuaBootstrap.html) + script = { + fields = { + "on_event", "on_nth_tick", "on_configuration_changed", "on_init", "on_load", "generate_event_name", + "raise_event", "get_event_handler", "mod_name", "get_event_order" + }, + }, + + -- @remote@: Allows inter-mod communication by providing a repository of interfaces that is shared by all mods. + -- (http://lua-api.factorio.com/latest/LuaRemote.html) + remote = { + fields = { + "add_interface", "remove_interface", "call", "interfaces" + }, + }, + + -- @game@: Main object through which most of the API is accessed. + -- It is, however, not available inside handlers registered with @script.on_load@. + -- (http://lua-api.factorio.com/latest/LuaGameScript.html) + game ={ + other_fields = true, + read_only = false, + fields = { + "set_game_state", "get_entity_by_tag", "show_message_dialog", "disable_tips_and_tricks", "is_demo", "reload_script", + "save_atlas", "check_consistency", "regenerate_entity", "take_screenshot", "write_file", "remove_path", + "remove_offline_players", "force_crc", "merge_forces", "player", "server_save", "delete_surface", "disable_replay", + "direction_to_string", "print", "tick", "finished", "difficulty", + speed = { + --rw + read_only = false, + }, + player = { + --luaPlayer + --The player typing at the console, nil in all other cases + read_only = false, + other_fields = true, + }, + players = { + --array of luaPlayer + read_only = false, + other_fields = true, + }, + connected_players = { + --array of luaPlayer + read_only = false, + other_fields = true, + }, + surfaces = { + --array of luaSurface + read_only = false, + other_fields = true, + }, + create_surface = { + --luaSurface + read_only = false, + other_fields = true, + }, + forces = { + --array of luaForce + read_only = false, + other_fields = true, + }, + create_force = { + --luaForce + read_only = false, + other_fields = true, + }, + entity_prototypes = { + --string dictionary - > luaEntityPrototype + read_only = true, + other_fields = true + }, + item_prototypes = { + --string dictionary - > luaItemPrototype + read_only = true, + other_fields = true + }, + fluid_prototypes = { + --string dictionary - > luaFluidPrototype + read_only = true, + other_fields = true + }, + tile_prototypes = { + --string dictionary - > luaTilePrototype + read_only = true, + other_fields = true + }, + equipment_prototypes = { + --string dictionary - > luaEquipmentPrototype + read_only = true, + other_fields = true + }, + recipe_prototypes = { + --string dictionary - > luaRecipePrototype + read_only = true, + other_fields = true + }, + technology_prototypes = { + --string dictionary - > luaTechnologyPrototype + read_only = true, + other_fields = true + }, + damage_prototypes = { + --string dictionary - > luaDamagePrototype + read_only = true, + other_fields = true + }, + virtual_signal_prototypes = { + --string dictionary - > luaVirtualSignalPrototype + read_only = true, + other_fields = true + }, + equipment_grid_prototypes = { + --string dictionary - > luaEquipmentGridPrototype + read_only = true, + other_fields = true + }, + decorative_prototypes = { + --string dictionary -> LuaDecorativePrototype + read_only = true, + other_fields = true + }, + map_settings = { + --custom -> mapsettings + read_only = false, + other_fields = true + }, + active_mods = { + --string dictionary -> string version + read_only = true, + other_fields = true + }, + permissions = { + read_only = true, + other_fields = true + }, + backer_names = { + read_only = true, + other_fields = true + } + }, + }, + }, + + globals = { + -- @global@: The global dictionary, useful for storing data persistent across a save-load cycle. + -- Writing access is given to the mod-id field (for mod-wise saved data). + -- (http://lua-api.factorio.com/latest/Global.html) + "global", + + -- @MOD@: Keep it organized, use this variable for anything that "NEEDS" to be global for some reason. + "MOD", + + -- @commands@: + commands = { + fields = { + "add_command", "commands", "game_commands", + }, + } + }, +} + +stds.factorio_data = { + + read_globals = { + data = { + fields = { + raw = { + other_fields = true, + read_only = false + }, + "extend", "is_demo" + }, + }, + + settings = { + fields = { + "startup", "global", "player", + }, + }, + + --Popular mods + angelsmods = { + other_fields = true + }, + + bobmods = { + other_fields = true + }, + + mods = { + other_fields = true + } + } +} + +------------------------------------------------------------------------------- +--[Factorio Data]-------------------------------------------------------------- +------------------------------------------------------------------------------- +stds.factorio_base_control = { + read_globals = {"silo_script", "mod_gui", "camera"} +} + +stds.factorio_base_scenarios = { + globals = { + "check_automate_science_packs_advice", "check_research_hints", "check_supplies", "manage_attacks", "all_dead", + "on_win", "difficulty_number", "init_attack_data", "handle_attacks", "count_items_in_container", "progress", "scanned", + "check_light", "check_machine_gun", "level", "story_table", + + "tightspot_prices", "tightspot_make_offer", "tightspot_init", "tightspot_get_required_balance", + "tightspot_init_level", "tightspot_init_spending_frame", "tightspot_init_progress_frame", "tightspot_update_progress", "tightspot_update_spending", + "tightspot_get_missing_to_win", "tightspot_sell_back", "tightspot_start_level", "tightspot_show_level_description", "tightspot_update_speed_label", + "map_ignore", "tightspot_check_level", "land_price", + + "transport_belt_madness_init", "transport_belt_madness_init_level", "transport_belt_madness_create_chests", "transport_belt_madness_fill_chests", + "transport_belt_madness_start_level", "map_ignore", "map_clear", "map_load", "map_save", "transport_belt_madness_show_level_description", + "transport_belt_madness_check_level", "transport_belt_madness_next_level", "transport_belt_madness_clear_level", "transport_belt_madness_contains_next_level", + + "restricted", "check_built_items", "result", "disable_combat_technologies", "apply_character_modifiers", "apply_combat_modifiers", "apply_balance", + "load_config", "starting_area_constant", "create_next_surface", "end_round", "prepare_next_round", "silo_died","choose_joining_gui", + "destroy_joining_guis", "create_random_join_gui", "create_auto_assign_gui", "create_pick_join_gui", "create_config_gui", "make_config_table", "default", + "make_team_gui", "make_team_gui_config", "add_team_button_press", "trash_team_button_press", "remove_team_from_team_table", "add_team_to_team_table", + "set_teams_from_gui", "on_team_button_press", "make_color_dropdown", "create_balance_option", "create_disable_frame", "disable_frame", "parse_disabled_items", + "set_balance_settings", "config_confirm", "parse_config_from_gui", "get_color", "roll_starting_area", "delete_roll_surfaces", "auto_assign", + "destroy_config_for_all", "prepare_map", "set_evolution_factor", "update_players_on_team_count", "random_join", "init_player_gui", + "destroy_player_gui", "objective_button_press", "admin_button_press", "admin_frame_button_press", "diplomacy_button_press", "update_diplomacy_frame", + "diplomacy_frame_button_press", "team_changed_diplomacy", "diplomacy_check_press", "get_stance", "give_inventory", "setup_teams", "disable_items_for_all", + "set_random_team", "set_diplomacy", "create_spawn_positions", "set_spawn_position", "set_team_together_spawns", "chart_starting_area_for_force_spawns", + "check_starting_area_chunks_are_generated", "check_player_color", "check_round_start", "clear_starting_area_enemies", "check_no_rush_end", "check_no_rush_players", + "finish_setup", "chart_area_for_force", "setup_start_area_copy", "update_copy_progress", "update_progress_bar", "copy_paste_starting_area_tiles", + "copy_paste_starting_area_entities", "create_silo_for_force", "setup_research", "on_chunk_generated", "get_distance_to_nearest_spawn", + "create_wall_for_force", "fpn", "give_items", "create_item_frame", "create_technologies_frame", "create_cheat_frame", "create_day_frame", + "time_modifier", "points_per_second_start", "points_per_second_level_subtract", "levels", "update_info", "get_time_left", "update_time_left", + "on_joined", "make_frame", "update_frame", "update_table", "calculate_task_item_multiplayer", "setup_config", "select_from_probability_table", + "select_inventory", "select_equipment", "select_challange_type", "save_round_statistics", "start_challenge", "create_teams", "set_areas", + "decide_player_team", "set_teams", "refresh_leaderboard", "set_player", "generate_technology_list", "generate_research_task","setup_unlocks", + "check_technology_progress", "generate_production_task", "generate_shopping_list_task", "set_gui_flow_table", "create_visibility_button", + "check_item_lists", "update_task_gui", "check_end_of_round", "end_round_gui_update", "try_to_check_victory", "update_gui", "check_start_round", + "check_start_set_areas", "check_start_setting_entities", "check_set_areas", "check_clear_areas", "check_chests", "check_chests_shopping_list", + "check_chests_production", "check_input_chests", "fill_input_chests", "check_victory", "shopping_task_finished", "calculate_force_points", + "update_research_task_table", "update_production_task_table", "update_shopping_list_task_table", "create_joined_game_gui", "pre_ending_round", + "player_ending_prompt", "update_end_timer", "update_begin_timer", "team_finished", "save_points_list", "give_force_players_points", + "update_winners_list", "set_spectator", "set_character", "give_starting_inventory", "give_equipment", "shuffle_table", "format_time", + "spairs", "fill_leaderboard", "create_grid", "simple_entities", "save_map_data", "clear_map", "create_tiles", "recreate_entities", + "map_sets", "give_points", "init_forces", "init_globals", "init_unit_settings", "check_next_wave", "next_wave", "calculate_wave_power", + "wave_end", "make_next_spawn_tick", "check_spawn_units", "get_wave_units", "spawn_units", "randomize_ore", "set_command", "command_straglers", + "unit_config", "make_next_wave_tick", "time_to_next_wave", "time_to_wave_end", "rocket_died", "unit_died", "get_bounty_price", "setup_waypoints", + "insert_items", "give_starting_equipment", "give_spawn_equipment", "next_round_button_visible", "gui_init", "create_wave_frame", "create_money_frame", + "create_upgrade_gui", "update_upgrade_listing", "upgrade_research", "get_upgrades", "get_money", "update_connected_players", "update_round_number", + "set_research", "set_recipes", "check_deconstruction", "check_blueprint_placement", "loop_entities", "experiment_items", + "setup", "story_gui_click", "clear_surface", "add_run_trains_button", "puzzle_condition", "basic_signals", + "loop_trains", "Y_offset", "ghosts_1", "ghosts_2", "required_path", "through_wall_path", "count", "check_built_real_rail", + "current_ghosts_count", "other", "rails", "set_rails", "straight_section", "late_entities", "entities", "stop", + "get_spawn_coordinate", + + --tutorials + "intermission", "create_entities_on_tick", "on_player_created", "required_count", "non_player_entities", "clear_rails", + "chest", "damage", "furnace", "init_prototypes", "build_infi_table", "junk", "update_player_tags", "time_left", "team_production", + "create_task_frame", "create_visibilty_buttons", "update_leaderboard", "in_in_area" + } +} + +stds.factorio_base_data = { + globals = { + --Style + "make_cursor_box", "make_full_cursor_box", + "default_container_padding", "default_orange_color", "default_light_orange_color", "warning_red_color", + "achievement_green_color", "achievement_tan_color", "orangebuttongraphcialset", "bluebuttongraphcialset", + "bonus_gui_ordering", "trivial_smoke", "technology_slot_base_width", "technology_slot_base_height", "default_frame_font_vertical_compensation", + + --Belts + "transport_belt_connector_frame_sprites", "transport_belt_circuit_wire_connection_point", "transport_belt_circuit_wire_max_distance", + "transport_belt_circuit_connector_sprites", "ending_patch_prototype", "basic_belt_horizontal", "basic_belt_vertical", + "basic_belt_ending_top", "basic_belt_ending_bottom", "basic_belt_ending_side", "basic_belt_starting_top", "basic_belt_starting_bottom", + "basic_belt_starting_side", "fast_belt_horizontal", "fast_belt_vertical", "fast_belt_ending_top", "fast_belt_ending_bottom", + "fast_belt_ending_side", "fast_belt_starting_top", "fast_belt_starting_bottom", "fast_belt_starting_side", "express_belt_horizontal", + "express_belt_vertical", "express_belt_ending_top", "express_belt_ending_bottom", "express_belt_ending_side", "express_belt_starting_top", + "express_belt_starting_bottom", "express_belt_starting_side", + + --Circuit Connectors + "circuit_connector_definitions", "default_circuit_wire_max_distance", "inserter_circuit_wire_max_distance", + "universal_connector_template", "belt_connector_template", "belt_frame_connector_template", "inserter_connector_template", + + --Inserter Circuit Connectors + "inserter_circuit_wire_max_distance", "inserter_default_stack_control_input_signal", + + --Sounds/beams + "make_heavy_gunshot_sounds", "make_light_gunshot_sounds", "make_laser_sounds", + + --Gun/Laser + "gun_turret_extension", "gun_turret_extension_shadow", "gun_turret_extension_mask", "gun_turret_attack", + "laser_turret_extension", "laser_turret_extension_shadow", "laser_turret_extension_mask", + + --Pipes + "pipecoverspictures", "pipepictures", "assembler2pipepictures", "assembler3pipepictures", "make_heat_pipe_pictures", + + --Combinators + "generate_arithmetic_combinator", "generate_decider_combinator", "generate_constant_combinator", + + --Rail + "destroyed_rail_pictures", "rail_pictures", "rail_pictures_internal", "standard_train_wheels", "drive_over_tie", + "rolling_stock_back_light", "rolling_stock_stand_by_light", + + --Enemies + "make_enemy_autoplace", "make_enemy_spawner_autoplace", "make_enemy_worm_autoplace", + "make_spitter_attack_animation", "make_spitter_run_animation", "make_spitter_dying_animation", + "make_spitter_attack_parameters", "make_spitter_roars", "make_spitter_dying_sounds", + "make_spawner_idle_animation", "make_spawner_die_animation", + "make_biter_run_animation", "make_biter_attack_animation", "make_biter_die_animation", + "make_biter_roars", "make_biter_dying_sounds", "make_biter_calls", + "make_worm_roars", "make_worm_dying_sounds", "make_worm_folded_animation", "make_worm_preparing_animation", + "make_worm_prepared_animation", "make_worm_attack_animation", "make_worm_die_animation", + + --Other + "tile_variations_template", "make_water_autoplace_settings", + "make_unit_melee_ammo_type", "make_trivial_smoke", "make_4way_animation_from_spritesheet", "flying_robot_sounds", + "productivitymodulelimitation", "crash_trigger", "capsule_smoke", "make_beam", "playeranimations", + "make_blood_tint", "make_shadow_tint", + + --tiles + "water_transition_template", "make_water_transition_template", "water_autoplace_settings", "water_tile_type_names", + "patch_for_inner_corner_of_transition_between_transition", + } +} + +stds.factorio_base_story = { + globals = { + "story_init_helpers", "story_update_table", "story_init", "story_update", "story_on_tick", "story_add_update", + "story_remove_update", "story_jump_to", "story_elapsed", "story_elapsed_check", "story_show_message_dialog", + "set_goal", "player_set_goal", "on_player_joined", "flash_goal", "set_info", "player_set_info", "export_entities", + "list", "recreate_entities", "entity_to_connect", "limit_camera", "find_gui_recursive", "enable_entity_export", + "add_button", "on_gui_click", "set_continue_button_style", "add_message_log", "story_add_message_log", + "player_add_message_log", "message_log_frame", "message_log_scrollpane", "message_log_close_button", + "message_log_table", "toggle_message_log_button", "toggle_objective_button", "message_log_init", + "add_gui_recursive", "add_toggle_message_log_button", "add_toggle_objective_button", "mod_gui", + "flash_message_log_button", "flash_message_log_on_tick", "story_gui_click", "story_points_by_name", "story_branches", + "player", "surface", "deconstruct_on_tick", "recreate_entities_on_tick", "flying_congrats", "story_table" + } +} + +stds.factorio_circuit_connector_generated = { + globals = { + 'default_circuit_wire_max_distance', 'circuit_connector_definitions', 'universal_connector_template', + 'belt_connector_template', 'belt_frame_connector_template', 'inserter_connector_template', 'inserter_connector_template', + 'inserter_circuit_wire_max_distance', 'inserter_default_stack_control_input_signal', 'transport_belt_connector_frame_sprites', + 'transport_belt_circuit_wire_max_distance', + } +} + +--(( STDLIB ))-- +stds.stdlib = { + read_globals = { + table = { + fields = { + "map", "avg", "count_keys", "sum", "max", "remove", "insert", "invert", "first", "sort", "compare", "maxn", "any", "array_to_dictionary", + "each", "flatten", "keys", "filter", "remove_keys", "flexcopy", "find", "fullcopy", "values", "pack", "deepcopy", "concat", "clear", "min", + "is_empty", "merge", "size", "dictionary_merge", "unpack", "last" + }, + }, + string = { + fields = { + "is_space", "is_empty", "match", "title", "upper", "gmatch", "trim", "split", "len", "ordinal_suffix", "dump", "shorten", "reverse", + "ends_with", "byte", "starts_with", "join", "is_alpha", "lower", "is_upper", "is_digit", "is_alnum", "rjust", "center", "ljust", "format", + "char", "is_lower", "contains", "gsub", "find", "rep", "sub" + }, + }, + math = { + fields = { + "asin", "max", "modf", "midrange_mean", "pow", "ldexp", "maxuint16", "fmod", "round_to", "randomseed", "huge", "harmonic_mean", "tan", + "maxint32", "quadratic_mean", "pi", "energetic_mean", "minint8", "frexp", "generalized_mean", "rad", "sin", "sinh", "min", "geometric_mean", + "atan", "avg", "cosh", "maxint8", "arithmetic_mean", "exp", "sum", "round", "maxuint64", "minint64", "ceil", "maxint64", "atan2", "floor_to", + "floor", "log", "maxint16", "minint16", "tanh", "acos", "deg", "cos", "log10", "maxuint8", "abs", "weighted_mean", "random", "maxuint32", + "sqrt", "minint32" + } + }, + }, + globals = { + "prequire", "rawtostring", "traceback", "inspect", "serpent", "inline_if", + "GAME", "AREA", "POSITION", "TILE", "SURFACE", "CHUNK", "COLOR", "ENTITY", "INVENTORY", "RESOURCE", "CONFIG", "LOGGER", "QUEUE", + "EVENT", "GUI", "PLAYER", "FORCE", + "_STDLIB_NO_DEFINES_COLOR", "_STDLIB_NO_DEFINES_TIME", "_STDLIB_NO_STRING", "_STDLIB_NO_TABLE", "_STDLIB_NO_MATH" + } +} + +stds.stdlib_control = { +} + +stds.stdlib_data = { + globals = { + 'DATA', 'RECIPE', 'ITEM', 'FLUID', 'ENTITY', 'TECHNOLOGY', 'CATEGORY' + } +} --)) + +--(( FACTORIO DEFINES ))-- +stds.factorio_defines = { + globals = {"creative_mode_defines"}, + read_globals = { + defines = { + fields = { + events = { + fields = { + "on_tick", "on_gui_click", "on_gui_text_changed", "on_gui_checked_state_changed", "on_entity_died", "on_entity_damaged", "on_picked_up_item", + "on_built_entity", "on_sector_scanned", "on_player_mined_item", "on_put_item", "on_rocket_launched", "on_pre_player_mined_item", "on_chunk_generated", + "on_player_crafted_item", "on_robot_built_entity", "on_robot_pre_mined", "on_robot_mined", "on_research_started", "on_research_finished", + "on_player_rotated_entity", "on_marked_for_deconstruction", "on_canceled_deconstruction", "on_trigger_created_entity", "on_train_changed_state", + "on_player_created", "on_resource_depleted", "on_player_driving_changed_state", "on_force_created", "on_forces_merging", "on_player_cursor_stack_changed", + "on_pre_entity_settings_pasted", "on_entity_settings_pasted", "on_player_main_inventory_changed", "on_player_quickbar_inventory_changed", + "on_player_tool_inventory_changed", "on_player_armor_inventory_changed", "on_player_ammo_inventory_changed", "on_player_gun_inventory_changed", + "on_player_placed_equipment", "on_player_removed_equipment", "on_pre_player_died", "on_player_died", "on_player_respawned", "on_player_joined_game", + "on_player_left_game", "on_player_built_tile", "on_player_mined_tile", "on_robot_built_tile", "on_robot_mined_tile", "on_player_selected_area", + "on_player_alt_selected_area", "on_player_changed_surface", "on_selected_entity_changed", "on_market_item_purchased", "on_player_dropped_item", + "on_biter_base_built", "on_player_changed_force", "on_entity_renamed", "on_gui_selection_state_changed", "on_runtime_mod_setting_changed", + "on_difficulty_settings_changed", "on_surface_created", "on_surface_deleted", "on_pre_surface_deleted", "on_player_mined_entity", "on_robot_mined_entity", + "on_train_created", "on_gui_elem_changed", "on_player_setup_blueprint", "on_player_deconstructed_area", "on_player_configured_blueprint", "on_console_chat", + "on_console_command", "on_player_removed", "on_player_used_capsule", "script_raised_built", "script_raised_destroy", "script_raised_revive", + "on_player_promoted", "on_player_demoted", "on_combat_robot_expired", "on_player_changed_position", "on_mod_item_opened", "on_gui_opened", + "on_gui_closed", "on_gui_value_changed", "on_player_muted", "on_player_unmuted", "on_player_cheat_mode_enabled", "on_player_cheat_mode_disabled", + "on_character_corpse_expired", "on_pre_ghost_deconstructed", "on_player_pipette", "on_player_display_resolution_changed", "on_player_display_scale_changed", + "on_pre_player_crafted_item", "on_player_cancelled_crafting", "on_chunk_charted", "on_technology_effects_reset", "on_land_mine_armed", "on_forces_merged", + "on_player_trash_inventory_changed", + }, + }, + alert_type = { + fields = { + "custom", "entity_destroyed", "entity_under_attack", "no_material_for_construction", + "no_storage", "not_enough_construction_robots", "not_enough_repair_packs", "turret_fire", + }, + }, + chain_signal_state = { + fields = { + "all_open", "none", "none_open", "partially_open", + }, + }, + chunk_generated_status = { + fields = { + "basic_tiles", "corrected_tiles", "custom_tiles", "entities", "nothing", "tiles", + }, + }, + circuit_condition_index = { + fields = { + "arithmetic_combinator", "constant_combinator", "decider_combinator", "inserter_circuit", + "inserter_logistic", "lamp", "offshore_pump", "pump", + }, + }, + circuit_connector_id = { + fields = { + "accumulator", "combinator_input", "combinator_output", "constant_combinator", "container", + "electric_pole", "inserter", "lamp", "offshore_pump", "programmable_speaker", "pump", + "rail_signal", "roboport", "storage_tank", "wall", + }, + }, + command = { + fields = { + "attack", "attack_area", "build_base", "compound", "go_to_location", "group", "wander", + }, + }, + compound_command = { + fields = { + "logical_and", "logical_or", "return_last", + }, + }, + control_behavior = { + fields = { + inserter = { + fields = { + circuit_mode_of_operation = { + fields = { + "enable_disable", "none", "read_hand_contents", "set_filters", "set_stack_size", + }, + }, + hand_read_mode = { + fields = { + "hold", "pulse", + } + }, + }, + }, + lamp = { + fields = { + circuit_mode_of_operation = { + fields = { + "use_colors", + } + }, + }, + }, + logistic_container = { + fields = { + circuit_mode_of_operation = { + fields = { + "send_contents", "set_requests", + } + }, + }, + }, + mining_drill = { + fields = { + resource_read_mode = { + fields = { + "entire_patch", "this_miner", + } + }, + }, + }, + roboport = { + fields = { + circuit_mode_of_operation = { + fields = { + "read_logistics", "read_robot_stats", + } + }, + }, + }, + train_stop = { + fields = { + circuit_mode_of_operation = { + fields = { + "enable_disable", "read_from_train", "send_to_train", + } + }, + }, + }, + type = { + fields = { + "accumulator", "arithmetic_combinator", "constant_combinator", "container", + "decider_combinator", "generic_on_off", "inserter", "lamp", "logistic_container", + "rail_signal", "roboport", "storage_tank", "train_stop", "transport_belt", + }, + }, + }, + }, + controllers = { + fields = { + "character", "ghost", "god", + }, + }, + deconstruction_item = { + fields = { + entity_filter_mode = { + fields = { + "blacklist", "whitelist", + }, + }, + tile_filter_mode = { + fields = { + "always", "never", "normal", "only", + } + }, + }, + }, + difficulty = { + fields = { + "easy", "hard", "normal", + }, + }, + difficulty_settings = { + fields = { + recipe_difficulty = { + fields = { + "expensive", "normal", + }, + }, + technology_difficulty = { + fields = { + "expensive", "normal", + } + }, + }, + }, + direction = { + fields = { + "east", "north", "northeast", "northwest", "south", "southeast", "southwest", "west", + }, + }, + distraction = { + fields = { + "by_anything", "by_damage", "by_enemy", "none", + }, + }, + group_state = { + fields = { + "attacking_distraction", "attacking_target", "finished", "gathering", "moving", + }, + }, + gui_type = { + fields = { + "achievement", "blueprint_library", "bonus", "controller", "entity", "equipment", "item", + "kills", "logistic", "none", "other_player", "permissions", "production", "research", + "trains", "tutorials", "custom", + }, + }, + input_action = { + fields = { + "add_permission_group", "alt_select_area", "alt_select_blueprint_entities", "begin_mining", + "begin_mining_terrain", "build_item", "build_rail", "build_terrain", "cancel_craft", + "cancel_deconstruct", "cancel_new_blueprint", "cancel_research", "change_active_item_group_for_crafting", + "change_active_item_group_for_filters", "change_active_quick_bar", "change_arithmetic_combinator_parameters", + "change_blueprint_book_record_label", "change_decider_combinator_parameters", "change_item_label", + "change_picking_state", "change_programmable_speaker_alert_parameters", "change_programmable_speaker_circuit_parameters", + "change_programmable_speaker_parameters", "change_riding_state", "change_shooting_state", + "change_single_blueprint_record_label", "change_train_stop_station", "change_train_wait_condition", + "change_train_wait_condition_data", "clean_cursor_stack", "clear_blueprint", "clear_selected_blueprint", + "clear_selected_deconstruction_item", "connect_rolling_stock", "copy_entity_settings", "craft", + "craft_blueprint_record", "create_blueprint_like", "cursor_split", "cursor_transfer", "custom_input", + "cycle_blueprint_book_backwards", "cycle_blueprint_book_forwards", "deconstruct", "delete_blueprint_record", + "delete_custom_tag", "delete_permission_group", "disconnect_rolling_stock", "drop_blueprint_record", + "drop_item", "drop_to_blueprint_book", "edit_custom_tag", "edit_permission_group", "edit_train_schedule", + "export_blueprint", "fast_entity_split", "fast_entity_transfer", "grab_blueprint_record", "gui_checked_state_changed", + "gui_click", "gui_elem_selected", "gui_selection_state_changed", "gui_text_changed", "import_blueprint", + "import_blueprint_string", "inventory_split", "inventory_transfer", "launch_rocket", "market_offer", + "mod_settings_changed", "open_achievements_gui", "open_blueprint_library_gui", "open_blueprint_record", + "open_bonus_gui", "open_character_gui", "open_equipment", "open_gui", "open_item", "open_kills_gui", + "open_logistic_gui", "open_production_gui", "open_technology_gui", "open_train_gui", "open_train_station_gui", + "open_trains_gui", "open_tutorials_gui", "paste_entity_settings", "place_equipment", "remove_cables", + "reset_assembling_machine", "reverse_rotate_entity", "rotate_entity", "select_area", "select_blueprint_entities", + "select_entity_slot", "select_gun", "select_item", "select_tile_slot", "set_auto_launch_rocket", "set_autosort_inventory", + "set_behavior_mode", "set_blueprint_icon", "set_circuit_condition", "set_circuit_mode_of_operation", + "set_deconstruction_item_tile_selection_mode", "set_deconstruction_item_trees_only", "set_entity_color", + "set_entity_energy_property", "set_filter", "set_inserter_max_stack_size", "set_inventory_bar", "set_logistic_filter_item", + "set_logistic_filter_signal", "set_logistic_trash_filter_item", "set_research_finished_stops_game", "set_signal", + "set_single_blueprint_record_icon", "set_train_stopped", "set_use_item_groups", "setup_assembling_machine", + "setup_blueprint", "setup_single_blueprint_record", "shortcut_quick_bar_transfer", "smart_pipette", "stack_split", + "stack_transfer", "start_repair", "start_research", "start_walking", "switch_connect_to_logistic_network", + "switch_constant_combinator_state", "switch_power_switch_state", "switch_to_rename_stop_gui", "take_equipment", + "toggle_connect_center_back_tank", "toggle_connect_front_center_tank", "toggle_deconstruction_item_entity_filter_mode", + "toggle_deconstruction_item_tile_filter_mode", "toggle_driving", "toggle_enable_vehicle_logistics_while_moving", + "toggle_entity_on_off_state", "toggle_show_entity_info", "use_ability", "use_item", "wire_dragging", "write_to_console", + }, + }, + inventory = { + fields = { + "assembling_machine_input", "assembling_machine_modules", "assembling_machine_output", "beacon_modules", + "burnt_result", "car_ammo", "car_trunk", "cargo_wagon", "chest", "fuel", "furnace_modules", + "furnace_result", "furnace_source", "god_main", "god_quickbar", "item_main", "lab_input", "lab_modules", + "mining_drill_modules", "player_ammo", "player_armor", "player_guns", "player_main", "player_quickbar", + "player_tools", "player_trash", "player_vehicle", "roboport_material", "roboport_robot", "rocket_silo_result", + "rocket_silo_rocket", "turret_ammo", "rocket", "character_corpse" + }, + }, + logistic_member_index = { + fields = { + "character_provider", "character_requester", "character_storage", "generic_on_off_behavior", "logistic_container", "vehicle_storage", + }, + }, + logistic_mode = { + fields = { + "active_provider", "none", "passive_provider", "requester", "storage", "buffer" + }, + }, + mouse_button_type = { + fields = { + "left", "middle", "none", "right", + }, + }, + rail_connection_direction = { + fields = { + "left", "none", "right", "straight", + }, + }, + rail_direction = { + fields = { + "back", "front", + }, + }, + riding = { + fields = { + acceleration = { + fields = { + "accelerating", "braking", "nothing", "reversing", + }, + }, + direction = { + fields = { + "left", "right", "straight", + } + }, + }, + }, + shooting = { + fields = { + "not_shooting", "shooting_enemies", "shooting_selected", + }, + }, + signal_state = { + fields = { + "closed", "open", "reserved", "reserved_by_circuit_network", + }, + }, + train_state = { + fields = { + "arrive_signal", "arrive_station", "manual_control", "manual_control_stop", "no_path", "no_schedule", + "on_the_path", "path_lost", "stop_for_auto_control", "wait_signal", "wait_station", + }, + }, + transport_line = { + fields = { + "left_line", "left_split_line", "left_underground_line", "right_line", "right_split_line", "right_underground_line", + "secondary_left_line", "secondary_left_split_line", "secondary_right_line", "secondary_right_split_line", + }, + }, + wire_type = { + fields = { + "copper", "green", "red", + } + }, + -- Deprecated + colors = { + other_fields = true, + }, + -- Deprecated + anticolors = { + other_fields = true, + }, + -- Deprecated + lightcolors = { + other_fields = true, + }, + color = { + other_fields = true, + }, + anticolor = { + other_fields = true, + }, + lightcolor = { + other_fields = true, + }, + time = { + fields = { + "second", "minute", "hour", "day", "week", "month", "year", + } + }, + }, + } + } +} --)) + +--[[ + "ignore", "std", "globals", "unused_args", "self", "compat", "global", "unused", "redefined", + "unused_secondaries", "allow_defined", "allow_defined_top", "module", + "read_globals", "new_globals", "new_read_globals", "enable", "only", "not_globals", + "max_line_length", "max_code_line_length", "max_string_line_length", "max_comment_line_length", + "max_cyclomatic_complexity" +--]] + +-- Warnings list +-- 011 A syntax error. +-- 021 An invalid inline option. +-- 022 An unpaired inline push directive. +-- 023 An unpaired inline pop directive. +-- 111 Setting an undefined global variable. +-- 112 Mutating an undefined global variable. +-- 113 Accessing an undefined global variable. +-- 121 Setting a read-only global variable. +-- 122 Setting a read-only field of a global variable. +-- 131 Unused implicitly defined global variable. +-- 142 Setting an undefined field of a global variable. +-- 143 Accessing an undefined field of a global variable. +-- 211 Unused local variable. +-- 212 Unused argument. +-- 213 Unused loop variable. +-- 221 Local variable is accessed but never set. +-- 231 Local variable is set but never accessed. +-- 232 An argument is set but never accessed. +-- 233 Loop variable is set but never accessed. +-- 241 Local variable is mutated but never accessed. +-- 311 Value assigned to a local variable is unused. +-- 312 Value of an argument is unused. +-- 313 Value of a loop variable is unused. +-- 314 Value of a field in a table literal is unused. +-- 321 Accessing uninitialized local variable. +-- 331 Value assigned to a local variable is mutated but never accessed. +-- 341 Mutating uninitialized local variable. +-- 411 Redefining a local variable. +-- 412 Redefining an argument. +-- 413 Redefining a loop variable. +-- 421 Shadowing a local variable. +-- 422 Shadowing an argument. +-- 423 Shadowing a loop variable. +-- 431 Shadowing an upvalue. +-- 432 Shadowing an upvalue argument. +-- 433 Shadowing an upvalue loop variable. +-- 511 Unreachable code. +-- 512 Loop can be executed at most once. +-- 521 Unused label. +-- 531 Left-hand side of an assignment is too short. +-- 532 Left-hand side of an assignment is too long. +-- 541 An empty do end block. +-- 542 An empty if branch. +-- 551 An empty statement. +-- 611 A line consists of nothing but whitespace. +-- 612 A line contains trailing whitespace. +-- 613 Trailing whitespace in a string. +-- 614 Trailing whitespace in a comment. +-- 621 Inconsistent indentation (SPACE followed by TAB). +-- 631 Line is too long. diff --git a/.stickler.yml b/.stickler.yml new file mode 100644 index 00000000..91f8543c --- /dev/null +++ b/.stickler.yml @@ -0,0 +1,7 @@ +linters: + luacheck: + config: '.luacheckrc' +review: + # Don't use 'failure' build status when + # a pull request contains style errors. +fail_on_comments: true