/figmarine

Figue marine, Carpobrotus edulis - A collection of tools for frontend and DevOps engineers who use Figma.

Primary LanguageTypeScriptMIT LicenseMIT

The flower of the sour fig is a large Pseudanthium inflorescence that contrasts in size with its small, elongated succulent leaves.

Figmarine

Figue marine, Carpobrotus Edulis. Tools for frontend and DevOps engineers who use Figma.

Status: Initial stages 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


Important

This is a community open-source project. It is not affiliated with Figma. This project is in its infancy. Get in touch with me before using it in production.

๐Ÿ“” Table of Contents

๐ŸŒŸ Key Projects

A fully-typed JS client for the REST API, generated from an OpenAPI Spec.
WIP A library that creates JSON representations of Figma content (files, styles, etc.).
TODO A library for fetching, storing and rehydrating cuttings automatically.
TODO An ESLint plugin that can parse Figma cutting files and run rules against them.

๐Ÿ‘ฉโ€๐Ÿ’ป Contributing

Code of Conduct

Please read the Code of Conduct first.

Developer Certificate of Origin

To ensure that contributors are legally allowed to share the content they contribute under the license terms of this project, contributors must adhere to the Developer Certificate of Origin (DCO). All contributions made must be signed to satisfy the DCO. This is handled by a Pull Request check.

By signing your commits, you attest to the following:

  1. The contribution was created in whole or in part by you and you have the right to submit it under the open source license indicated in the file; or
  2. The contribution is based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, under the same open source license (unless you are permitted to submit under a different license), as indicated in the file; or
  3. The contribution was provided directly to you by some other person who certified 1., 2. or 3. and you have not modified it.
  4. You understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information you submit with it, including your sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Getting Started

This project uses PNPM as a package manager, and Turbo as a monorepo provider.

  • See the installation instructions for PNPM
  • Clone the whole repository; all published projects depend on internal utility and config packages
  • Run pnpm i at the root of the monorepo to have everything installed
  • You can now switch to the package you're interested in working on and check its README.md

Pull Requests

Caution

TODO

Release System

Caution

TODO

๐Ÿ†˜ Support

Please open a conversation in the discussion space to propose a new linting rule or ask a question.

Please open an issue for bug reports or code suggestions.

โœ‰๏ธ Contact

Steve Dodier-Lazaro ยท @Frog on the Friends of Figma Discord - LinkedIn

Project Link: https://github.com/Sidnioulz/figmarine

๐Ÿ’› Acknowledgments

Thanks

Built With

Axios Dependabot ESLint Figma GitLab CI Prettier tsup Turbo TypeScript Vitest