Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Livecoding: Webpack Build Progress Indicator for Mac Touchbar [Video]

DZone's Guide to

Livecoding: Webpack Build Progress Indicator for Mac Touchbar [Video]

In this tutorial, a web developer walks us through the process of connecting several pieces of open source code to create an application.

· Web Dev Zone
Free Resource

Learn how to build modern digital experience apps with Crafter CMS. Download this eBook now. Brought to you in partnership with Crafter Software


Today, we made history! Webpack progress indicator for the Mac Touchbar! Finally, even web developers can admit that thing is useful.

Here's How You Set it Up

You can start using it right now. All you need is an expensive laptop, my Touchbar Nyancat Webpack Progress app, and my fork of nyan-progress-webpack-plugin. Both are on GitHub.

  • Download the app, run it. Set it up to run at startup, if you want to be fancy.
  • Add my nyan-progress-webpack-plugin to your package.json. I'll try to convince @alexkuz to merge it into his published package. When that happens, this step will be easier.
// package.json
"dependencies" {
    // ...
    "nyan-progress-webpack-plugin": "git://github.com/Swizec/nyan-progress-webpack-plugin#send-progress-to-touchbar",
}

Then run installation:

$ npm install 

Now you have my progress indicator. It can talk to your Touchbar when the app from step 1 is running.

Update your Webpack config.

// webpack.config.js

plugins: [
    // ...
    new require('nyan-progress-webpack-plugin')({
        sendProgressToTouchbar: true
    })
]

This enables a Nyan Cat webpack progress indicator in your terminal and tells it to send progress to the touchbar as well. It's behind a feature flag so @alexkuz doesn't get too upset when I make a pull request. Kind of a silly feature. 

Voilà! Enjoy your Touchbar Progress indicator. 

Here's How it Works

This joyful hack stands on the shoulders of giants. We used two pieces of open source software and made them work together:

  1. Alex Kuz's nyan-webpack-progress-indicator provided all the logic to take Webpack's build progress and do something
  2. Avatsaev's touchbar nyancat provided the Touchbar integration because I don't know much about native development.

We took those two Nyan Cat... things... and added an HTTP server. That's right. They talk to each other via HTTP because that was the easiest to implement. 

The native app runs a web server built with Swifter. This part was hard because documentation is scarce and because I've never done Swift code before.

We added these lines to what looks like the most important Nyan cat file - NyanCatCanvas.swift.

// NyanCatCanvas.swift

func downloadImage() {
    // stuff that downloads nyan gif

    server["/progress/:progress"] = updateProgress()
    do {
        try server.start(12345)
    } catch {
        print(error)
    }
}

func updateProgress() -> ((HttpRequest) -> HttpResponse) {
    return { r in
    let progress : NSNumber? = NumberFormatter().number(from: r.params.first!.value)

    if progress != nil {
        self.xPosition = -680 + 6.8 * CGFloat(progress!)

        return .ok(.html("Progress: \(self.xPosition)"))
    }else{
        return .ok(.html("No progress"))
    }
    }
}

We start the server listening on port 12345 with server.start(12345) and add a route for /progress/:progress. We're listening to a GET request on localhost:12345/progress/<number>. Those call updateProgress().

The updateProgress function does a lot of confusing work to convert a maybe string into a computable number. Then it updates self.xPosition with the new position based on progress percentage.

Updating xPosition automatically triggers a redraw... somehow. shrug

That's all the machinery we need to update our Touchbar from anywhere. Next step is to add an HTTP call to the Webpack progress plugin.

Like this:

// index.js
function onProgress(...) {
    // ...
  if (options.sendProgressToTouchbar) {
      sendProgressToTouchbar(progress, options);
  }

    // ...
}

function sendProgressToTouchbar(progress, options) {
    var http = require('http');
    var req = http.request({
        port: options.touchbarPort,
        hostname: '127.0.0.1',
        method: 'GET',
        path: '/progress/'+Math.round(progress*100)
    });
    req.end();

}

nyan-progress-webpack-plugin already has a function hooked into onProgress updates from Webpack's machinery. We added an HTTP call to our Touchbar app via sendProgressToTouchbar.

sendProgressToTouchbar uses node's built-in HTTP client to make a GET request and update the touchbar. There is no error handling because we're lazy and don't care enough.

That's all the code it took. Thank you, open source community, for making hacks like this easy to build.

Here's Why This Is Impractical

Apple has decided that the Touchbar should only be controlled by the application that's currently in focus. That means you can only use your Touchbar to see Webpack progress when you're actively focusing on touchbar_webpack_progress.

This makes it useless. 

Here's where I hope the open source community will step in. Take your favorite editor and add this as a plugin. If your editor is running this sort of code, it can show Webpack progress while you continue to write code.

This is the recipe I envision:

  1. Be an editor, use Touchbar integration maybe (iA Writer has formatting, Emacs ignores my Touchbar).
  2. Start server, listen on 12345
  3. When progress request comes, switch Touchbar to the progress indicator.
  4. Keep updating until 100%.
  5. Switch back to normal Touchbar functionality.

Can you help make that? Please make it.

Here's all the code: the macOS app and the Webpack plugin.

Crafter is a modern CMS platform for building modern websites and content-rich digital experiences. Download this eBook now. Brought to you in partnership with Crafter Software.

Topics:
web dev ,webpack ,web application development ,open source

Published at DZone with permission of Swizec Teller, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}