This package is an ESLint plugin that can process JSON representations of Figma files and run rules against them, allowing you to build your own linting logic for your design team's output.
Figma files are identified by their file keys and fetched with the Figma REST API. The fetched files are stored in a local cache as JSON data, and can be augmented with additional facets like variables, comments, dev resources, as well as special metadata provided by the (upcoming) accompanying Figma Plugin. File content is then exposed as a JSON AST, with modified types so that rules can target Figma-specific concepts like components, frames, canvases, variables and so on.
This project is currently at the Proof-of-Concept stage, attempting to run a few basic rules to demonstrate the feasibility of the approach. Documentation for the rules API will be provided once that stage is completed.
TODO -> Please open an issue. I am very interested in hearing what rules you want to enforce and why.
An ESLint plugin that can parse Figmarine cuttings and run rules against them.
TODO
Install the package with the following command:
pnpm i eslint-plugin-figmaThen, TODO:
TODOClone the project
git clone https://github.com/Sidnioulz/figmarine.gitGo to the project directory
cd packages/eslint-plugin-figmaInstall dependencies
pnpm installTODO -> this one will be harder
TODO move roadmap here
See how to contribute.
Distributed under the MIT License.
Please open a conversation in the discussion space to ask a question.
Please open an issue for bug reports or code suggestions.
- TODO