Repository: Tencent/vConsole

Stars: 17468

CLAUDE.md Copy Chapter

vConsole Development Notes

Reply in Simplified Chinese, but use English for code, comments, and Git.

Workflow Copy Chapter

Coding Copy Section

1. Fetch the issue with gh issue view <N> --repo Tencent/vConsole.
2. Read the relevant source files before drawing conclusions.
3. Determine the category:
- Bug: investigate root cause, fix source, commit, update both changelogs.
- Usage / environment problem: explain why it is not a vConsole bug and suggest directions.
- Feature request: run coding task, then commit with Closes #N.
4. Draft a short, concise reply with neutral tone in the issue author's language. Show to user for confirmation, then post with:
gh issue comment <N> --repo Tencent/vConsole --body "..."

PRs Copy Section

1. Fetch the PR diff and conversations from GitHub.
2. Read the affected local source files before judging the implementation.
3. Evaluate correctness and flag any issues found.
4. Merge with gh pr merge <N> --repo Tencent/vConsole --squash and run git pull.
5. Fix any remaining issues in the local copy, then update both changelogs.
6. Commit.

README.md Copy Chapter

English | 简体中文

vConsole
===

A lightweight, extendable front-end developer tool for mobile web page.

vConsole is framework-free, you can use it in Vue or React or any other framework application.

Now vConsole is the official debugging tool for WeChat Miniprograms.

---

Features Copy Chapter

- Logs: console.log|info|error|...
- Network: XMLHttpRequest, Fetch, sendBeacon
- Element: HTML elements tree
- Storage: Cookies, LocalStorage, SessionStorage
- Execute JS command manually
- Custom plugins

For details, please see the screenshots below.

---

Release Notes Copy Chapter

Latest version: ![npm version](https://www.npmjs.com/package/vconsole)

Detailed release notes for each version are available on Changelog.

---

Guide Copy Chapter

See Tutorial for more usage details.

For installation, there are 2 primary ways of adding vConsole to a project:

#### Method 1: Using npm (Recommended)

$ npm install vconsole

import VConsole from 'vconsole';
const vConsole = new VConsole();
// or init with options
const vConsole = new VConsole({ theme: 'dark' });
// call console methods as usual
console.log('Hello world');
// remove it when you finish debugging
vConsole.destroy();

#### Method 2: Using CDN in HTML:

<script src="https://unpkg.com/vconsole@latest/dist/vconsole.min.js"></script>
<script>
  // VConsole will be exported to window.VConsole` by default.
  var vConsole = new window.VConsole();
</script>

Available CDN:

- https://unpkg.com/vconsole@latest/dist/vconsole.min.js
- https://cdn.jsdelivr.net/npm/vconsole@latest/dist/vconsole.min.js

---

Preview Copy Chapter

http://wechatfe.github.io/vconsole/demo.html


---

Screenshots Copy Chapter

Overview Copy Section

<details>
<summary>Light theme</summary>

</details>

<details>
<summary>Dark theme</summary>

</details>

Log Panel Copy Section

<details>
<summary>Log styling</summary>

</details>

<details>
<summary>Command line</summary>

</details>

System Panel Copy Section

<details>
<summary>Performance info</summary>

</details>

<details>
<summary>Output logs to different panel</summary>

console.log('output to Log panel.')
console.log('[system]', 'output to System panel.')

Network Panel Copy Section

<details>
<summary>Request details</summary>

</details>

Element Panel Copy Section

<details>
<summary>Realtime HTML elements structure</summary>

</details>

Storage Panel Copy Section

<details>
<summary>Add, edit, delete or copy Cookies / LocalStorage / SessionStorage</summary>

</details>

---

Documentation Copy Chapter

vConsole:

- Tutorial
- Public Properties & Methods
- Builtin Plugin: Properties & Methods

Custom Plugin:

- Plugin: Getting Started
- Plugin: Building a Plugin
- Plugin: Event List

---

Third-party Plugins Copy Chapter

- vConsole-sources
- vconsole-webpack-plugin
- vconsole-stats-plugin
- vconsole-vue-devtools-plugin
- vconsole-outputlog-plugin
- vite-plugin-vconsole

---

Feedback Copy Chapter

QQ Group: 497430533


---

License Copy Chapter

The MIT License