exercism / elixir-analyzer / 81bb2bd44c91598e28b337a76394d2632f36db5b

defmodule ElixirAnalyzer.Constants do

  @moduledoc """

  A list of Elixir analyzer comments, in the format:

  ```

  elixir.[directory].[filename]

  ```

  `[directory]` must correspond to a directory in https://github.com/exercism/website-copy/tree/main/analyzer-comments/elixir

  and `[filename].md` must be a file in that directory.

  """

  @constants [

    general_feedback_request: "elixir.general.feedback_request",

    # General Error Comments

    general_file_not_found: "elixir.general.file_not_found",

    general_parsing_error: "elixir.general.parsing_error",

    # General Solution Error / Warning Comments

    solution_use_moduledoc: "elixir.solution.use_module_doc",

    solution_use_specification: "elixir.solution.use_specification",

    solution_raise_fn_clause_error: "elixir.solution.raise_fn_clause_error",

    solution_module_attribute_name_snake_case: "elixir.solution.module_attribute_name_snake_case",

    solution_module_pascal_case: "elixir.solution.module_pascal_case",

    solution_function_name_snake_case: "elixir.solution.function_name_snake_case",

    solution_variable_name_snake_case: "elixir.solution.variable_name_snake_case",

    solution_indentation: "elixir.solution.indentation",

    solution_debug_functions: "elixir.solution.debug_functions",

    solution_last_line_assignment: "elixir.solution.last_line_assignment",

    solution_compiler_warnings: "elixir.solution.compiler_warnings",

    solution_def_with_is: "elixir.solution.def_with_is",

    solution_defguard_with_question_mark: "elixir.solution.defguard_with_question_mark",

    solution_defmacro_with_is_and_question_mark:

      "elixir.solution.defmacro_with_is_and_question_mark",

    solution_same_as_exemplar: "elixir.solution.same_as_exemplar",

    solution_list_prepend_head: "elixir.solution.list_prepend_head",

    solution_function_annotation_order: "elixir.solution.function_annotation_order",

    solution_no_integer_literal: "elixir.solution.no_integer_literal",

    solution_boilerplate_comment: "elixir.solution.boilerplate_comment",

    solution_todo_comment: "elixir.solution.todo_comment",

    solution_private_helper_functions: "elixir.solution.private_helper_functions",

    solution_unless_with_else: "elixir.solution.unless_with_else",

    solution_use_function_capture: "elixir.solution.use_function_capture",

    solution_deprecated_random_module: "elixir.solution.deprecated_random_module",

    solution_no_rescue: "elixir.solution.no_rescue",

    # Concept exercises

    # Basketball Website comments

    basketball_website_no_map: "elixir.basketball-website.no_map",

    basketball_website_get_in: "elixir.basketball-website.get_in",

    # Bird Count Comments

    bird_count_use_recursion: "elixir.bird-count.use_recursion",

    # Boutique Inventory Comments

    boutique_inventory_use_enum_sort_by: "elixir.boutique-inventory.use_enum_sort_by",

    boutique_inventory_use_enum_filter_or_enum_reject:

      "elixir.boutique-inventory.use_enum_filter_or_enum_reject",

    boutique_inventory_use_enum_map: "elixir.boutique-inventory.use_enum_map",

    boutique_inventory_use_enum_reduce: "elixir.boutique-inventory.use_enum_reduce",

    boutique_inventory_increase_quantity_best_function_choice:

      "elixir.boutique-inventory.increase_quantity_best_function_choice",

    # Boutique Suggestions Comments

    boutique_suggestions_use_list_comprehensions:

      "elixir.boutique-suggestions.use_list_comprehensions",

    # Chessboard Comments

    chessboard_function_reuse: "elixir.chessboard.function_reuse",

    chessboard_change_codepoint_to_string_directly:

      "elixir.chessboard.change_codepoint_to_string_directly",

    # Captains Log Comments

    captains_log_use_enum_random: "elixir.captains-log.use_enum_random",

    captains_log_do_not_use_enum_random: "elixir.captains-log.do_not_use_enum_random",

    captains_log_do_not_use_rand_uniform_real: "elixir.captains-log.do_not_use_rand_uniform_real",

    captains_log_use_rand_uniform: "elixir.captains-log.use_rand_uniform",

    captains_log_use_io_lib: "elixir.captains-log.use_io_lib",

    # Community Garden Comments

    community_garden_use_get_and_update: "elixir.community-garden.use_get_and_update",

    # Dancing Dots Comments

    dancing_dots_annotate_impl_animation: "elixir.dancing-dots.annotate_impl_animation",

    dancing_dots_do_not_reimplement_init: "elixir.dancing-dots.do_not_reimplement_init",

    # DNA Encoding Comments

    dna_encoding_use_recursion: "elixir.dna-encoding.use_recursion",

    dna_encoding_use_tail_call_recursion: "elixir.dna-encoding.use_tail_call_recursion",

    # File Sniffer Comments

    file_sniffer_use_bitstring: "elixir.file-sniffer.use_bitstring",

    # Freelancer Rates Comments

    freelancer_rates_apply_discount_function_reuse:

      "elixir.freelancer-rates.apply_discount_function_reuse",

    # German Sysadmin Comments

    german_sysadmin_no_string: "elixir.german-sysadmin.no_string",

    german_sysadmin_use_case: "elixir.german-sysadmin.use_case",

    # Gotta Snatch Em All Comments

    gotta_snatch_em_all_add_card_use_mapset_member_and_put:

      "elixir.gotta-snatch-em-all.add_card_use_mapset_member_and_put",

    gotta_snatch_em_all_trade_card_use_mapset_member_put_and_delete:

      "elixir.gotta-snatch-em-all.trade_card_use_mapset_member_put_and_delete",

    gotta_snatch_em_all_remove_duplicates_use_mapset_new:

      "elixir.gotta-snatch-em-all.remove_duplicates_use_mapset_new",

    gotta_snatch_em_all_remove_duplicates_use_enum_sort:

      "elixir.gotta-snatch-em-all.remove_duplicates_use_enum_sort",

    gotta_snatch_em_all_remove_duplicates_do_not_use_enum_uniq:

      "elixir.gotta-snatch-em-all.remove_duplicates_do_not_use_enum_uniq",

    gotta_snatch_em_all_extra_cards_use_mapset_difference_and_size:

      "elixir.gotta-snatch-em-all.extra_cards_use_mapset_difference_and_size",

    gotta_snatch_em_all_boring_cards_use_mapset_intersection:

      "elixir.gotta-snatch-em-all.boring_cards_use_mapset_intersection",

    gotta_snatch_em_all_boring_cards_use_enum_sort:

      "elixir.gotta-snatch-em-all.boring_cards_use_enum_sort",

    gotta_snatch_em_all_boring_cards_use_enum_reduce:

      "elixir.gotta-snatch-em-all.boring_cards_use_enum_reduce",

    gotta_snatch_em_all_total_cards_use_mapset_union_and_size:

      "elixir.gotta-snatch-em-all.total_cards_use_mapset_union_and_size",

    gotta_snatch_em_all_total_cards_use_enum_reduce:

      "elixir.gotta-snatch-em-all.total_cards_use_enum_reduce",

    gotta_snatch_em_all_split_shiny_cards_use_enum_sort:

      "elixir.gotta-snatch-em-all.shiny_cards_use_enum_sort",

    gotta_snatch_em_all_split_shiny_cards_use_string_starts_with:

      "elixir.gotta-snatch-em-all.shiny_cards_use_string_starts_with",

    # Guessing Game Comments

    guessing_game_use_default_argument: "elixir.guessing-game.use_default_argument",

    guessing_game_use_multiple_clause_functions:

      "elixir.guessing-game.use_multiple_clause_functions",

    guessing_game_use_guards: "elixir.guessing-game.use_guards",

    # High Score Comments

    high_score_use_module_attribute: "elixir.high-score.use_module_attribute",

    high_score_use_default_argument_with_module_attribute:

      "elixir.high-score.use_default_argument_with_module_attribute",

    high_score_use_map_update: "elixir.high-score.use_map_update",

    # High School Sweetheart Comments

    high_school_sweetheart_function_reuse: "elixir.high-school-sweetheart.function_reuse",

    high_school_sweetheart_multiline_string: "elixir.high-school-sweetheart.multiline_string",

    # Language List Comments

    language_list_do_not_use_enum: "elixir.language-list.do_not_use_enum",

    # Lasagna Comments

    lasagna_function_reuse: "elixir.lasagna.function_reuse",

    # Leap Comments

    leap_erlang_calendar: "elixir.leap.erlang_calendar",

    # Library Fees Comments

    library_fees_function_reuse: "elixir.library-fees.function_reuse",

    # Log Level Comments

    log_level_use_cond: "elixir.log-level.use_cond",

    # Name Badge Comments

    name_badge_use_if: "elixir.name-badge.use_if",

    # Need For Speed Comments

    need_for_speed_import_IO_with_only: "elixir.need-for-speed.import_IO_with_only",

    need_for_speed_import_ANSI_with_except: "elixir.need-for-speed.import_ANSI_with_except",

    need_for_speed_do_not_modify_code: "elixir.need-for-speed.do_not_modify_code",

    # Newsletter Comments

    newsletter_close_log_returns_implicitly: "elixir.newsletter.close_log_returns_implicitly",

    newsletter_log_sent_email_prefer_io_puts: "elixir.newsletter.log_sent_email_prefer_io_puts",

    newsletter_log_sent_email_returns_implicitly:

      "elixir.newsletter.log_sent_email_returns_implicitly",

    newsletter_send_newsletter_returns_implicitly:

      "elixir.newsletter.send_newsletter_returns_implicitly",

    newsletter_open_log_uses_option_write: "elixir.newsletter.open_log_uses_option_write",

    newsletter_send_newsletter_reuses_functions:

      "elixir.newsletter.send_newsletter_reuses_functions",

    # New Passport Comments

    new_passport_use_with: "elixir.new-passport.use_with",

    new_passport_use_with_else: "elixir.new-passport.use_with_else",

    new_passport_do_not_modify_code: "elixir.new-passport.do_not_modify_code",

    # Pacman Rules Comments

    pacman_rules_use_strictly_boolean_operators:

      "elixir.pacman-rules.use_strictly_boolean_operators",

    # Remote Control Car Comments

    remote_control_car_use_default_argument: "elixir.remote-control-car.use_default_argument",

    # RPG Character Sheet

    rpg_character_sheet_welcome_ends_with_IO_puts:

      "elixir.rpg-character-sheet.welcome_ends_with_IO_puts",

    rpg_character_sheet_run_uses_other_functions:

      "elixir.rpg-character-sheet.run_uses_other_functions",

    rpg_character_sheet_run_ends_with_IO_inspect:

      "elixir.rpg-character-sheet.ends_with_IO_inspect",

    rpg_character_sheet_IO_inspect_uses_label: "elixir.rpg-character-sheet.IO_inspect_uses_label",

    # RPN Calculator Inspection

    rpn_calculator_inspection_use_start_link: "elixir.rpn-calculator-inspection.use_start_link",

    # RPN Calculator Output

    rpn_calculator_output_try_rescue_else_after:

      "elixir.rpn-calculator-output.try_rescue_else_after",

    rpn_calculator_output_open_before_try: "elixir.rpn-calculator-output.open_before_try",

    rpn_calculator_output_write_in_try: "elixir.rpn-calculator-output.write_in_try",

    rpn_calculator_output_output_in_else: "elixir.rpn-calculator-output.output_in_else",

    rpn_calculator_output_close_in_after: "elixir.rpn-calculator-output.close_in_after",

    # Take A Number Comments

    take_a_number_do_not_use_abstractions: "elixir.take-a-number.do_not_use_abstractions",

    # Take A Number Deluxe Comments

    take_a_number_deluxe_use_genserver: "elixir.take-a-number-deluxe.use_genserver",

    take_a_number_deluxe_annotate_impl_genserver:

      "elixir.take-a-number-deluxe.annotate_impl_genserver",

    # Top Secret Comments

    top_secret_function_reuse: "elixir.top-secret.function_reuse",

    # Wine Cellar Comments

    wine_cellar_use_keyword_get_values: "elixir.wine-cellar.use_keyword_get_values",

    # Practice exercises

    # Accumulate Comments

    accumulate_use_recursion: "elixir.accumulate.use_recursion",

    # List Ops Comments

    list_ops_do_not_use_list_functions: "elixir.list-ops.do_not_use_list_functions",

    # Sieve Comments

    sieve_do_not_use_div_rem: "elixir.sieve.do_not_use_div_rem",

    #

    # Strain Comments

    strain_use_recursion: "elixir.strain.use_recursion",

    # Square Root Comments

    square_root_do_not_use_built_in_sqrt: "elixir.square-root.do_not_use_built_in_sqrt",

    # Two-fer Error Comments

    two_fer_use_default_parameter: "elixir.two-fer.use_default_param",

    two_fer_use_guards: "elixir.two-fer.use_guards",

    two_fer_use_string_interpolation: "elixir.two-fer.use_string_interpolation",

    two_fer_wrong_specification: "elixir.two-fer.wrong_specification",

    two_fer_use_function_level_guard: "elixir.two-fer.use_function_level_guard",

    two_fer_use_of_aux_functions: "elixir.two-fer.use_of_aux_functions",

    two_fer_use_of_function_header: "elixir.two-fer.use_of_function_header"

  ]

  for {constant, markdown} <- @constants do

  end

  def list_of_all_comments() do

  end

end