murielsilveira / json_feed_elixir Goto Github PK

Also wire it up on the CI to have a failing build if something is wrong.

As far as I understood there should be at least three use cases for this:

• Parse a JSON Feed input to Elixir structs
• Get a Feed struct and generate a JSON as output, see #4
• Validate if a JSON Feed is valid, see #1

Get a Feed struct and convert it into a JSON format.

Ideas:

• Don't include in the output not required attributes with default values

• Contributors info
• License
• Hex links
• Usage
• Coverage
• Examples
• ?

https://elixir-lang.org/getting-started/typespecs-and-behaviours.html

I'm not sure how this should work yet, but the idea is:

Make sure that a given incoming feed.json:

• has the required attributes
• has the correct attributes types
• has the correct attributes format
• therefore, is a valid feed ✅

api idea

defmodule Author do
  ...
  def is_valid() do
    # do the magic here
  end
end

Should use protocols for this?

Hook up on the CI and on the README