Skip to content

Commit

Permalink
refactor: nextui-cli to heroui-cli (#129)
Browse files Browse the repository at this point in the history
* refactor: nextui-cli to heroui-cli

* fix: update nextui in codemod

* docs: update readme

* fix: update pkg

---------

Co-authored-by: Junior Garcia <[email protected]>
  • Loading branch information
winchesHe and jrgarciadev authored Jan 16, 2025
1 parent 9ed010d commit cf99755
Show file tree
Hide file tree
Showing 35 changed files with 419 additions and 1,132 deletions.
16 changes: 8 additions & 8 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ body:
value: |
Thank you for reporting an issue :pray:.
This issue tracker is for reporting bugs found in [NextUI CLI github repository](https://github.com/nextui-org/nextui-cli/)
This issue tracker is for reporting bugs found in [HeroUI CLI github repository](https://github.com/frontio-ai/heroui-cli/)
If you have a question about how to achieve something and are struggling, please post a question
inside of either of the following places:
- NextUI CLI's [Discussion's tab](https://github.com/nextui-org/nextui-cli/discussions)
- NextUI's [Discord channel](https://discord.gg/9b6yyZKmH4)
- HeroUI CLI's [Discussion's tab](https://github.com/frontio-ai/heroui-cli/discussions)
- HeroUI's [Discord channel](https://discord.gg/9b6yyZKmH4)


Before submitting a new bug/issue, please check the links below to see if there is a solution or question posted there already:
- NextUI CLI's [Issue's tab](https://github.com/nextui-org/nextui-cli/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)
- NextUI CLI's [closed issues tab](https://github.com/nextui-org/nextui-cli/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
- NextUI CLI's [Discussions tab](https://github.com/nextui-org/nextui-cli/discussions)
- HeroUI CLI's [Issue's tab](https://github.com/frontio-ai/heroui-cli/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)
- HeroUI CLI's [closed issues tab](https://github.com/frontio-ai/heroui-cli/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aclosed)
- HeroUI CLI's [Discussions tab](https://github.com/frontio-ai/heroui-cli/discussions)

The more information you fill in, the better the community can help you.
- type: input
id: version
attributes:
label: NextUI CLI Version
label: HeroUI CLI Version
description: |
Please provide the version of NextUI CLI you are using.
Please provide the version of HeroUI CLI you are using.
You can find the version number in the package.json file.
placeholder: ex. 0.1.4
validations:
Expand Down
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: 🤔 Long question or ideas?
url: https://github.com/nextui-org/nextui-cli/discussions
url: https://github.com/frontio-ai/heroui-cli/discussions
about: Ask long-form questions and discuss ideas.
- name: 💬 Discord Community Chat
url: https://discord.gg/9b6yyZKmH4
about: Ask quick questions or simply chat on the `NextUI` community Discord server.
about: Ask quick questions or simply chat on the `HeroUI` community Discord server.
- name: 💬 New Updates (Twitter)
url: https://twitter.com/getnextui
about: Link to our twitter account if you want to follow us and stay up to date with NextUI news
url: https://twitter.com/hero_ui
about: Link to our twitter account if you want to follow us and stay up to date with HeroUI news
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Feature request
title: "[Feature Request] YOUR_FEATURE_TITLE_HERE_REPLACE_ME"
labels: [feature request]
description: |
💡 Suggest an idea for the `NextUI CLI` project
💡 Suggest an idea for the `HeroUI CLI` project
Examples
- propose a new command
- improve an exiting features
Expand All @@ -12,7 +12,7 @@ body:
attributes:
value: |
This issue form is for requesting features only! For example, requesting a new command, behavior ... etc
If you want to report a bug, please use the [bug report form](https://github.com/nextui-org/nextui-cli/issues/new?assignees=&labels=&template=bug_report.yml).
If you want to report a bug, please use the [bug report form](https://github.com/frontio-ai/heroui-cli/issues/new?assignees=&labels=&template=bug_report.yml).
- type: textarea
validations:
required: true
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/sync.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ jobs:
git config --global user.name 'GitHub Action'
git config --global user.email '[email protected]'
- name: Clone nextui repository
- name: Clone heroui repository
run: |
git clone https://github.com/nextui-org/nextui nextui --depth 1
git clone https://github.com/frontio-ai/heroui-cli heroui --depth 1
- name: Run docs sync script
run: |
Expand All @@ -45,17 +45,17 @@ jobs:
VERSION=$(jq -r '.version' package.json)
echo "::set-output name=version::$VERSION"
- name: Commit changes to nextui repository
- name: Commit changes to heroui repository
run: |
cd nextui
cd heroui
git add .
git commit -m "docs: sync api from nextui-cli v${{ steps.get_version.outputs.version }}"
git commit -m "docs: sync api from heroui-cli v${{ steps.get_version.outputs.version }}"
- name: Create Pull Request
uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.PAT }}
path: nextui
path: heroui
branch: sync-docs-${{ steps.get_version.outputs.version }}-${{ github.run_id }}
title: "docs: sync api from nextui-cli v${{ steps.get_version.outputs.version }}"
body: Sync api from nextui-cli.
title: "docs: sync api from heroui-cli v${{ steps.get_version.outputs.version }}"
body: Sync api from heroui-cli.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
### Bug Fixes

- add command error in tailwind ([#80](https://github.com/nextui-org/nextui-cli/issues/80)) ([455d6e0](https://github.com/nextui-org/nextui-cli/commit/455d6e03ed33f2bba18cb5cd113966af0a7dc69f))
- upgrade command select option cannot select @nextui-org/react pkg ([#78](https://github.com/nextui-org/nextui-cli/issues/78)) ([93e5cdc](https://github.com/nextui-org/nextui-cli/commit/93e5cdc98299ec75d5720c0a6d44d08241c66dc7))
- upgrade command select option cannot select @heroui/react pkg ([#78](https://github.com/nextui-org/nextui-cli/issues/78)) ([93e5cdc](https://github.com/nextui-org/nextui-cli/commit/93e5cdc98299ec75d5720c0a6d44d08241c66dc7))

### Features

Expand Down
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# NextUI CLI Contributing Guide
# HeroUI CLI Contributing Guide

Hello!, I am very excited that you are interested in contributing with Next UI CLI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.
Hello!, I am very excited that you are interested in contributing with HeroUI CLI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.

- [Code of Conduct](https://github.com/nextui-org/nextui-cli/blob/main/CODE_OF_CONDUCT.md)
- [Code of Conduct](https://github.com/frontio-ai/heroui-cli/blob/main/CODE_OF_CONDUCT.md)
- [Pull Request Guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup)
- [Documentation](#documentation)
Expand Down Expand Up @@ -60,15 +60,15 @@ https://www.conventionalcommits.org/ or check out the

### Steps to PR

1. Fork of the nextui cli repository and clone your fork
1. Fork of the heroui cli repository and clone your fork

2. Create a new branch out of the `main` branch. We follow the convention
`[type/scope]`. For example `fix/dropdown-hook` or `docs/menu-typo`. `type`
can be either `docs`, `fix`, `feat`, `build`, or any other conventional
commit type. `scope` is just a short id that describes the scope of work.

3. Make and commit your changes following the
[commit convention](https://github.com/nextui-org/nextui-cli/blob/main/CONTRIBUTING.md#commit-convention).
[commit convention](https://github.com/frontio-ai/heroui-cli/blob/main/CONTRIBUTING.md#commit-convention).
As you develop, you can run `pnpm lint` and
`pnpm build` e.g. `pnpm lint && pnpm build` to make sure everything works as expected.

Expand All @@ -92,7 +92,7 @@ After cloning the repository, execute the following commands in the root folder:
2. Run dev to start development

```bash
## Start the dev babel server of NextUI CLI
## Start the dev babel server of HeroUI CLI
pnpm dev
```

Expand All @@ -115,7 +115,7 @@ After cloning the repository, execute the following commands in the root folder:
```bash
## make sure pnpm dev is running
npm link
## then run nextui-cli locally and test
## then run heroui-cli locally and test
```

> Note: ensure your version of Node is 18.17.x or higher to run scripts
Expand All @@ -136,15 +136,15 @@ After cloning the repository, execute the following commands in the root folder:

Please update the docs with any command changes, the code and docs should always be in sync.

The main documentation lives in `https://nextui.org/docs/guide/cli`, please create a PR in `nextui-org/nextui` instead.
The main documentation lives in `https://heroui.com/docs/guide/cli`, please create a PR in `frontio-ai/heroui` instead.

## Breaking changes

Breaking changes should be accompanied with deprecations of removed functionality. The deprecated changes themselves should not be removed until the minor release after that.

## Becoming a maintainer

If you are interested in becoming a NextUI maintainer, start by
If you are interested in becoming a HeroUI maintainer, start by
reviewing issues and pull requests. Answer questions for those in need of
troubleshooting. Join us in the
[Discord Community](https://discord.gg/9b6yyZKmH4) chat room.
Expand All @@ -155,7 +155,7 @@ best to be proactive in reaching out to those that are already helping out.
GitHub by default does not publicly state that you are a member of the
organization. Please feel free to change that setting for yourself so others
will know who's helping out. That can be configured on the [organization
list](https://github.com/orgs/nextui-org/people) page.
list](https://github.com/orgs/frontio-ai/people) page.

Being a maintainer is not an obligation. You can help when you have time and be
less active when you don't. If you get a new job and get busy, that's alright.
Loading

0 comments on commit cf99755

Please sign in to comment.