Skip to content

Add init task #1681

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

Merged
esimkowitz merged 2 commits into from
Jan 5, 2025
Merged

Add init task #1681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b77459
Add init task
esimkowitz Jan 3, 2025
3364ed0
revert yarn.lock
esimkowitz Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,14 @@ or
git clone https://github.com/wavetermdev/waveterm.git
```

## Install code dependencies

The first time you clone the repo, you'll need to run the following to load the dependencies. If you ever have issues building the app, try running this again:

```sh
task init
```

## Build and Run

All the methods below will install Node and Go dependencies when they run the first time. All these should be run from within the Git repository.
Expand Down
7 changes: 7 additions & 0 deletions Taskfile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,13 @@ tasks:
- task: dev:cleardata:linux
- task: dev:cleardata:macos

init:
desc: Initialize the project for development.
cmds:
- yarn
- go mod tidy
- cd docs && yarn

Comment on lines +324 to +330
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 3, 2025

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Refactor to use existing tasks and improve reliability

The task implementation could be improved by:

  1. Leveraging existing internal tasks instead of duplicating commands
  2. Adding proper error handling for directory changes
     init:
         desc: Initialize the project for development.
         cmds:
-            - yarn
-            - go mod tidy
-            - cd docs && yarn
+            - task: yarn
+            - task: go:mod:tidy
+            - task: copyfiles:'package.json':'docs/'
+            - dir: docs
+              cmd: yarn

This refactor:

  • Uses existing internal tasks to maintain consistency
  • Improves reliability by properly handling directory context
  • Ensures each command runs in the correct directory

Committable suggestion skipped: line range outside the PR's diff.

dev:cleardata:windows:
internal: true
platforms: [windows]
Expand Down
Loading