From d7626ddc5f9884d9b5cdfebf74d2fd46e86941c7 Mon Sep 17 00:00:00 2001 From: Kieran Eglin Date: Tue, 12 Mar 2024 10:45:50 -0700 Subject: [PATCH] Added a module naming check; moved things around --- .credo.exs | 11 ++++++++++- lib/pinchflat/{ => media}/media.ex | 0 lib/pinchflat/media/media_items_search_index.ex | 2 +- lib/pinchflat/{ => profiles}/profiles.ex | 0 lib/pinchflat/{ => settings}/settings.ex | 0 lib/pinchflat/{ => sources}/sources.ex | 0 lib/pinchflat/{ => tasks}/tasks.ex | 0 mix.exs | 1 + mix.lock | 1 + test/pinchflat/metadata/metadata_parser_test.exs | 2 +- 10 files changed, 14 insertions(+), 3 deletions(-) rename lib/pinchflat/{ => media}/media.ex (100%) rename lib/pinchflat/{ => profiles}/profiles.ex (100%) rename lib/pinchflat/{ => settings}/settings.ex (100%) rename lib/pinchflat/{ => sources}/sources.ex (100%) rename lib/pinchflat/{ => tasks}/tasks.ex (100%) diff --git a/.credo.exs b/.credo.exs index f5085d3..8b4586a 100644 --- a/.credo.exs +++ b/.credo.exs @@ -157,7 +157,16 @@ {Credo.Check.Warning.UnusedRegexOperation, []}, {Credo.Check.Warning.UnusedStringOperation, []}, {Credo.Check.Warning.UnusedTupleOperation, []}, - {Credo.Check.Warning.WrongTestFileExtension, []} + {Credo.Check.Warning.WrongTestFileExtension, []}, + + # + ## Naming Checks + # + {CredoNaming.Check.Consistency.ModuleFilename, + [ + priority: :normal, + excluded_paths: [~r/test\/support/, ~r/priv/, ~r/lib\/pinchflat_web/, ~r/test\/pinchflat_web/] + ]} ], disabled: [ # diff --git a/lib/pinchflat/media.ex b/lib/pinchflat/media/media.ex similarity index 100% rename from lib/pinchflat/media.ex rename to lib/pinchflat/media/media.ex diff --git a/lib/pinchflat/media/media_items_search_index.ex b/lib/pinchflat/media/media_items_search_index.ex index c55d787..623b5fb 100644 --- a/lib/pinchflat/media/media_items_search_index.ex +++ b/lib/pinchflat/media/media_items_search_index.ex @@ -1,4 +1,4 @@ -defmodule Pinchflat.Media.MediaItemSearchIndex do +defmodule Pinchflat.Media.MediaItemsSearchIndex do @moduledoc """ The MediaItem fts5 search index. Not made to be directly interacted with, but I figured it'd be better to have it in-app so it's not a mystery. diff --git a/lib/pinchflat/profiles.ex b/lib/pinchflat/profiles/profiles.ex similarity index 100% rename from lib/pinchflat/profiles.ex rename to lib/pinchflat/profiles/profiles.ex diff --git a/lib/pinchflat/settings.ex b/lib/pinchflat/settings/settings.ex similarity index 100% rename from lib/pinchflat/settings.ex rename to lib/pinchflat/settings/settings.ex diff --git a/lib/pinchflat/sources.ex b/lib/pinchflat/sources/sources.ex similarity index 100% rename from lib/pinchflat/sources.ex rename to lib/pinchflat/sources/sources.ex diff --git a/lib/pinchflat/tasks.ex b/lib/pinchflat/tasks/tasks.ex similarity index 100% rename from lib/pinchflat/tasks.ex rename to lib/pinchflat/tasks/tasks.ex diff --git a/mix.exs b/mix.exs index c5cada2..837ce87 100644 --- a/mix.exs +++ b/mix.exs @@ -59,6 +59,7 @@ defmodule Pinchflat.MixProject do {:nimble_parsec, "~> 1.4"}, {:mox, "~> 1.0", only: :test}, {:credo, "~> 1.7", only: [:dev, :test], runtime: false}, + {:credo_naming, "~> 2.1", only: [:dev, :test], runtime: false}, {:ex_check, "~> 0.14.0", only: [:dev, :test], runtime: false}, {:faker, "~> 0.17", only: :test}, {:sobelow, "~> 0.13", only: [:dev, :test], runtime: false} diff --git a/mix.lock b/mix.lock index e4f4777..5599358 100644 --- a/mix.lock +++ b/mix.lock @@ -6,6 +6,7 @@ "cowboy_telemetry": {:hex, :cowboy_telemetry, "0.4.0", "f239f68b588efa7707abce16a84d0d2acf3a0f50571f8bb7f56a15865aae820c", [:rebar3], [{:cowboy, "~> 2.7", [hex: :cowboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "7d98bac1ee4565d31b62d59f8823dfd8356a169e7fcbb83831b8a5397404c9de"}, "cowlib": {:hex, :cowlib, "2.12.1", "a9fa9a625f1d2025fe6b462cb865881329b5caff8f1854d1cbc9f9533f00e1e1", [:make, :rebar3], [], "hexpm", "163b73f6367a7341b33c794c4e88e7dbfe6498ac42dcd69ef44c5bc5507c8db0"}, "credo": {:hex, :credo, "1.7.3", "05bb11eaf2f2b8db370ecaa6a6bda2ec49b2acd5e0418bc106b73b07128c0436", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "35ea675a094c934c22fb1dca3696f3c31f2728ae6ef5a53b5d648c11180a4535"}, + "credo_naming": {:hex, :credo_naming, "2.1.0", "d44ad58890d4db552e141ce64756a74ac1573665af766d1ac64931aa90d47744", [:make, :mix], [{:credo, "~> 1.6", [hex: :credo, repo: "hexpm", optional: false]}], "hexpm", "830e23b3fba972e2fccec49c0c089fe78c1e64bc16782a2682d78082351a2909"}, "db_connection": {:hex, :db_connection, "2.6.0", "77d835c472b5b67fc4f29556dee74bf511bbafecdcaf98c27d27fa5918152086", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "c2f992d15725e721ec7fbc1189d4ecdb8afef76648c746a8e1cad35e3b8a35f3"}, "decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"}, "dns_cluster": {:hex, :dns_cluster, "0.1.2", "3eb5be824c7888dadf9781018e1a5f1d3d1113b333c50bce90fb1b83df1015f2", [:mix], [], "hexpm", "7494272040f847637bbdb01bcdf4b871e82daf09b813e7d3cb3b84f112c6f2f8"}, diff --git a/test/pinchflat/metadata/metadata_parser_test.exs b/test/pinchflat/metadata/metadata_parser_test.exs index dfbca03..a18444e 100644 --- a/test/pinchflat/metadata/metadata_parser_test.exs +++ b/test/pinchflat/metadata/metadata_parser_test.exs @@ -1,4 +1,4 @@ -defmodule Pinchflat.YtDlp.MediaParserTest do +defmodule Pinchflat.Metadata.MetadataParserTest do use Pinchflat.DataCase alias Pinchflat.Metadata.MetadataParser, as: Parser