leviwheatcroft / metalsmith-debug-ui

browser based ui for metalsmith debugging
21 stars 3 forks source link

Wider step title column ? #11

Open smor opened 1 year ago

smor commented 1 year ago

Hello,

Using metalsmith-debug-ui as a team, I found that providing descriptive longer report step names eased to understand the work process and debugging. As it is now, a lot of space is wasted, and the elements are stacked one on top of the other, which makes the UI pretty annoying on a regular laptop :

image

Currently the left column is col-md-2 and the right one col-md-10. A quick test tampering directly in client.js in node_modules with 4 and 8 makes it easier to read :

image

Would it be okay to create a PR with these values ? Would you rather think of a way to make this more configurable ?

Thanks, Stéphane

leviwheatcroft commented 1 year ago

Thanks for your interest, and suggestions!

I'd prefer to avoid any additional versions of the 0.3.x branch. I haven't looked at it in ~5 years and wouldn't want to inadvertently break something for existing users.

Great news though, a few months ago I re-wrote this package, it's presently in the dev branch. I was using it personally, as far as I know it's ready to go, but I was hoping to get others to test it before publishing v1.0.0 to npm. If you'd like to take a look I would very much appreciate any suggestions.

Note that the api has changed since v0.3.x. Details in the dev README.md. Basically I promoted the reporter style usage you're using to be the primary / recommended use because that doesn't require 'patching' the metalsmith instance.

Anyhow, if you'd like to give it a shot I would very much appreciate that, and I'd be delighted to receive any suggestions for improvement.

Because it's not published on npm, you'll need to clone the repo, build the client locally, then link it from your package. This would look something like this...

git clone git@github.com:leviwheatcroft/metalsmith-debug-ui.git
cd metalsmith-debug-ui
npm install
npm run webpack
npm link
cd ../my-actual-metalsmith-project
npm link metalsmith-debug-ui