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

docs: suggest biome migrate commands after biome init #2437

Merged
merged 1 commit into from
Apr 14, 2024

Conversation

Conaclos
Copy link
Member

@Conaclos Conaclos commented Apr 13, 2024

Summary

When biome init is executed the following message is printed:

❯ ./biome init

Welcome to Biome! Let's get you started...

Files created ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  - biome.json: Your project configuration. Documentation: https://biomejs.dev/reference/configuration

Next Steps ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  1. Setup an editor extension
     Get live errors as you type and format when you save. Learn more: https://biomejs.dev/guides/getting-started#editor-setup

  2. Try a command
     biome check verifies formatting and lint. Run biome --help for a full list of commands and options.

  3. Read the documentation
     Our website serves as a comprehensive source of guides and documentation: https://biomejs.dev

  4. Get involved in the community
     Ask questions, get support, or contribute by participating on GitHub (https://github.com/biomejs/biome),
     or join our community Discord (https://discord.gg/BypW39g6Yc)
❯ 

This PR:

  • Add a new item Migrate from ESLint and Prettier
  • Fix the hyperlink for the editor extension
  • Rephrase and add newlines to avoid line wrapping on small screen or in dual windows mode
  • Remove horizontal bars and inverse color: this looks cleaner and avoid line wrapping
  • A blank line at the end

Here is the result:

❯ ./biome init

Welcome to Biome! Let's get you started...

Files created 

  - biome.json
    Your project configuration. See https://biomejs.dev/reference/configuration

Next Steps 

  1. Setup an editor extension
     Get live errors as you type and format when you save.
     Learn more at https://biomejs.dev/guides/integrate-in-editor/

  2. Try a command
     biome check  checks formatting, import sorting, and lint rules.
     biome --help displays the available commands.

  3. Migrate from ESLint and Prettier
     biome migrate eslint   migrates your ESLint configuration to Biome.
     biome migrate prettier migrates your Prettier configuration to Biome.

  4. Read the documentation
     Find guides and documentation at https://biomejs.dev/guides/getting-started/

  5. Get involved with the community
     Ask questions and contribute on GitHub: https://github.com/biomejs/biome
     Seek for help on Discord: https://discord.gg/BypW39g6Yc

❯ 

Test Plan

CI should pass. I manually tested the command.

@Conaclos Conaclos requested review from a team April 13, 2024 16:26
@github-actions github-actions bot added the A-CLI Area: CLI label Apr 13, 2024
Copy link

netlify bot commented Apr 13, 2024

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 0419de2
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/661ae267e4aa0d00087f4c90
😎 Deploy Preview https://deploy-preview-2437--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (🟢 up 1 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 93 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@Conaclos Conaclos force-pushed the conaclos/biome-init-next-steps branch from 49add36 to bafb66a Compare April 13, 2024 16:29
Comment on lines 42 to 44
3. Migrate from ESLint and Prettier
biome migrate eslint attempts to migrate your ESLint configuration to Biome.
biome migrate prettier attempts to migrate your Prettier configuration to Biome.
Copy link
Member

Choose a reason for hiding this comment

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

We should have a resource (website page) that explains this better. A guide, maybe. Not a blocker but something we should prepare, I think.

Copy link
Member Author

@Conaclos Conaclos Apr 13, 2024

Choose a reason for hiding this comment

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

Yeah, I was thinking the same thing.

@Conaclos Conaclos force-pushed the conaclos/biome-init-next-steps branch 2 times, most recently from e645a7b to 0419de2 Compare April 13, 2024 19:52
@Conaclos Conaclos merged commit b7f69c8 into main Apr 14, 2024
16 checks passed
@Conaclos Conaclos deleted the conaclos/biome-init-next-steps branch April 14, 2024 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-CLI Area: CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants