@proxy-figma-export/cli
    TypeScript icon, indicating that this package has built-in type declarations

    3.2.10 • Public • Published

    @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

    use-config

    This command is well-explained into the project README. Look at advanced section.

    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 npm

    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-es6 npm
    @figma-export/output-components-as-stdout npm
    @figma-export/output-components-as-svg npm
    @figma-export/output-components-as-svgr npm
    @figma-export/output-components-as-svgstore npm

    styles

    Exports styles from a Figma file

    npx figma-export styles FILEID
    
    # help
    npx figma-export help styles

    outputters

    --outputter -O option

    npx figma-export styles FILEID -O OUTPUTTER

    An output function receives a list of styles.

    You can create you own:

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

    or install an official outputter:

    Package Version
    @figma-export/output-styles-as-css npm
    @figma-export/output-styles-as-sass npm
    @figma-export/output-styles-as-less npm

    Install

    npm i @proxy-figma-export/cli

    DownloadsWeekly Downloads

    0

    Version

    3.2.10

    License

    MIT

    Unpacked Size

    28.4 kB

    Total Files

    26

    Last publish

    Collaborators

    • avatar