Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
73 lines (49 sloc) 4.15 KB
id title permalink layout category prev next
Extending Bit

Bit uses compilers, which are environments - a special kind of extension, in order to build components. Since there are so many build tools and configurations, some of you might discover that the existing compilers don't fit their requirements. Compilers are bit components in their own right, and anyone can develop a new compiler. In this section, we'll learn how.

Compiler interface

The compiler interface you should adhere to is pretty simple:

function compile(files, distPath) { 
    // Your code here...

    return compiledFilesArray;

module.exports = {

As you can see, it all happens in the compile function. It expects two arguments:

  • files - an array of the component's files. Each file is a vinyl file. You can take a look at a file object's API here.
  • distPath - the dist directory path, as the user had defined.

The compile function should return an array of the compiled vinyl files. Just remember not all the component's files are compiled, and you should return all the component's files.

How compiling a component usually works

As we've gained experience in developing compilers for bit components, we've noticed there's a pattern, a number of stages for the compiling algorithm:

  • First, you should go over all the files and determine which ones should be compiled. Keep in mind that a component contains your code, but can also contain markdown files, image files, style sheets and more...
  • Compile the appropriate files using your chosen method
  • Return an array of all the files (compiled and non-compiled). Their paths should be distPath + relativePath.


When a compiler is imported to a local Scope, its dependencies are installed as well. You should make sure bit recognizes the compiler's dependencies, so it will later install them properly. A require/import statement is enough for bit, but there are two edge-cases where you should add require statements:

  • Invoking a dependency with require.resolve won't help bit recognize it. That's one case in which you should add another require statement. This usually happens with babel plugins and presets. Here's a good example.
  • Sometimes the tools you use require peer dependencies. There may not be require statements for those dependencies, so just make sure to add them if needed, if you want those to be installed.

So you've written a compiler. What's next?

First, as with any component, track, tag and export the component. Then, import the new environment to your local Scope.

Debugging your compiler

In order to debug your compiler, first import it as you would any other component (e.g not as an environment). Next, head over to the compiler's code, and add the following lines:

const vinylFile = require('vinyl-file');
const file = vinylFile.readSync('first/file/path');
const file2 = vinylFile.readSync('second/file/path');


These lines load all the component files (here we have just two files as an example) as vinyl files, and invoke the compile function with the files and a dist path. Now you can run this file and debug as you would any other code file.

Learn straight from the source

The best examples for compilers can be found in bit's environments Scope. Take a look and learn from us.