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

Update development.md, fix incorrect local development steps #2750

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

that-one-arab
Copy link
Contributor

@that-one-arab that-one-arab commented Jan 16, 2025

Fixes

Checks

  • Ran yarn test-build
  • Updated relevant documentations
  • Updated matching config options in altair-static

Changes proposed in this pull request:

Summary by Sourcery

Update local development instructions to use pnpm instead of yarn for managing dependencies, building the project, generating Chrome extension files, building Electron apps, and running tests. Add a pnpm bootstrap step to build local projects and compile JS into TS.

Enhancements:

  • Switch from yarn to pnpm for package management.

Documentation:

  • Update the local development documentation to reflect the switch from yarn to pnpm.

Copy link

sourcery-ai bot commented Jan 16, 2025

Reviewer's Guide by Sourcery

This PR updates the local development setup instructions in development.md to use pnpm instead of yarn.

Flow diagram for updated local development setup process

graph TD
    A[Start Development] --> B[pnpm install]
    B --> C[pnpm bootstrap]
    C --> D[pnpm start:app]
    D --> E[Access localhost:4200]

    subgraph Build Options
    F[pnpm build] --> G[dist/ directory]
    H[pnpm build-ext] --> I[chrome-extension/ directory]
    J[pnpm build-electron] --> K[electron-builds/ directory]
    L[pnpm test] --> M[Run all package tests]
    end
Loading

File-Level Changes

Change Details Files
Updated the package manager used for local development from yarn to pnpm.
  • Replaced yarn with pnpm for installing dependencies.
  • Added a step to run pnpm bootstrap to build local projects and ensure type compatibility.
  • Updated commands for starting the development server, building the project, generating Chrome extension files, building Electron apps, and running tests to use pnpm instead of yarn.
.github/development.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@that-one-arab that-one-arab changed the title Update development.md fix incorrect local development steps Update development.md, fix incorrect local development steps Jan 16, 2025
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @that-one-arab - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please fill out the PR template, particularly the 'Fixes #' section to reference the related issue.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Run `yarn start:app` to start the local dev server of the web app. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
Run `pnpm install` from the root of the repository to install dependencies.

Run `pnpm bootstrap` to build local projects, this is necessary to compile JS into TS and make sure types imported from other projects are accessible
Copy link

Choose a reason for hiding this comment

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

issue (typo): Typo: 'JS into TS' should be 'TS into JS'.

There seems to be a typo in this line. It should probably read 'TS into JS' instead of 'JS into TS'.

Suggested change
Run `pnpm bootstrap` to build local projects, this is necessary to compile JS into TS and make sure types imported from other projects are accessible
Run `pnpm bootstrap` to build local projects, this is necessary to compile TS into JS and make sure types imported from other projects are accessible

Copy link
Collaborator

@imolorhe imolorhe left a comment

Choose a reason for hiding this comment

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

Thanks

@imolorhe imolorhe added this pull request to the merge queue Jan 16, 2025
Merged via the queue into altair-graphql:master with commit 7c8745a Jan 16, 2025
2 checks passed
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.

2 participants