refactor: introduce Document

[P0lip]

Checklist

• Tests added / updated
• Docs added / updated

Does this PR introduce a breaking change?

• Yes
• No

Additional context

Technically this is a breaking change, but I doubt anyone besides us actually passes IParsedResult, so we can consider it a fully Internal refactor that mostly addresses the issues with naming and makes certain parts of code a bit easier to reason about. not breaking anymore 😊

I'm not planning to make it a part of 5.0.

[philsturgeon]

I am a bit concerned about releasing breaking changes in 5.1, is this necessary? Could we hold it off for a while until we have some bigger features which might warrant a 6.0?

Or could it be made not breaking, by returning the thing we used to return too and deprecating it for now?

[P0lip]

Or could it be made not breaking, by returning the thing we used to return too and deprecating it for now?

Yeah, I can easily make it a non-breaking one and keep it like that.
The usage of that is mostly internal limited to Stoplight anyway, so users won't notice it, but I agree we should not be violating the our versioning model.

[philsturgeon]

Great ok!

…

On Mon, Dec 30, 2019 at 18:43, Marc MacLeod ***@***.***> wrote: @marbemac commented on this pull request. --------------------------------------------------------------- In [src/functions/unreferencedReusableObject.ts](#876 (comment)): > @@ -1,5 +1,6 @@ +import { isObject } from 'lodash'; Yeah it's not worth it - in order to make the lodash/isObject type syntax work, we'd have to use that syntax consistently everywhere, and hope that our dependencies do as well. Better to try to get tree shaking working, but even then it's not a huge difference in output bundle size. — You are receiving this because your review was requested. Reply to this email directly, [view it on GitHub](#876?email_source=notifications&email_token=AAAQONJVRCV2KJOP2VWXJN3Q3IXLFA5CNFSM4J6ZAPTKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCQMQQJQ#discussion_r362051001), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AAAQONJCS7XK3MRD2S3M4KTQ3IXLFANCNFSM4J6ZAPTA).