figma-export-variables

Command line for export variables

How it works?

This script is designed to kickstart the browser, navigating through Figma's interface to extract variables. Its primary goal is to duplicate a file and retrieve the collection from the replica. Post-extraction, whether successful or not, the duplicated file undergoes deletion. A Figma login is imperative. In case it's the first login via Puppeteer, the script may launch the browser with a graphical user interface, streamlining the manual login process into Figma.

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-variables

figma-export-variables --help

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

Usage

npx figma-export-variables COMMAND

Commands

interactive

By default, the browser runs without a graphical user interface (GUI). In case of any issues, you have the option to run it with a GUI.

npx figma-export-variables --interactive

use-config

You must create a configuration file and use a single command to rule them all :ring:

Let's create the file .figmaexportvariablestrc.js and paste the following:

module.exports = {
    commands: [
        ['variables', {
            fileId: 'SOME_UNIQ_ID',
            outputters: [output]
        }]
    ]
};

:information_source: Take a look at .figmaexportvariablestrc.js.example for more details.

now you can update the package.json.

{
  "scripts": {
+   "figma-variables:export": "figma-export-variables use-config"
  }
}

If needed you can also provide a different configuration file.

{
  "scripts": {
+   "figma-variables:export": "figma-export-variables use-config .figmaexportrc.production.js"
  }
}