This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Export named import modules in `lib/format/index`, instead of defining namespaces in the corresponding submodules. - Where possible, favor importing from `lib/format` instead of submodules - Fix some trailing line whitespaces, etc., casualties of vim
- Use @gnd/typedoc for 3.6 compatibility and outstanding PR #1079 - Use typedoc module naming plugin - Use regular typedoc for that plugin
- Remove from lib/types/errors, add to lib/allocate/storage - Also remove an unused import - Update lib/index to reflect new location
New home! lib/decode/errors!
i.e. ContractBeingDecodedHasNoNodeError and ContractAllocationFailedError - Update usage accordingly in lib/interface/contract - Export in lib/interface/index
- Wrap in `Decoders` namespace for export in lib/interface/index - Mark constructors as private - Rename Truffle*Decoder to just *Decoder
- Add usage - Group format into Format module
haltman-at
approved these changes
Oct 17, 2019
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically just rubber-stamping this, we can review the rearrangements when coalescements
is PR'd.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See preview here
This PR introduces a Typedoc for the codec, as well as organizes the code a bit to make docs organization a bit easier/cleaner. Opening this as a draft, since, at least, the commits need some rebasing... or at most, we may want to continue to organize the code more before merging this.
Notes
Typedoc configuration
@gnd/typedoc
right now... I forked off TypeStrong/typedoc@09a37f2 and included support export-declaration TypeStrong/typedoc#1079. Not sure if 1079 is necessary, but support for TS v3.6.x is, and that hasn't been released to NPM yet.typedoc
dependency, as this is needed by typedoc plugins. This seems to work fine.lib/index-typedoc.ts
. This is the file that Typedoc loads to find what to document. Everything exported by that file, directly or indirectly, is considered "internal", namely... that's the public API.Code stuff
Types
,Values
, andErrors
. Instead, the respective modules have been imported with name inlib/format/index.ts
, and the rest of the codebase now favors importing directly fromlib/format
.lib/interface/decoders
and did a similar named re-export calledDecoders
.^Truffle
prefix for those class names.lib/types/decoding
orlib/types/interface
yet, but I think we ought to.Format
,Decoders
, andErrors
, but it'd be nice to think about how we can organize the other parts also. Note, this excludesforProject
and friends... I think those should be top-level.Considerations for work to do
lib/index-typedoc.ts
and just usinglib/index.ts
. We can use the@hidden
tag to hide things manually.lib/interface
? Can we make it more meaningful (like, make that the interface for real), or should we get rid of it?Other notes