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

feat: rename tutorialkit to @tutorialkit/cli #153

Merged
merged 3 commits into from
Aug 6, 2024

Conversation

AriPerkkio
Copy link
Member

@AriPerkkio AriPerkkio commented Jul 18, 2024

  • Renames npm package tutorialkit to @tutorialkit/cli
  • Adds some documentation to CONTRIBUTING.md about package naming convention. This is mostly related to development time communication practices and doesn't affect end users.
  • Renames (internally) tutorialkit-vscode to tutorialkit. Removes work-around from build script that was used to do this renaming right before publishing. This name is already used by the published extension.

BREAKING CHANGES:

  • tutorialkit npm package is now unused. We should probably deprecate that from npm? Or just leave it as is.
  • Adds new package @tutorialkit/cli. This package does not yet exist in npm. I'm not sure if publishing this package will work without any permission settings. Do we need to add https://www.npmjs.com/~stackblitz-devops there some how?

Copy link

stackblitz bot commented Jul 18, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@Nemikolh
Copy link
Member

Adds new package @tutorialkit/cli. This package does not yet exist in npm

This package used to exist, I think we might have cleaned the alpha versions that we had published for testing. Hopefully that won't be a problem.

Copy link
Member

@Nemikolh Nemikolh 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! Love the cleanup as well 🤗

CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@AriPerkkio
Copy link
Member Author

I think this is actually not a breaking change as CLI packages are not installed by end-users. I'll resolve the conflicts and then we can merged this.

@Nemikolh
Copy link
Member

Nemikolh commented Aug 6, 2024

Yeah I agree, let's move forward with this PR 👍

@AriPerkkio AriPerkkio merged commit 2986157 into stackblitz:main Aug 6, 2024
9 checks passed
@AriPerkkio AriPerkkio deleted the feat/rename-cli branch August 6, 2024 10:52
@AriPerkkio AriPerkkio changed the title feat!: rename tutorialkit to @tutorialkit/cli feat: rename tutorialkit to @tutorialkit/cli Aug 6, 2024
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.

2 participants