Define status as struct #3
Conversation
- Define struct Status - Return list of status directly from Statuses module instead of reading a json file - add a function to return statuses as json
SimonLab
added
the
in-progress
Update Readme and mix.exs config file for package
Codecov Report
@@ Coverage Diff @@
## main #3 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 4 2 -2
=========================================
- Hits 4 2 -2
Continue to review full report at Codecov.
|
SimonLab
added
awaiting-review
| @@ -23,10 +23,6 @@ jobs: | |||
| path: deps | |||
| key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }} | |||
| restore-keys: ${{ runner.os }}-mix- | |||
| - name: Install Node.js Deps (JSON Lint) | |||
There was a problem hiding this comment.
As the PR doesn't have the json file, we don't need to install npm pacakage
| """ | ||
| @type t :: %Status{code: integer(), desc: String.t(), text: atom()} | ||
| @enforce_keys [:code, :desc, :text] | ||
| @derive Jason.Encoder |
There was a problem hiding this comment.
If you need to encode some struct that does not implement the protocol, if you own the struct, you can derive the implementation specifying which fields should be encoded to JSON
https://github.com/michalmuskala/jason#differences-to-poison
| Define the Status struct with desc, id and text key required | ||
| """ | ||
| @type t :: %Status{code: integer(), desc: String.t(), text: atom()} | ||
| @enforce_keys [:code, :desc, :text] |
There was a problem hiding this comment.
all the keys are required
| @doc """ | ||
| Returns the list of statuses as json | ||
| """ | ||
| def statuses_to_json(), do: Jason.encode!(get_statuses()) |
There was a problem hiding this comment.
Create a function to return json, I don't think we'll use it but I can see how it can be useful
There was a problem hiding this comment.
@SimonLab looks good. 👍
Detailed response in the issue: #4 (comment)
|
Package published to https://hex.pm/packages/statuses/1.1.0 📦 🚀 |
use Struct to define the list of statuses, remove json file and
File.readfunctionref: #4
@nelsonic let me know your thought on this,thanks