Merge pull request #10645 from remix-run/remix-the-web

Import history from remix-the-web

Author: brophdawg11

.env.example

@@ -0,0 +1,2 @@
+# This is needed to publish GitHub Releases
+GITHUB_TOKEN=your_github_token

.github/workflows/build.yaml

@@ -0,0 +1,37 @@
+on:
+  # Re-enable this once we land v3 in main/dev
+  # push:
+  #   branches:
+  #     - 'v3'
+  # Update this once we land v3 in main/dev
+  pull_request:
+    branches:
+      - 'v3'
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          run_install: false
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build packages
+        run: pnpm build
+
+      - name: Run tests
+        run: pnpm test

.github/workflows/publish.yaml

@@ -0,0 +1,41 @@
+on:
+  # Re-enable this once we land v3 in main
+  # push:
+  #   tags:
+  #     - '[a-z]+@[0-9]+.[0-9]+.[0-9]+'
+  #     - '[a-z]+-[a-z]+@[0-9]+.[0-9]+.[0-9]+'
+  #     - '[a-z]+-[a-z]+-[a-z]+@[0-9]+.[0-9]+.[0-9]+'
+  # For now, just do this manually
+  workflow_dispatch:
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write # Required for publishing the GitHub release.
+      id-token: write # The OIDC ID token is used for authentication with JSR.
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          run_install: false
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Publish
+        run: pnpm publish-release-ci ${{ github.ref_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,6 @@
+**/dist/
+**/node_modules/
+
+**/*.tsbuildinfo
+
+.env

.prettierrc

@@ -0,0 +1,4 @@
+printWidth: 100
+semi: true
+singleQuote: true
+useTabs: false

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "deno.enablePaths": ["./packages/multipart-parser/examples/deno"],
+  "nodejs-testing.extensions": [
+    {
+      "extensions": ["ts"],
+      "parameters": ["--experimental-strip-types", "--disable-warning=ExperimentalWarning"]
+    }
+  ],
+  "typescript.tsdk": "./node_modules/typescript/lib"
+}

.vscode/task.json

@@ -0,0 +1,6 @@
+{
+  "version": "0.1.0",
+  "command": "./node_modules/.bin/tsc",
+  "args": ["-v"],
+  "echoCommand": true
+}

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+Welcome to `remix-the-web`! We're excited to have you contribute.
+
+This guide will help you get started.
+
+## Setting Up Your Environment
+
+To get started, you'll need `pnpm`. If you don't have it yet, you can [install `pnpm` here](https://pnpm.io/installation).
+
+If you're using [VS Code](https://code.visualstudio.com/), we recommend installing the [`node:test runner` extension](https://marketplace.visualstudio.com/items?itemName=connor4312.nodejs-testing) for a smooth testing experience.
+
+Once that's set up, run `pnpm install` to get all the project dependencies. You can then run `pnpm build` to build the project and `pnpm test` to run all tests.
+
+## Making Changes
+
+All our packages live in the [`packages` directory](https://github.com/mjackson/remix-the-web/tree/main/packages). At a minimum, each package typically includes:
+
+- `CHANGELOG.md`: A log of what's changed.
+- `package.json`: Package metadata and dependencies.
+- `README.md`: Information about the package.
+
+When you make changes to a package, please make sure you add a few relevant tests and run the whole test suite to make sure everything still works. Then, add a human-friendly description of your change in the changelog and [make a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). We will take a look at it as soon as we can.
+
+## Releases
+
+Cutting releases is a 2-step process:
+
+- Update versions in package.json, jsr.json (if applicable), and the changelog and create a git tag
+- Publish new packages to npm/JSR and create a GitHub Release
+
+This repo includes a script for each step.
+
+To update versions and create a tag, use `pnpm run tag-release <packageName> <releaseType>`. For example, to create a `minor` release of the `headers` package, run:
+
+```sh
+pnpm run tag-release headers minor
+```
+
+To publish the release you just tagged, use `pnpm run publish-release <tag>`. For example, if the tag that was created in the previous step was `[email protected]`, you'd run `pnpm run publish-release [email protected]`.
+
+The publish step runs in GitHub Actions if you just push the tag to GitHub:
+
+```sh
+git push origin main --tags
+```

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "remix-the-web",
+  "private": true,
+  "packageManager": "[email protected]",
+  "devDependencies": {
+    "prettier": "^3.3.3",
+    "typescript": "^5.7.2"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "build": "pnpm -r build",
+    "clean": "git clean -fdX .",
+    "publish-release": "node --env-file .env ./scripts/publish-release.js",
+    "publish-release-ci": "node ./scripts/publish-release.js",
+    "tag-release": "node ./scripts/tag-release.js",
+    "test": "pnpm -r --workspace-concurrency 1 test"
+  },
+  "workspaces": [
+    "packages/*"
+  ],
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "@swc/core",
+      "esbuild",
+      "workerd"
+    ]
+  }
+}

packages/fetch-proxy/CHANGELOG.md

@@ -0,0 +1,11 @@
+# `fetch-proxy` CHANGELOG
+
+This is the changelog for [`fetch-proxy`](https://github.com/mjackson/remix-the-web/tree/main/packages/fetch-proxy). It follows [semantic versioning](https://semver.org/).
+
+## v0.2.0 (2024-11-14)
+
+- Added CommonJS build
+
+## v0.1.0 (2024-09-12)
+
+- Initial release