Typescript Typings

[alixaxel]

Closes #16

[codecov]

Codecov Report

Merging #17 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master    #17   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           5      5           
  Lines         196    196           
  Branches       55     55           
=====================================
  Hits          196    196

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d74a30f...a870a92. Read the comment docs.

[codecov]

Codecov Report

Merging #17 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master    #17   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           5      5           
  Lines         196    196           
  Branches       55     55           
=====================================
  Hits          196    196

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d74a30f...0a667f6. Read the comment docs.

[fent]

Looks good, would prefer if the file was placed in a typings folder to keep things more organized.

In another topic slightly related to types but not to this PR, looking over the API, I feel like having both options and stack for ROOT and GROUP types is a bit confusing. Maybe we should only have one of them, and if the group doesn't have a pipe, then the field is still an array of array of tokens, but the array should contain only one list? What do you think?

[alixaxel]

@fent

Looks good, would prefer if the file was placed in a typings folder to keep things more organized.

Sure thing.

if the group doesn't have a pipe, then the field is still an array of array of tokens

I think it's a good decision. That's exactly what I do to simplify follow up code too.

  if (tokens.type === ret.types.ROOT || tokens.type === ret.types.GROUP) {
    if (tokens.hasOwnProperty('options') !== true) {
      tokens.options = [tokens.stack];
    }

Do you want the typings in to reflect this new 2-dimensional array stack?

[fent]

Do you want the typings in to reflect this new 2-dimensional array stack?

Well what I was planning to do was something like your code. Keep options and remove stack. Or actually, keep stack around for a short while to support backwards compatibility.

But anyway, I can make the change to typings when I make the code changes.

[alixaxel]

@fent Just following up on this.

Do you want me to change this to the typings folder without the options/stack changes?

[fent]

Yep, I was waiting on that before reviewing

[alixaxel]

@fent Ah, some misunderstanding on my part, just pushed it. 😄

[fent]

Thanks!

[alixaxel]

After deleting my local typings for ret and installing 0.3.0, it's no longer able to find the typings:

[alixaxel]

@fent While moving the typings into typings directory, I forgot to specify it should also be bundled with the package. 😕 Sorry about that! I submitted #19 to address this.