Giter VIP home page Giter VIP logo

nemetar / devveil Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 117 KB

Devveil is an npm package that simplifies component search and debugging in Vue, React, Svelte, HTML, and Angular projects. It displays a pop-up with the component's name and a link to the code in Visual Studio Code.

Home Page: https://www.npmjs.com/package/devveil

TypeScript 93.86% HTML 4.54% Svelte 0.77% Vue 0.82%
angular components debugging frontend html npm react svelte usefull vue

devveil's Introduction

Devveil ๐Ÿง๐Ÿ› ๏ธ

Devveil is an npm package for developers that aims to make it easier to search and debug components. When Devveil is activated and you hover over a component, a pop-up appears displaying the component's name and a link that redirects directly to the component in Visual Studio Code. It supports Vue, React, Svelte, basic HTML, and Angular.

devveil

Installation ๐Ÿ”ง

To install Devveil, run the following command:

npm install -g devveil

Usage ๐Ÿ’ป

Devveil has two main commands:

  • devveil --inject: Adds the necessary tags to the elements in your project.
  • devveil --remove: Removes the added elements before committing.

To use Devveil, simply run one of the commands above in your project directory. Devveil currently takes into account elements in the src/components, src/pages, and src/views directories.

How it Works ๐Ÿค”

Devveil injects tags into your project's elements, allowing it to recognize and display information about your components when you hover over them. The injected tags are temporary and can be easily removed with the --remove command before committing your changes.

Supported Frameworks ๐ŸŒ

Devveil currently supports the following frameworks:

  • Vue
  • React
  • Svelte
  • Basic HTML
  • Angular

Limitations and Improvements โš ๏ธ๐Ÿ”ง

Please note that Devveil is still in the testing phase and may have some limitations. Some features may not work as expected, and some frameworks may not be fully supported. However, improvements are constantly being made, and any help is welcome!

Contributing ๐Ÿ’ช

If you would like to contribute to Devveil, please open a pull request with your proposed changes. All contributions are welcome!

License ๐Ÿ“„

Devveil is licensed under the MIT License. See the LICENSE file for more information.

GitHub Repository ๐Ÿ”—

You can find the Devveil repository on GitHub at the following link: Devveil GitHub


devveil's People

Contributors

gujinn avatar nemetar avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.