Skip to content

Commit

Permalink
version 3.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
AlemTuzlak committed Oct 21, 2023
1 parent 0d971b2 commit a5ffc6f
Show file tree
Hide file tree
Showing 52 changed files with 1,120 additions and 132 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,29 @@
![npm](https://img.shields.io/npm/dw/remix-development-tools?style=plastic)
![GitHub top language](https://img.shields.io/github/languages/top/Code-Forge-Net/Remix-Dev-Tools?style=plastic)

Remix Development Tools is an open-source package designed to enhance your development workflow when working with Remix, a full-stack JavaScript framework for building web applications. This package provides a user-friendly interface consisting of three tabs, **Active Page**, **Terminal**, **Settings** and **Routes**, along with a side tab called **Timeline**. With Remix Development Tools, you can efficiently monitor and manage various aspects of your Remix projects, including page information, URL parameters, server responses, loader data, routes, and more.
Remix Development Tools is an open-source package designed to enhance your development workflow when working with Remix, a full-stack JavaScript framework for building web applications. This package provides a user-friendly interface consisting of three tabs, **Active Page**, **Terminal**, **Settings**, **Errors** and **Routes**, along with a side tab called **Timeline**. With Remix Development Tools, you can efficiently monitor and manage various aspects of your Remix projects, including page information, URL parameters, server responses, loader data, routes, and more. You can
also track down hydration issues with the **Errors** tab and view your routes in a tree/list view with the **Routes** tab.

## How it looks
### Server logger
![server logger](./assets/logs.png)
### Routes Tab (List view)
![routes](./assets/routes.gif)

### Routes Tab (Tree view)
![routes](./assets/tree-view.png)
### Errors Tab
![routes](./assets/errors-tab.gif)
### Timeline
![timeline](./assets/timeline.gif)
### Route boundaries & Active page panel
![route boundaries](./assets/boundaries.png)


## What's new?
## v3.3.0
- HMR speed-up > HMR is now a lot faster due to the fact the package doesn't use lucide-react which was slowing down HMR on certain machines
- Errors tab > you can now see the HTML nesting errors that you might have on your page and open the files directly in VS code. This
can help you debug hydration issues a lot faster!

## v3.2.1

Expand Down Expand Up @@ -116,6 +124,10 @@ The **Routes** tab enables you to manage and explore the routes within your Remi

The **Timeline** side tab provides a timeline view of events occurring during the development process. This tab helps you track the sequence of actions and events, providing valuable insights into the execution flow of your application.

### Errors Tab

The **Errors** tab allows you to track down hydration issues in your application. It shows you the HTML nesting errors that you might have on your page and allows you to open the files directly in VS code. This can help you debug hydration issues a lot faster!

### Settings tab

The **Settings** tab allows you to tweak your Remix Development Tools to your needs. Allows you to tweak around the height of the dev tools,
Expand Down Expand Up @@ -231,6 +243,10 @@ If you're using a CJS custom server you can replace the following lines:

### CJS remix server setup (remix run server started by remix dev)

> [!NOTE]
> This is only needed when you're not running a custom server and you're using the remix dev server

Just add the following command to your package.json:
```diff
- "dev": "remix dev",
Expand All @@ -239,6 +255,9 @@ Just add the following command to your package.json:

### ESM remix server setup (remix run server started by remix dev)

> [!NOTE]
> This is only needed when you're not running a custom server and you're using the remix dev server
Just add the following command to your package.json:
```diff
- "dev": "remix dev",
Expand Down Expand Up @@ -411,9 +430,25 @@ The migration should be really simple. These are the following things you need t
```
4. You're good to go! (You can also add the server logger on top of that if you want)


## Troubleshooting

### Cloudflare

I am aware of the fact that Remix Development Tools doesn't work with Cloudflare. I am working on a fix for this issue.

### Types missing from "remix-dev-tools/server" import

If your `moduleResolution` is set to `Node` in your `tsconfig.json` file you may encounter missing types when importing from `remix-dev-tools/server`. To fix this issue you need to add the following to your `tsconfig.json` file:

```json
{
"compilerOptions": {
"moduleResolution": "Bundler"
}
}
```

### [ lower version than V3 only ] Dynamic imports are only supported when the "--module" flag is set to 'es2020', 'es2022', 'esnext', 'commonjs', 'amd', 'system', 'umd', 'node16', or 'nodenext'.ts(1323)

To fix this issue you need to add the following to your `tsconfig.json` file:
Expand Down
Binary file added assets/errors-tab.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
121 changes: 121 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 8 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
"name": "remix-development-tools",
"description": "Remix development tools - a set of tools for developing/debugging Remix.run apps",
"author": "Alem Tuzlak",
"version": "3.2.2",
"version": "3.3.0",
"license": "MIT",
"keywords": [
"remix",
"remix-dev-tools",
"remix-development-tools",
"hydration-debugger",
"remix-debugger",
"remix-debugger-ui",
"remix-debugger-ui-react",
Expand Down Expand Up @@ -98,9 +99,11 @@
"prepare": "husky install",
"tsc": "tsc --noEmit",
"validate": "npm run lint && npm run tsc && npm run test",
"run:scripts": "npx ts-node --esm --transpile-only -- $npm_config_script_path",
"tw": "npx tailwindcss -i ./src/input.css -o ./src/output.css --minify",
"move": "run-s tw & npm run run:scripts --script_path=scripts/moveStyles.ts"
"move": "run-s tw & npm run run:scripts --script_path=scripts/moveStyles.ts",
"run:scripts": "npx ts-node-esm --require tsconfig-paths/register --transpile-only",
"script": "npm run run:scripts scripts/setup.ts",
"icons": "npm run run:scripts scripts/icons.ts"
},
"workspaces": [
".",
Expand Down Expand Up @@ -152,6 +155,7 @@
"postcss": "^8.4.29",
"prettier": "^3.0.0",
"prettier-plugin-tailwindcss": "^0.4.1",
"prompt": "^1.3.0",
"react-dom": "^18.2.0",
"react-hook-form": "^7.45.2",
"rollup-plugin-copy": "^3.4.0",
Expand Down Expand Up @@ -180,4 +184,4 @@
"uuid": "^9.0.1",
"ws": "^8.14.2"
}
}
}
6 changes: 3 additions & 3 deletions plugins/tailwind-pallette/tailwind-pallette.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -245,9 +245,9 @@ export const tailwindPallettePlugin = () => ({
viewBox="0 0 24 24"
fill="none"
stroke="currentColor"
stroke-width="2"
stroke-linecap="round"
stroke-linejoin="round"
strokeWidth="2"
strokeLinecap="round"
strokeLinejoin="round"
>
<circle cx="13.5" cy="6.5" r=".5" />
<circle cx="17.5" cy="10.5" r=".5" />
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
1 change: 1 addition & 0 deletions resources/icons/shield.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Loading

0 comments on commit a5ffc6f

Please sign in to comment.