refactor(sdk): rename sdk package to api-client
See original GitHub issueDescription
As a developer I want to be able to quickly scan the packages available in the git repo so that I can get a better understanding of the architecture in a shorter time.
Currently we have a package named cactus-sdk
which is probably ambiguous with the project itself which we sometimes refer to as an SDK of SDKs
. That ambiguity could cause rational minds to question our terminology (yet again) since if the whole project is the
SDK then why do we have 10+ packages and only one of them called SDK.
Based on all this that we should rename the package from @hyperledger/cactus-sdk
to @hyperledger/cactus-api-client
which much better describes (narrower scope) what that package actually does.
Acceptance Criteria
- In the
package.json
file, the properties: name, main, browser, browserMinified, mainMinified properties are all updated - The references in all the other packages are also updated to import the new package instead of the old one (e.g. project must compile without issues
- Documentation is updated where necessary (the readme.md file of the package needs a looksie for sure)
Issue Analytics
- State:
- Created 3 years ago
- Comments:8 (8 by maintainers)
Top Results From Across the Web
Refactoring API client operation methods for better usability
This issue details how the v2 AWS SDK for Go's API client ... This refactor would rename these packages to have a api...
Read more >Rename Refactoring | IntelliJ Platform Plugin SDK
When the rename refactoring is performed, the method PsiNamedElement.setName() is called for the renamed element, and PsiReference.
Read more >Rename package in Android Studio - Stack Overflow
In the pop-up dialog, click on Rename Package instead of Rename Directory ... Android Studio will refactor the package name everywhere.
Read more >Generating a Typescript API client | by Krzysztof Rzymkowski
Generating a Typescript API client ... There's this moment when you're happily refactoring your backend and then you reach an endpoint method.
Read more >Rename package in Android Studio | Edureka Community
Right-click it · Select Refactor · Click on Rename · In the pop-up dialog, click on Rename Package instead of Rename Directory ·...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Great! Thank you so much @yash2189
No worries @yash2189 another resource I can recommend is the local documentation in the
CONTRIBUTING.md
file and theBUILD.md
file in this repo’s root folder. Plenty of useful explanation in both of those if you are a new to some concepts. It will also help you ensure that if you do submit a pull request it will be one that is easier to review/accept/merge. Thank you in advance!