question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

refactor(sdk): rename sdk package to api-client

See original GitHub issue

Description

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

  1. In the package.json file, the properties: name, main, browser, browserMinified, mainMinified properties are all updated
  2. 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
  3. Documentation is updated where necessary (the readme.md file of the package needs a looksie for sure)

cc: @RafaelAPB @sfuji822 @jonathan-m-hamilton @takeutak

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
petermetzcommented, Oct 29, 2020

@petermetz I have renamed the package and updated the required documentation. Raised a PR #314 for the same. Please review it. Thanks.

Great! Thank you so much @yash2189

1reaction
petermetzcommented, Oct 14, 2020

Thanks @petermetz yes I do not have much experience with typescript , Nodejs , lerna. I’ll surely visit the resources provided.

No worries @yash2189 another resource I can recommend is the local documentation in the CONTRIBUTING.md file and the BUILD.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!

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found