raine / ramda-cli

:ram: A CLI tool for processing data with functional pipelines
ISC License
573 stars 12 forks source link

readme.md #8

Open thurt opened 8 years ago

thurt commented 8 years ago

Hi @raine -- I read through the readme. Really liked your examples. Some comments:

  1. I think it is important to say that you have to use quotes '' for functions with arity greater than 1. But also, quotes aren't required when the function has arity 1.
  2. Also, I would have a paragraph at the beginning of the readme explaining the main livescript syntaxes you are using in the examples: function calls without parentheses, using single underscore _ for "gaps" in curried functions, and using dash-casing function names (using regular camelCasing also seems to works). I am not really familiar with livescript, so it would be helpful to say those specifics upfront before showing examples.
  3. Ramda function double underscore __ does not work for me. I assume this has to do with conflict with livescript singe underscore _?
  4. Add links for example dependencies Graphite, twarc.py
  5. The "credit card JSON to csv" example refers to a broken/unknown url
  6. In example "List a project's dependencies," I get error: the map-obj function is unknown. I do not see a mapObj function in the current Ramda documentation.

Edit: You may also want to add: I noticed in the case of csv, if there is an empty input value, it returns a property with a empty string (maybe that is obvious for other people?).

$ cat <<EOF | ramda --input-type csv id
,name
1, 
,Alice
EOF
[
  {
    "": "1",
    "name": ""
  },
  {
    "": "",
    "name": "Alice"
  }
]