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 crates to use underscores #895

Merged
merged 16 commits into from
Jun 15, 2022
Merged

Rename crates to use underscores #895

merged 16 commits into from
Jun 15, 2022

Conversation

cycraig
Copy link
Contributor

@cycraig cycraig commented Jun 14, 2022

Description of change

Renames all projects to use underscores for their package and directory names.

  • identity -> identity_iota
  • identity-account -> identity_account
  • identity-account-storage -> identity_account_storage
  • identity-core -> identity_core
  • identity-credential -> identity_credential
  • identity-did -> identity_did
  • identity-iota -> identity_iota_client
  • identity-iota-core -> identity_iota_core

NOTE: this excludes the identity-diff and identity-diff-derive packages since those names are already fixed.

Notably, the root package is now named identity_iota. The root module for identity_iota_client (formerly identity_iota) changed from ::iota to ::client.

Updated documentation wherever possible but may have missed something.

Links to any relevant issues

Part of #869.

Type of change

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Tests etc. seem to pass locally.

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@cycraig cycraig added Breaking change A change to the API that requires a major release. Part of "Changed" section in changelog Rust Related to the core Rust code. Becomes part of the Rust changelog. labels Jun 14, 2022
@cycraig cycraig self-assigned this Jun 14, 2022
@cycraig cycraig changed the title Rename projects to use underscores Rename crates to use underscores Jun 14, 2022
@cycraig cycraig added this to the v0.6 Features milestone Jun 14, 2022
Copy link
Contributor

@abdulmth abdulmth left a comment

Choose a reason for hiding this comment

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

Looks good, minor questions.

Cargo.toml Show resolved Hide resolved
bindings/wasm/Cargo.toml Outdated Show resolved Hide resolved
Copy link
Collaborator

@eike-hass eike-hass left a comment

Choose a reason for hiding this comment

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

Ran through builds, test and examples in the core and bindings. Everything seems ok.
I reviewed the workflows for any references to the old structure, everything looks good here as well.
Great job! Thank you 🙏

@eike-hass
Copy link
Collaborator

eike-hass commented Jun 15, 2022

Oh, one minor thing after running the stronghold-nodejs build locally the Cargo.lock of that project changed quite a bid. Does that change belong in this PR?

Edit: Had to npm link to the Wasm bindings to get the build working, but that should not affect the cargo dependencies.

@cycraig cycraig mentioned this pull request Jun 15, 2022
4 tasks
@cycraig cycraig merged commit 67f9581 into dev Jun 15, 2022
@cycraig cycraig deleted the chore/rename-crates branch June 15, 2022 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking change A change to the API that requires a major release. Part of "Changed" section in changelog Rust Related to the core Rust code. Becomes part of the Rust changelog.
Projects
Development

Successfully merging this pull request may close these issues.

4 participants