Skip to content

Latest commit

 

History

History

cuttings

@figmarine/cuttings

A Node.js library to download Figma files and their metadata, and to store them as JSON files.

Status: to do commit activity last commit open issues CodeQL status CI status code coverage contributors code of conduct: contributor covenant 2.1 license forks stars sponsor this project


📔 Table of Contents

🌟 Package Details

Caution

Development on this package has not yet started.

🎯 Roadmap

  • Finalise cutting format (core file, facets)
  • Optimise data overlap between some facets
  • Write FS middleware to store and retrieve cuttings
  • Use REST API client to download cuttings
  • Create hydration helpers
  • Use zod for schema validation on FS-loaded files
  • Improve zod parse error printing
  • Add ability to name/describe cutting files and use the name in logs
  • Export Node.js library
  • Add unit tests
  • Document the library
  • Document the figcutting.json file format
  • Automate NPM releases

👋 Contributing

See how to contribute.

⚠️ License

Distributed under the MIT License.

🆘 Support

Please open a conversation in the discussion space to ask a question.

Please open an issue for bug reports or code suggestions.