Giter Club home page Giter Club logo

metal-devtools's Introduction

Metal.js

Build Status Join #metal on our Slack Channel

Build Status

Metal.js is a JavaScript library for building UI components in a solid, flexible way.

Support and Project status

Metal.js is widely used and well maintained internally at Liferay but does not currently have staffing to support the open source release. As such this project is mostly internal and support is minimal. For certain issues, like build integration we are in an especially bad position to offer support.

To get assistance you can use any of the following forums

  1. Look through the documentation.
  2. File an issue on GitHub

We will try our best, but keep in mind that given our support staffing, we may not be able to help.

Setup

  1. Install NodeJS >= v0.12.0, if you don't have it yet.

  2. Install lerna global dependency:

[sudo] npm install -g [email protected]
  1. Run the bootstrap script to install local dependencies and link packages together:
npm run lerna
  1. Run tests:
npm test

Developer Tools for Metal.js

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

License

BSD License © Liferay, Inc.

metal-devtools's People

Contributors

bryceosterhaus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

metal-devtools's Issues

Add ability to "freeze" updated components

The idea behind this is when debugging for performance, it would be great to have some sort of toggle that I can turn on so that the next set of update flashes will stay and not fade away.

This would allow a user to toggle "freeze" and then do some action that causes various updates in the application. Then the user can see every single component that has updated do to that one action.

Flash component in panel after render

When a component re-renders, we should flash the component in the Metal.js devtools panel. This will allow users to debug unnecessary re-renders. This feature should probably be something you can toggle on and off.

Devtools crashes when opening a Connect component

There is something in my store which is causing the devtools to repeatedly print out

Args: 
VM1032:642  metal-devtools extension: (`clone`)

    TypeError: Illegal constructor

    at cloneObj (<anonymous>:639:20)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)
    at cloneObj (<anonymous>:649:26)

Until chrome crashes. TT ^ TT

It may have something to do with some dom elements I have in the store.

Cannot build from a clean clone

After cloning the repo and running npm install, npm run build:chrome will fail with the following trace:

Chemas-MBP:metal-devtools jose.balsas$ npm run build:chrome

> [email protected] build:chrome /Users/jose.balsas/dev/bryceosterhaus/metal-devtools
> webpack --config shells/chrome/webpack.config.js

Hash: 171db2b98db8d015a0d4
Version: webpack 1.14.0
Time: 3439ms
           Asset     Size  Chunks             Chunk Names
   background.js  1.99 kB       0  [emitted]  background
contentScript.js  5.08 kB       1  [emitted]  contentScript
     devtools.js  2.33 kB       2  [emitted]  devtools
  initializer.js  2.55 kB       3  [emitted]  initializer
        panel.js   592 kB       4  [emitted]  panel
   [3] ./frontend/static .*(\.css|\.png|\.html) 201 bytes {4} [built] [2 warnings]
    + 170 hidden modules

WARNING in ./frontend/static .*(\.css|\.png|\.html)
Module not found: Error: Cannot resolve module 'file' in /Users/jose.balsas/dev/bryceosterhaus/metal-devtools/frontend/static
 @ ./frontend/static .*(\.css|\.png|\.html)

WARNING in ./frontend/static .*(\.css|\.png|\.html)
Module not found: Error: Cannot resolve module 'file' in /Users/jose.balsas/dev/bryceosterhaus/metal-devtools/frontend/static
 @ ./frontend/static .*(\.css|\.png|\.html)

ERROR in ./shells/chrome/src/background.js
Module not found: Error: Cannot resolve module 'file' in /Users/jose.balsas/dev/bryceosterhaus/metal-devtools/shells/chrome/src
 @ ./shells/chrome/src/background.js 3:0-23

ERROR in ./shells/chrome/src/devtools.js
Module not found: Error: Cannot resolve module 'file' in /Users/jose.balsas/dev/bryceosterhaus/metal-devtools/shells/chrome/src
 @ ./shells/chrome/src/devtools.js 3:0-26

ERROR in ./shells/chrome/src/panel.js
Module not found: Error: Cannot resolve module 'file' in /Users/jose.balsas/dev/bryceosterhaus/metal-devtools/shells/chrome/src
 @ ./shells/chrome/src/panel.js 3:0-23

Trying to still install the unpacked extension will fail with the following trace

Failed to load extension from: ~/dev/bryceosterhaus/metal-devtools/shells/chrome
Could not load extension icon 'build/metal.png'.

Doesn't work for Soy components

Currently doesn't work for soy components, this is due to when the content script is run. Once we add that, we also need to process the state data properly so that both jsx and soy will reflect the proper state.

Add element highlighting to elements pane

Similar to how react does this, we should add functionality that allows us to inspect a certain node in the DOM and then show that corresponding metal component. Also, we should provide capability to highlight dom node after selecting its metal-component on the Metal.js tab.

Scrolling not working

Unable to scroll through the component tree. Might be due to using hot-reloading dev server.

Chrome Version 61.0.3163.100 (Official Build) (64-bit)

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.