Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sidnioulz/figmarine
Figue marine, Carpobrotus edulis - A collection of tools for frontend and DevOps engineers who use Figma.
https://github.com/sidnioulz/figmarine
eslint figma openapi-specification
Last synced: 4 months ago
JSON representation
Figue marine, Carpobrotus edulis - A collection of tools for frontend and DevOps engineers who use Figma.
- Host: GitHub
- URL: https://github.com/sidnioulz/figmarine
- Owner: Sidnioulz
- License: mit
- Created: 2024-08-21T08:45:16.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-11T21:26:36.000Z (4 months ago)
- Last Synced: 2024-10-11T22:40:19.965Z (4 months ago)
- Topics: eslint, figma, openapi-specification
- Language: TypeScript
- Homepage:
- Size: 5.79 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Figmarine
Figue marine, Carpobrotus Edulis. Tools for frontend and DevOps engineers who use Figma.
📗 Documentation
·
🐛 Report a Bug
·
💡 Suggest Linting Rule
---
> [!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.
## :notebook_with_decorative_cover: Table of Contents
- [Key Projects](#star2-key-projects)
- [Nursery](#nursery)
- [REST API Client](#rest-api-client)
- [GraphQL Client](#graphql-client)
- [ESLint Plugin](#eslint-plugin)
- [Contributing](#package-contributing)
- [Code of Conduct](#code-of-conduct)
- [Contributor License Agreement](#contributor-license-agreement)
- [Getting Started](#getting-started)
- [Pull Requests](#pull-requests)
- [Release System](#release-system)
- [Support](#sos-support)
- [Contact](#envelope-contact)
- [Acknowledgments](#yellow_heart-acknowledgments)
- [Thanks](#thanks)
- [Built With](#built-with)
## :star2: Key Projects
REST API Client
A fully-typed JS client for the REST API, generated from an OpenAPI Spec.
Cuttings
A library that creates JSON representations of Figma content (files, styles, etc.).
Nursery
A library for fetching, storing and rehydrating cuttings automatically.
ESLint Plugin
An ESLint plugin that can parse Figma cutting files and run rules against them.
## :package: Contributing
### Code of Conduct
Please read the [Code of Conduct](https://github.com/Sidnioulz/figmarine/blob/main/CODE_OF_CONDUCT.md) 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](https://developercertificate.org/) (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](https://pnpm.io/installation)
- 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
## :sos: Support
Please open a conversation in the [discussion space](https://github.com/Sidnioulz/figmarine/discussions) to propose a new linting rule or ask a question.
Please [open an issue](https://github.com/Sidnioulz/figmarine/issues/new) for bug reports or code suggestions.
## :envelope: Contact
Steve Dodier-Lazaro · `@Frog` on the [Friends of Figma Discord](https://discord.gg/figma) - [LinkedIn](https://www.linkedin.com/in/stevedodierlazaro/)
Project Link: [https://github.com/Sidnioulz/figmarine](https://github.com/Sidnioulz/figmarine)
## :yellow_heart: Acknowledgments
### Thanks
- Photo by Michal Klajban, under a [Creative Commons BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en) license
- Thanks to [Nicholas C. Zakas](https://github.com/nzakas) for his help in bootstrapping the ESLint plugin
- Thanks to [Louis3797](https://github.com/Louis3797) for his Readme template
### Built With
[](https://axios-http.com/)
[](https://github.com/dependabot)
[](https://eslint.org/)
[](https://github.com/figma/rest-api-spec/)
[](https://github.com/solutions/ci-cd)
[](https://prettier.io/)
[](https://tsup.egoist.dev/)
[](https://turbo.build/)
[](https://www.typescriptlang.org/)
[](https://https://vitest.dev/)