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

Rename diagram-viewer into network-viewer #111

Merged
merged 3 commits into from
Nov 5, 2024
Merged

Conversation

flo-dup
Copy link
Contributor

@flo-dup flo-dup commented Nov 4, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?
No

What kind of change does this PR introduce?
Renaming

What is the current behavior?
powsybl-diagram-viewer / @powsybl/diagram-viewer

What is the new behavior (if this is a feature change)?
powsybl-network-viewer / @powsybl/network-viewer

Does this PR introduce a breaking change or deprecate an API?

  • Yes
  • No

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

What changes might users need to make in their application due to this PR? (migration steps)

'npm install @powsybl/network-viewer' instead of 'npm install @powsybl/diagram-viewer'

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
@flo-dup flo-dup added the Breaking change API is broken label Nov 4, 2024
@flo-dup flo-dup requested a review from etiennehomer November 4, 2024 17:24
Copy link
Contributor

@etiennehomer etiennehomer left a comment

Choose a reason for hiding this comment

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

We keep powsybl-diagram-viewer as sonar project key ? We change it ?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
Node from v18+ is required to build with Vite.

Installation using npm:
'npm install @powsybl/diagram-viewer'
'npm install @powsybl/network-viewer'
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a procedure to rename an npm package ? We should find a way to make projects using @powsybl/diagram-viewer move to @powsybl/network-viewer I guess

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems that you can't do that. But you could provide users with a deprecated message to tell them to use the new name: https://stackoverflow.com/questions/28371669/renaming-a-published-npm-module

Copy link
Contributor Author

Choose a reason for hiding this comment

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

npm deprecate my-project-name@"<= latest-version" "This project has been renamed. Install using new-project-name instead."

Co-authored-by: etiennehomer <etiennehomer@gmail.com>
Signed-off-by: Florian Dupuy <66690739+flo-dup@users.noreply.github.com>
@flo-dup
Copy link
Contributor Author

flo-dup commented Nov 5, 2024

We keep powsybl-diagram-viewer as sonar project key ? We change it ?

Right, we'd better change it. I'll change it in sonar, and then here.

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
@flo-dup flo-dup requested a review from etiennehomer November 5, 2024 09:42
Copy link

sonarqubecloud bot commented Nov 5, 2024

@flo-dup flo-dup merged commit 90823d3 into main Nov 5, 2024
5 checks passed
@flo-dup flo-dup deleted the rename_network_viewer branch November 5, 2024 09:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking change API is broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants