docs: Remove formatter (#657)

This commit is contained in:
Brace Sproul 2025-08-04 11:44:42 -07:00 • committed by GitHub
parent 51fb21bf8a
commit a21134e5ac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 37 additions and 25 deletions

View file

@ -1,4 +0,0 @@
{
"tabWidth": 2,
"useTabs": false
}

View file

@ -33,58 +33,74 @@ If you want to try out Open SWE, but aren't sure where to start, here are a few
Below are a series of examples you can try out:
<Accordion title="RESTful “Books” micro-service">
```txt Create an Express-based API exposing CRUD endpoints for `/books`.
<Accordion title="RESTful 'Books' micro-service">
```txt
Create an Express-based API exposing CRUD endpoints for `/books`.
Include request validation with `zod`, proper HTTP status codes, and an
in-memory repository layer that can later be swapped for a database. Add Jest
tests covering happy-path and a “missing ISBN” error case. ```
tests covering happy-path and a 'missing ISBN' error case.
```
</Accordion>
<Accordion title="WebSocket live counter">
```txt Add a small WebSocket server (using `ws`) that tracks how many clients
```txt
Add a small WebSocket server (using `ws`) that tracks how many clients
are currently connected and broadcasts the updated count every 5 seconds.
Expose a health-check HTTP route returning the same value for monitoring
tools. Provide a minimal HTML demo page that shows the live number. ```
tools. Provide a minimal HTML demo page that shows the live number.
```
</Accordion>
<Accordion title="GitHub issue sync CLI">
```txt Implement a CLI (`src/sync-issues.ts`) that reads a `config.json` with
```txt
Implement a CLI (`src/sync-issues.ts`) that reads a `config.json` with
one or more GitHub repos, fetches their open issues via the GitHub REST API,
and writes a local `issues.{owner}.{repo}.csv`. Use `yargs` for parsing and
include a `--since YYYY-MM-DD` flag to filter by creation date. ```
include a `--since YYYY-MM-DD` flag to filter by creation date.
```
</Accordion>
<Accordion title="JWT + refresh-token auth layer">
```txt Build a middleware that issues short-lived access tokens and long-lived
```txt
Build a middleware that issues short-lived access tokens and long-lived
refresh tokens. Store refresh tokens in a signed, HttpOnly cookie and expose
`/auth/refresh` to rotate them. Protect a sample route (`/profile`) and supply
Postman collections for login and refresh flows. ```
Postman collections for login and refresh flows.
```
</Accordion>
<Accordion title="Pluggable caching service">
```txt Design a generic cache interface with `get`, `set`, and `invalidate`
```txt
Design a generic cache interface with `get`, `set`, and `invalidate`
methods, then provide two adapters: an in-memory `Map` implementation and a
Redis adapter (mock Redis with `ioredis-mock` for tests). Demonstrate
hot-swapping the adapter via an environment variable without code changes. ```
hot-swapping the adapter via an environment variable without code changes.
```
</Accordion>
<Accordion title="GraphQL wrapper over REST API">
```txt Stand up an Apollo Server that federates data from the public
```txt
Stand up an Apollo Server that federates data from the public
JSONPlaceholder `/users` and `/posts` endpoints. Expose a `user(id)` query
returning the user plus their posts in a single round-trip. Add schema-driven
TypeScript types (`codegen.yml`) and example queries in `README.md`. ```
TypeScript types (`codegen.yml`) and example queries in `README.md`.
```
</Accordion>
<Accordion title="Image upload to S3 with signed URLs">
```txt Create an endpoint that returns a time-limited pre-signed PUT URL for
```txt
Create an endpoint that returns a time-limited pre-signed PUT URL for
an S3 bucket (use `@aws-sdk/client-s3`). Include a small React demo (Vite)
that lets a user pick an image and upload it directly. Validate MIME type on
the server before signing. ```
the server before signing.
```
</Accordion>
<Accordion title="Locale-aware date utility library">
```txt Publish an internal `/src/date` module that formats, parses, and
time-zone-converts dates using `luxon`. Support at least “en-US”, “de-DE”, and
“ja-JP”. Provide type-safe wrappers, exhaustive unit tests, and a benchmark
script comparing it to native `Intl.DateTimeFormat`. ```
```txt
Publish an internal `/src/date` module that formats, parses, and
time-zone-converts dates using `luxon`. Support at least 'en-US', 'de-DE', and
'ja-JP'. Provide type-safe wrappers, exhaustive unit tests, and a benchmark
script comparing it to native `Intl.DateTimeFormat`.
```
</Accordion>

View file

@ -5,8 +5,8 @@
"private": true,
"scripts": {
"dev": "mint dev",
"format": "prettier --write .",
"format:check": "prettier --check .",
"format": "echo 'No formatting needed for docs' && exit 0",
"format:check": "echo 'No formatting needed for docs' && exit 0",
"clean": "rm -rf .turbo || true"
},
"devDependencies": {