How are you all testing and debugging your connections before going to prod?

Open
#339 0 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript

Research direction

Start by reading the Code Connect documentation and the CLI paths for publishing and unpublishing connections; the issue does not name specific files or tests. Identify how developers can test connections safely and diagnose the reported “No Code Connect CLI mapping found for this component” error. Done means the project has a documented or implemented way to test and debug connections without duplicating a production Figma file.

Written by the indexing model from the issue text.

Description

API question

Didn't see this mentioned anywhere in the docs. How are we supposed to be testing Code Connect files? Is the expectation that we just publish / unpublish code until it's working as expected?

Right now I'm just making a duplicate of our design system components file, and using that as my "test" environment, but this isn't very sustainable long-term. There has to be a better way, so my question is how are you all doing this?

To give an example of why this is problematic - I'm running into the error "No Code Connect CLI mapping found for this component" when trying to unpublish some connections, and there is no way to see why that's happening. I seemingly can't unpublish a connection at all in some cases. The only way to "reset" is is by creating a new duplicate of the component file, but that's not going to be an option when publishing changes on the production Figma file. How are we supposed to debug issues like these?

Dominant language
TypeScript
Stars
1.6k
Forks
126
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from figma/code-connect

All issues in figma/code-connect

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.