Skip to content

Improve (ba)sh usage, mainly in docs #634

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Improve (ba)sh usage, mainly in docs #634

wants to merge 3 commits into from

Conversation

fkobi
Copy link

@fkobi fkobi commented Jul 15, 2025

Every time that I have read the default readme I did not like the fact that generic shell commands were labeled as bash and I have changed it. After the third time I have decided to fix it upstream.

Also there are some minor improvements that are bash-related.
Everything is explained in the commit messages.

fkobi added 3 commits July 15, 2025 22:48
@fkobi
packages/create/scripts/update-template-repo.sh: use env
5d280db 
increases portability
@fkobi
packages/create/package.json: do not call bash excessively
cf3a2f6 
the script's shebang calls the shell already.
Right now a bash is called within a shell only to execute
the shebang, which in turn executes another shell.
@fkobi
*: use sh instead of bash for simple commands
f5ad79e 
These commands are not bash specific and the docs
should reflect that.

Also some bytes are saved.
@svelte-docs-bot
Copy link

Preview: https://svelte-dev-git-preview-cli-634-svelte.vercel.app/

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 15, 2025

⚠️ No Changeset found

Latest commit: f5ad79e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Jul 15, 2025

Open in StackBlitz

npx https://pkg.pr.new/sveltejs/cli/sv@634

npx https://pkg.pr.new/sveltejs/cli/svelte-migrate@634

commit: f5ad79e

@benmccann
Copy link
Member

Is there any difference between the way bash and sh is rendered? Could you share a screenshot of before and after?

I would guess https://github.com/sveltejs/svelte.dev might need to be updated as well if one is really preferable to the other

@fkobi
Copy link
Author

fkobi commented Jul 16, 2025

Is there any difference between the way bash and sh is rendered?

No, bash is (nearly) a superset of sh.
sh a general term for shell while bash is a specific shell with MANY extensions.
It makes sense to use the general one since no bash-specific features are used.

I would guess...

I can do that once this gets merged!

@manuel3108
Copy link
Member

Just to understand: Does this make a difference how tools display the syntax highligting? I just compared the current docs page, with this one here and im unable to find any difference. Apart from that, I think we should be good to go here.

@fkobi
Copy link
Author

fkobi commented Jul 21, 2025

Does this make a difference how tools display the syntax highligting?

It should not since bash is used on posix sh level.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fkobi @benmccann @manuel3108