Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve build tools #252

Merged
merged 7 commits into from
Oct 11, 2022
Merged

Improve build tools #252

merged 7 commits into from
Oct 11, 2022

Conversation

petarvujovic98
Copy link
Contributor

Improve build tools in code documentation and comments
Rewrite build tools in TypeScript

Add in code documentation and comments for build tools.
Rewrite build tools in TypeScript
Change `tsconfig.json` configuration
Add explicit type annotations to assertion function so that tsc doesn't
complain
Improve log function performance by reducing number of iterations from 3
to 1
Make `env` declaration _const_ instead of _let_
Document utils exposed functions
Document provided types
Document high level promise API
Document most of environment API
Document decorators
Document collections
@petarvujovic98
Copy link
Contributor Author

petarvujovic98 commented Oct 7, 2022

@ailisp @volovyks I have added JSDoc (mentioned in #205) comments to most of the exposed API. Some utility functions like sha256 I have not documented yet, but most of the other APIs are covered including:

  • High and low level promise API
  • Storage API
  • Collections
  • Decorators
  • Utils
  • Custom types

Some minor performance optimizations have also been added within log function.

Undo incorrect formatting from 1n to 0n and 10 to 9
Undo incorrect `get` attached to curveType function
Copy link
Collaborator

@volovyks volovyks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work @petarvujovic98!
(linter has minor suggestions)

Copy link
Member

@ailisp ailisp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! This is a huge effort to complete almost all in-code documentation. Thank you!

@ailisp ailisp merged commit af2e5b8 into near:develop Oct 11, 2022
@ailisp ailisp mentioned this pull request Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants