@figma-export/cli

Command line for @figma-export.

Install

While you can install it globally on your machine, it's much better to install it locally project by project.

npm install --save-dev @figma-export/cli

Note: If you do not have a package.json, create one before installing or run npm init -y to automatically create ones.

Usage

export FIGMA_TOKEN=<personalAccessToken>

npx figma-export COMMAND

Note: These instructions use the npx command to run the locally installed executables. You can drop it inside of an npm run script or you may instead execute with the relative path instead. ./node_modules/.bin/figma-export

Commands

help

npx figma-export help

components

Exports components from a Figma file

npx figma-export components FILEID

# help
npx figma-export help components

transformers

--transformer -T option

npx figma-export components FILEID -T TRANSFORMER

A transform function receives an SVG and turns it into something new.

You can create you own:

// with promise
module.exports = options => {
    return (svg) => new Promise((resolve, reject) => {
        resolve(svg);
    });
}

// with async/await
module.exports = options => {
    return async (svg) => {
        return svg;
    };
}

or install an official transformer:

Package	Version
@figma-export/transform-svg-with-svgo

outputters

--outputter -O option

npx figma-export components FILEID -O OUTPUTTER

An output function receives a list of pages, in which each page contains components.

You can create you own:

module.exports = options => {
    return async pages => {
        console.clear();
        console.log(JSON.stringify(pages));
    };
}

or install an official outputter:

Package	Version
@figma-export/output-components-as-svg
@figma-export/output-components-as-es6

.figmaexportrc.js

You can create a file .figmaexportrc.js or use a different configuration file providing -c or --config option to figma-export components command.

npx figma-export components FILEID -c .figmaexportrc.prod.js -T TRANSFORMER

This file contains the configs object that you can use to provide special options to transformers and outputters.

// .figmaexportrc.js

module.exports = {
  configs: [
    ['@figma-export/transform-svg-with-svgo', {
      plugins: [
        { removeViewBox: false },
        { removeDimensions: true }
      ]
    }]
  ]
};