{"id":28175314,"url":"https://github.com/triumph-light/unplugin-react-inspector","last_synced_at":"2026-03-05T11:32:30.217Z","repository":{"id":289393391,"uuid":"970142324","full_name":"Triumph-light/unplugin-react-inspector","owner":"Triumph-light","description":"A unplugin which provides the ability that to jump to the local IDE when you click the element of browser automatically.","archived":false,"fork":false,"pushed_at":"2025-05-12T15:24:17.000Z","size":423,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-12-23T22:11:09.423Z","etag":null,"topics":["debug","react","react-inspector","reactjs","unplugin","vite","vite-plugin","vscode"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Triumph-light.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"Triumph-light"}},"created_at":"2025-04-21T14:44:15.000Z","updated_at":"2025-11-27T06:49:44.000Z","dependencies_parsed_at":"2025-07-05T22:38:07.916Z","dependency_job_id":"33546e8d-58a6-475a-9eb3-11428320a6f0","html_url":"https://github.com/Triumph-light/unplugin-react-inspector","commit_stats":null,"previous_names":["triumph-light/unplugin-react-inspector"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Triumph-light/unplugin-react-inspector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Triumph-light%2Funplugin-react-inspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Triumph-light%2Funplugin-react-inspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Triumph-light%2Funplugin-react-inspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Triumph-light%2Funplugin-react-inspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Triumph-light","download_url":"https://codeload.github.com/Triumph-light/unplugin-react-inspector/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Triumph-light%2Funplugin-react-inspector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30122140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T11:11:57.947Z","status":"ssl_error","status_checked_at":"2026-03-05T11:11:29.001Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["debug","react","react-inspector","reactjs","unplugin","vite","vite-plugin","vscode"],"created_at":"2025-05-15T23:13:51.041Z","updated_at":"2026-03-05T11:32:30.199Z","avatar_url":"https://github.com/Triumph-light.png","language":"TypeScript","funding_links":["https://github.com/sponsors/Triumph-light"],"categories":[],"sub_categories":[],"readme":"# unplugin-react-next-inspector \n\n[English](./README.md) | [简体中文](./README.zh-CN.md)\n\n## Introduction\nA unplugin which provides the ability that to jump to the local IDE when you click the element of browser automatically.\n\n## Notice\nnow just support vite.\n\n## Usage\n\n```bash\nnpm i -D unplugin-react-next-inspector\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eVite\u003c/summary\u003e\u003cbr\u003e\n\n```ts\n// vite.config.ts\nimport Starter from 'unplugin-react-next-inspector/vite'\n\nexport default defineConfig({\n  plugins: [Starter()],\n})\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eRollup\u003c/summary\u003e\u003cbr\u003e\n\n```ts\n// rollup.config.js\nimport Starter from 'unplugin-react-next-inspector/rollup'\n\nexport default {\n  plugins: [Starter()],\n}\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eRolldown\u003c/summary\u003e\u003cbr\u003e\n\n```ts\n// rolldown.config.js\nimport Starter from 'unplugin-react-next-inspector/rolldown'\n\nexport default {\n  plugins: [Starter()],\n}\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eesbuild\u003c/summary\u003e\u003cbr\u003e\n\n```ts\nimport { build } from 'esbuild'\nimport Starter from 'unplugin-react-next-inspector/esbuild'\n\nbuild({\n  plugins: [Starter()],\n})\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eWebpack\u003c/summary\u003e\u003cbr\u003e\n\n```js\n// webpack.config.js\nimport Starter from 'unplugin-react-next-inspector/webpack'\n\nexport default {\n  /* ... */\n  plugins: [Starter()],\n}\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eRspack\u003c/summary\u003e\u003cbr\u003e\n\n```ts\n// rspack.config.js\nimport Starter from 'unplugin-react-next-inspector/rspack'\n\nexport default {\n  /* ... */\n  plugins: [Starter()],\n}\n```\n\n\u003cbr\u003e\u003c/details\u003e\n\n### Options\n```ts\n\nexport interface InspectorOptions {\n  /**\n   * Default enable state\n   * @default false\n   */\n  enabled?: boolean\n  /**\n   * Define a combo key to toggle inspector\n   * @default 'control-shift' on windows, 'meta-shift' on other os\n   *\n   * any number of modifiers `control` `shift` `alt` `meta` followed by zero or one regular key, separated by -\n   * examples: control-shift, control-o, control-alt-s  meta-x control-meta\n   * Some keys have native behavior (e.g. alt-s opens history menu on firefox).\n   * To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended.\n   * You can also disable it by setting `false`.\n   */\n  toggleComboKey?: string | false\n  /**\n   * Target editor when open in editor\n   *\n   * @default process.env.LAUNCH_EDITOR ?? code (Visual Studio Code)\n   */\n  launchEditor?: 'appcode' | 'atom' | 'atom-beta' | 'brackets' | 'clion' | 'code' | 'code-insiders' | 'codium' | 'emacs' | 'idea' | 'notepad++' | 'pycharm' | 'phpstorm' | 'rubymine' | 'sublime' | 'vim' | 'visualstudio' | 'webstorm' | 'rider' | 'cursor' | string\n\n  include?: FilterPattern\n  exclude?: FilterPattern\n}\n```\n\n### example\n[Demo](https://github.com/Triumph-light/unplugin-react-next-inspector/tree/master/examples)\n\n## 🔌  Configuration IDE / Editor\n\n**Using the `launchEditor` option configuration to specify the IDE** (Please ensure that the editor's environment variables are correctly configured beforehand.)\n\nIt uses an **environment variable** named **`LAUNCH_EDITOR`** to specify an IDE application, but if you do not set this variable, it will try to open a common IDE that you have open or installed once it is certified.\n\nFor example, if you want it always open VS Code when inspection clicked, set `export LAUNCH_EDITOR=code` in your shell and you must allow vscdoe check your files.\n\n\n### VS Code\n\n- install VS Code command line tools, [see the official docs](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line)\n  ![install-vscode-cli](./public/install-vscode-cli.png)\n\n- set env to shell, like `.bashrc` or `.zshrc`  \n\n  ```bash\n  export LAUNCH_EDITOR=code\n  ```\n\n\u003cbr /\u003e\n\n\n### VS Code with WSL (Windows)\n\n- add the configuration in the `settings.json`\n\n- restart the VS Code (All Windows should be closed to take effect)\n\n```json\n{\n  // other config...\n\n  \"terminal.integrated.env.linux\": {\n    \"EDITOR\": \"code\"\n  }\n}\n```\n\n\n### WebStorm  \n\n- just set env with an absolute path to shell, like `.bashrc` or `.zshrc` (only MacOS)  \n\n  ```bash\n  export LAUNCH_EDITOR='/Applications/WebStorm.app/Contents/MacOS/webstorm'\n  ```\n\n**OR**\n\n- install WebStorm command line tools\n\n- then set env to shell, like `.bashrc` or `.zshrc`  \n\n  ```bash\n  export LAUNCH_EDITOR=webstorm\n  ```\n\n\u003cbr /\u003e\n\n### PhpStorm\n\n- just set env with an absolute path to shell, like `.bashrc` or `.zshrc` (only MacOS)\n\n  ```bash\n  export LAUNCH_EDITOR='/Applications/PhpStorm.app/Contents/MacOS/phpstorm'\n  ```\n\n**OR**\n\n- install PhpStorm command line tools\n\n- then set env to shell, like `.bashrc` or `.zshrc`\n\n  ```bash\n  export LAUNCH_EDITOR=phpstorm\n  ```\n\n\u003cbr /\u003e\n\n### Vim\n\nYes! you can also use vim if you want, just set env to shell\n\n```bash\nexport LAUNCH_EDITOR=vim\n```\n\n\u003cbr /\u003e\n\n## Credits\nThis project is inspired by [react-dev-inspector](https://github.com/zthxxx/react-dev-inspector) .\n\nPartially implementation is inspired by [vite-plugin-vue-inspector](https://github.com/webfansplz/vite-plugin-vue-inspector/tree/main) .\n\n\n## License\n[MIT](./LICENSE) License © 2025-PRESENT [Triumph-light](https://github.com/Triumph-light)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftriumph-light%2Funplugin-react-inspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftriumph-light%2Funplugin-react-inspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftriumph-light%2Funplugin-react-inspector/lists"}