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

chore: converts watch and init commands to clack #6346

Conversation

lemusthelroy
Copy link
Contributor

@lemusthelroy lemusthelroy commented Jan 24, 2024

πŸŽ‰ Thanks for submitting a pull request! πŸŽ‰

Summary

Converts watch and init commands to clack. Also, adjusts styling for the outro of unlinking.

Watch, where you link to existing site:
image

Watch, where site already linked:
image

Watch, where site gets created:
image

Link:
image

Also contains guidance so we avoid having multiple intros and outros like this:
image

For us to review and ship your PR efficiently, please perform the following steps:

  • Open a bug/issue before writing your code πŸ§‘β€πŸ’». This ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or something that`s on fire πŸ”₯ (e.g. incident related), you can skip this step.
  • Read the contribution guidelines πŸ“–. This ensures your code follows our style guide and
    passes our tests.
  • Update or add tests (if any source code was changed or added) πŸ§ͺ
  • Update or add documentation (if features were changed or added) πŸ“
  • Make sure the status checks below are successful βœ…

A picture of a cute animal (not mandatory, but encouraged)

@lemusthelroy lemusthelroy changed the title chore: converts watch and link commands to clack chore: converts watch and init commands to clack Jan 24, 2024
@lemusthelroy
Copy link
Contributor Author

Only TODO left on this is to ensure the site creation path for the init route is converted to clack

@lemusthelroy lemusthelroy marked this pull request as ready for review January 26, 2024 12:51
@lemusthelroy lemusthelroy requested a review from a team as a code owner January 26, 2024 12:51
Copy link
Contributor

@ericapisani ericapisani left a comment

Choose a reason for hiding this comment

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

Small grammatical things here and there but otherwise good.

One thing that I'm not sure about though is the need for exit: true to be passed in all over the place with the use of the outro method.

Is this something that we'd always want to have happen? If so, could we expose a helper method that allows a user to call outro with the message and we automatically pass in exit: true?

STYLEGUIDE.md Outdated Show resolved Hide resolved
@@ -29,13 +47,37 @@ import { intro, outro } from '../../utils/styles/index.js'
export const basicCommand = () => {
intro('basic command')
// do stuff
outro()
outro({ message: 'Your message', exit: true })
Copy link
Contributor

Choose a reason for hiding this comment

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

If exit: true were not passed, what would happen?

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 would just print the outro message. I think the signature of this was updated recently so this just updates it to the current signature. I am intrigued as to whether exit should always just happen otherwise clack will just look weird, but will probably tackle that separately.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree with your other comment on the outro bit. Will circle back to that as I agree

STYLEGUIDE.md Outdated Show resolved Hide resolved
STYLEGUIDE.md Outdated Show resolved Hide resolved
src/commands/init/init.ts Outdated Show resolved Hide resolved
lemusthelroy and others added 4 commits January 26, 2024 14:31
Co-authored-by: Erica Pisani <pisani.erica@gmail.com>
Co-authored-by: Erica Pisani <pisani.erica@gmail.com>
Co-authored-by: Erica Pisani <pisani.erica@gmail.com>
Co-authored-by: Erica Pisani <pisani.erica@gmail.com>
@lemusthelroy lemusthelroy merged commit 28ae1ed into CP-101/design-system-clack-implementation Jan 26, 2024
28 of 30 checks passed
@lemusthelroy lemusthelroy deleted the lemusthelroy/ct-487-convert-watch-command-to-clack branch January 26, 2024 14:49
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.

None yet

2 participants