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.

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

Suggestion: Modifications to the scripts in package.json are necessary for Windows compatibility. #113

Closed
gyunseo opened this issue Sep 12, 2023 · 4 comments
Closed

Suggestion: Modifications to the scripts in package.json are necessary for Windows compatibility. #113

gyunseo opened this issue Sep 12, 2023 · 4 comments

Comments

@gyunseo
Copy link

gyunseo commented Sep 12, 2023 •
edited
Loading

npm run dev contains the bash(or zsh, fish etc) & operator, which is not compatible with Windows Powershell. It would be good to add the concurrently package to dev dependencies and make the following changes.

"dev": "concurrently --raw --kill-others \"astro check --watch\" \"astro dev\"",
@gyunseo gyunseo changed the title Modifications to the scripts in package.json are necessary for Windows compatibility. Suggestion: Modifications to the scripts in package.json are necessary for Windows compatibility. Sep 12, 2023
@satnaing
Copy link
Owner

satnaing commented Sep 15, 2023 •
edited
Loading

Thanks for your suggestion! ✌🏻

So Windows Powershell users can only run the dev with your changes? Didn't know that.
BTW, what else did you encounter running AstroPaper?

@gyunseo
Copy link
Author

gyunseo commented Sep 16, 2023 •
edited
Loading

@satnaing thanks for reply 👯‍♂️.
The & operator in Windows PowerShell operates differently than in the Bash Shell, so I believe using the concurrently package for parallel execution is the best option.

You can check out concurrently package here

@satnaing
Copy link
Owner

So, currently, I'm thinking of two options.

  1. Add a section in docs and README for Windows PowerShell users, with a warning about running the script, and an explanation of what should be done to run the project.
  2. Add concurrently package as a dev dep in the project and run with concurrently for all users.

If there are no significant issues other than running multiple commands concurrently for PowerShell users, I prefer the first option. If not, might consider the 2nd option.
Any thoughts on this?

@gyunseo
Copy link
Author

gyunseo commented Sep 18, 2023

@satnaing I think option 1 is good :)

satnaing added a commit that referenced this issue Sep 24, 2023
@satnaing
docs: update README for v3
0cafe8d 
Update file structure section. Add concurrent command running method for Windows PowerShell users.
Update footer credit to acknowledge the contributions of other contributors.

resolve #113
@gyunseo gyunseo closed this as completed Sep 24, 2023
satnaing added a commit that referenced this issue Sep 25, 2023
@satnaing
docs: update README for v3
192e90a 
Update file structure section. Add concurrent command running method for Windows PowerShell users.
Update footer credit to acknowledge the contributions of other contributors.

resolve #113
satnaing added a commit that referenced this issue Sep 25, 2023
@satnaing
docs: update README for v3
186bc15 
Update file structure section. Add concurrent command running method for Windows PowerShell users.
Update footer credit to acknowledge the contributions of other contributors.

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

No branches or pull requests
3 participants
@gyunseo @satnaing and others