Skip to content

Replace npm with pnpm #136

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
merged 3 commits into from
Dec 19, 2024
Merged

Replace npm with pnpm #136

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39133b7
Setup pnpm
techniq Dec 18, 2024
02779d3
Update `built.sbt` to use pnpm
techniq Dec 19, 2024
11f662a
fix: pnpm style overrides
ken-zlai Dec 19, 2024
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
32 changes: 16 additions & 16 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The frontend for Chronon.
### Prerequisites

- [Node.js](https://nodejs.org/en/) (LTS version recommended)
- npm (comes with Node.js)
- [pnpm](https://pnpm.io/installation) - fast and disk space efficient package manager

### Installation

Expand All @@ -26,7 +26,7 @@ The frontend for Chronon.

3. Install dependencies:
```bash
npm install
pnpm install
```

### Development
Expand All @@ -53,7 +53,7 @@ Done uploading summaries! 🥳
3. Then, start the development server:

```bash
npm run dev
pnpm dev
```

This will start a local server. The app will automatically reload if you make changes to the code.
Expand All @@ -63,7 +63,7 @@ This will start a local server. The app will automatically reload if you make ch
To create an optimized production build:

```bash
npm run build
pnpm build
```

This will create an optimized version of your project in the `build` directory.
Expand All @@ -73,7 +73,7 @@ This will create an optimized version of your project in the `build` directory.
To preview the production build locally:

```bash
npm run preview
pnpm preview
```

### Running Tests
Expand All @@ -85,72 +85,72 @@ npm run preview
To run both unit and integration tests together:

```bash
npm run test
pnpm test
```

#### Unit Tests

To run unit tests using Vitest:

```bash
npm run test:unit
pnpm test:unit
```

To run unit tests once:

```bash
npm run test:unit:once
pnpm test:unit:once
```

#### Integration Tests

To run integration tests using Playwright:

```bash
npm run test:integration
pnpm test:integration
```

To run integration tests once:

```bash
npm run test:integration:once
pnpm test:integration:once
```

For the Playwright UI to explore test results:

```bash
npm run test:integration:ui
pnpm test:integration:ui
```

### Linting and Formatting

To check code formatting and linting issues:

```bash
npm run lint
pnpm lint
```

To format the codebase:

```bash
npm run format
pnpm format
```

### Type Checking

To check the TypeScript types:

```bash
npm run check
pnpm check
```

To continuously check types while developing:

```bash
npm run check:watch
pnpm check:watch
```

## Best Practices

1. **Code Style**: This project uses Prettier and ESLint for code formatting and linting. Please run `npm run lint` and `npm run format` before committing changes.
1. **Code Style**: This project uses Prettier and ESLint for code formatting and linting. Please run `pnpm lint` and `pnpm format` before committing changes.
2. **Testing**: Ensure all changes are covered with unit and integration tests. Use Vitest for unit tests and Playwright for integration tests.
Loading