Skip to content

Commit ec3288d

Browse files
authored
42 feature undock dev tools (#45)
* Detached mode support * Icon library plugin * build optimization * Detached mode finalization
1 parent eace008 commit ec3288d

39 files changed

+1099
-293
lines changed

.prettierrc

+6-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
{
2-
"plugins": ["prettier-plugin-tailwindcss"],
2+
"plugins": [
3+
"prettier-plugin-tailwindcss"
4+
],
35
"tabWidth": 2,
46
"useTabs": false,
57
"singleQuote": false,
68
"trailingComma": "es5",
7-
"semi": true
8-
}
9+
"semi": true,
10+
"printWidth": 120
11+
}

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<center>
2+
<img src="./assets/remix-dev-tools.png" style=" width:320px; height:320px;" />
3+
</center>
4+
15
# Remix Development Tools
26

37
![GitHub Repo stars](https://img.shields.io/github/stars/Code-Forge-Net/Remix-Dev-Tools?style=social)
@@ -16,6 +20,18 @@ Remix Development Tools is an open-source package designed to enhance your devel
1620
### Timeline
1721
![timeline](./assets/timeline.gif)
1822

23+
## What's new?
24+
25+
### v2.1.0
26+
Detached mode support!
27+
28+
29+
Json viewer improvements:
30+
- Number of items in objects/arrays
31+
- Copy to clipboard
32+
- type of the value
33+
- Doesn't close on revalidate anymore
34+
- Different UI
1935

2036
## Features
2137

@@ -57,6 +73,10 @@ The terminal tab allows you to run terminal commands from the Remix Dev Tools. T
5773
- You can press `Ctrl + C` to cancel the current command.
5874
- You can press `Ctrl + L` to clear the terminal.
5975

76+
### Detached mode
77+
78+
Detached mode allows you to un-dock the Remix Dev Tools from the browser and move it to a separate window. This is useful if you want to have the dev tools open on a separate monitor or if you want to have it open on a separate window on the same monitor.
79+
6080
## Getting Started
6181

6282
To install and utilize Remix Development Tools, follow these steps:

assets/remix-dev-tools.png

4.83 KB
Loading

package-lock.json

+54-48
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+8-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22
"name": "remix-development-tools",
33
"description": "Remix development tools.",
44
"author": "Alem Tuzlak",
5-
"version": "2.0.0",
5+
"version": "2.1.0",
66
"license": "MIT",
77
"keywords": [
88
"remix",
9-
"remix-dev-tools"
9+
"remix-dev-tools",
10+
"remix-development-tools",
11+
"remix-debugger",
12+
"remix-debugger-ui",
13+
"remix-debugger-ui-react"
1014
],
1115
"private": false,
1216
"type": "module",
@@ -98,10 +102,10 @@
98102
"dependencies": {
99103
"@radix-ui/react-accordion": "^1.1.2",
100104
"@radix-ui/react-select": "^1.2.2",
105+
"@uiw/react-json-view": "^1.8.4",
101106
"clsx": "^2.0.0",
102107
"lucide-react": "^0.263.1",
103-
"react-json-view-lite": "^0.9.7",
104108
"react-use-websocket": "^4.3.1",
105109
"tailwind-merge": "^1.14.0"
106110
}
107-
}
111+
}

plugins/README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Plugins
2+
3+
This folder contains all the ready to go plugins that you can copy/paste into your project.
4+
5+
If you build a plugin please feel free to create a PR towards the `plugins` folder so we can add it to the list of plugins.
6+
7+
## How to use
8+
9+
Each plugin has a `README.md` file that explains how to use it.
10+
11+
12+
So all you need to do is find the one you like, copy the code and paste it into your project and follow the instructions from the `README.md` file.
13+
14+
## Can I add my own features?
15+
16+
All the plugins featured under this folder are meant to be copy/pasted into your project with you having all the rights to modify them as you see fit. Feel free to add/remove whatever you like. If you add something cool, please share it with us so we can add it to the list of plugins or improve the existing ones.
17+
18+
## How to add a new plugin
19+
20+
1. Fork the repo
21+
2. Create a new folder under `plugins` with the name of your plugin
22+
3. Add a `README.md` file with the instructions on how to use the plugin
23+
4. Add TODO's in the code where the user needs to modify the code to their project specifications
24+
5. Add an image/video/gif of the plugin in action
25+
6. Create a PR towards the repository!

plugins/icon-library/Icon library.mp4

1.26 MB
Binary file not shown.

plugins/icon-library/README.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Icon library plugin
2+
3+
This plugin allows you to see all your project icons in a new tab in remix development tools, copy the code and change their classes.
4+
5+
<video controls="controls" src="./Icon library.mp4" ></video>
6+
7+
## How to use
8+
9+
1. Copy the code from the plugin located in this folder.
10+
2. Go over the TODO's in the code and modify the code to your project specifications.
11+
3. Import the plugin exported from the `icon-library.tsx` into your `root.tsx` file.
12+
4. Add the plugin to the `plugins` array in the `RemixDevTools` component.
13+
14+
```tsx
15+
import { iconLibraryPlugin } from "~/icon-library.tsx";
16+
17+
<RemixDevTools
18+
...
19+
plugins={[iconLibraryPlugin()]}
20+
/>
21+
```
22+
23+
5. Run your project and open the new tab in the development tools.
24+
25+
## How it works
26+
27+
The plugin will use all the icons in your project that are provided to it and will display them in a grid with different sizes.
28+
29+
You can click on the icon to copy the code of the icon to your clipboard.
30+
31+
You can use the input on the top right to add custom classes to the component (eg. change colors on the fly).
32+
33+
## How to add icons
34+
35+
This will be easy/hard depending on your project setup. The basic idea is to have an icon component that is reusable across the project by
36+
providing a different name and size to the component. If you do not have this you would probably need to do it in a different way. What is
37+
important is to have an array of icon names in the project that you can use to generate the icons.
38+
39+
## Can I add my own features?
40+
41+
All the plugins featured under this folder are meant to be copy/pasted into your project with you having all the rights to modify them as you see fit. Feel free to add/remove whatever you like. If you add something cool, please share it with us so we can add it to the list of plugins or improve the existing ones.

0 commit comments

Comments
 (0)