diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 19db027..9c5e0db 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for the project. title: '' -labels: '' +labels: 'feature request' assignees: '' --- diff --git a/.gitignore b/.gitignore index de6569f..691d21f 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,5 @@ bundle/ .swiftpm/ bundle-cli webpack-dist +bundle-npm +bundle-local diff --git a/CHANGELOG.md b/CHANGELOG.md index c225c67..818418d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,134 @@ +# Code Connect v1.2.2 (5th November 2024) + +## Features + +### General +- Added support to create Custom parsers. Those allow users to add support for languages which aren't natively supported by Code Connect. Check the [documentation](https://github.com/figma/code-connect/blob/main/docs/custom.md) for more details. + +## Fixed + +### React +- Only show AI question for React +- Fix error in autolinking in reduce function + +# Code Connect v1.2.1 (23rd October 2024) + +### General +- Added a `--exit-on-unreadable-files` flag to all commands to exit if any Code Connect files cannot be parsed. We recommend using this option for CI/CD. + +## Fixed + +### React +- Fixed a bug introduced in 1.2.0 where `nestedProps` referencing a hidden layer would result in an error rendering Code Connect + +### SwiftUI +- Fixed potential "index is out of bounds" error. + +### General +- Changed how the extension makes HTTP requests to resolve issues when connecting through a proxy. Please [submit a support ticket](https://help.figma.com/hc/en-us/requests/new?ticket_form_id=360001744374) if you continue to have connection issues after this update. + +### Compose + +- Fixed some parsing errors when running the `create` and `publish` commands + +# Code Connect v1.2.0 + +## Features + +### General +- The interactive setup now offers AI support for accurate prop mapping between Figma and code components. Users will now be given the option to use AI during the setup process, which if chosen will assist in creating Code Connect files and attempting to accurately map your code to Figma properties. + + Data is used only for mapping and is not stored or used for training. To learn more, visit https://help.figma.com/hc/en-us/articles/23920389749655-Code-Connect + +### React +- Added support for returning strings or React components from the `example` function, in addition to JSX +- Added `getProps` on `figma.instance()` which can be used to access props of a nested connected component +- Added `render` on `figma.instance()` which can be used to render a nested connected component dynamically +- Added support for including any custom props in the `props` object, that can be accessed with `getProps` in a parent component + +## Fixed + +### HTML +- Case of attribute names is now preserved to support Angular (fixes https://github.com/figma/code-connect/issues/172) +- Fixed a bug with `nestedProps` (fixes https://github.com/figma/code-connect/issues/176) + +## Fixed + +# Code Connect v1.1.4 (26th September 2024) + +## Fixed + +### React +- Fixed a Prettier bug with the interactive setup +- Removed empty enum mappings from generated Code Connect in interactive setup +- Fixed an issue with props not rendering correctly in the Figma UI if used in the body of a component (e.g. as a hook argument). Any Code Connect with this issue will need republishing to be fixed. (fixes https://github.com/figma/code-connect/issues/167) +- Support mapping from an enum value to a boolean prop in CLI Assistant + +## Features + +### Compose +- The dependencies required to author Code Connect files now live in a separate module from the plugin and are hosted on Maven Central. Refer to the [documentation](docs/compose.md) for updated instructions on adding Code Connect to your project. + +### SwiftUI +- Updated the swift-syntax dependency to include 600.0.0 (Swift 6) + +# Code Connect v1.1.3 (11th September 2024) + +## Fixed + +### HTML +- Fixed an issue where `imports` was incorrectly not included in the TypeScript interface +- Added a note in the [documentation](docs/html.md) that HTML support requires `moduleResolution: "NodeNext"` + +### React +- Fixed an issue where `imports` was incorrectly not included in the TypeScript interface (fixes https://github.com/figma/code-connect/issues/159) + +## Features + +### React +- Code Connect files created in the CLI assistant will now start try to use auto-generated prop mappings in the component props. This is an early feature and support for different types is limited. + +# Code Connect v1.1.2 (10th September 2024) + +## Fixed + +### React +- Fixed an issue with `client` export used by the icon script (fixes https://github.com/figma/code-connect/issues/156) + +# Code Connect v1.1.1 (10th September 2024) + +## Fixed + +### General +- Fixed an issue where the `@figma/code-connect@1.1.0` npm package had an incorrect README + +# Code Connect v1.1.0 (10th September 2024) + +## Features + +### HTML +- Added support for documenting HTML-based frameworks (including Web Components, Angular and Vue), using the new `html` parser. See the [documentation](docs/html.md) for more information. + + HTML support for Code Connect is in preview, and the API is liable to change during this period. Please let us know your feedback via [GitHub Issues](https://github.com/figma/code-connect/issues/new/choose). + +### SwiftUI +- Added a `swiftPackagePath` configuration option to specify a custom path to a `Package.swift` file to run Code Connect from. + +### React +- Code Connect files created in the CLI assistant will now start including some auto-generated prop mappings between Figma properties and linked code props. This is an early feature and support for different prop types is limited. + +### General + +- Restructured the Code Connect documentation. All documentation can now be found in the [docs](docs) directory. + +## Fixed + +### React +- `figma.nestedProps` can now be used in conjunction with `figma.boolean` for conditionally hidden nested instances (fixes https://github.com/figma/code-connect/issues/118, https://github.com/figma/code-connect/issues/89) +- Fixed an issue where backticks could not be used in the example code (fixes https://github.com/figma/code-connect/issues/139) +- Fixed an issue with wildcard paths in import mappings +- Fixed an error when trying to use the icon script with component sets + # Code Connect v1.0.6 (21st August 2024) ## Fixed @@ -7,7 +138,6 @@ ## Features - ### React - figma.enum now supports floating point numbers @@ -154,10 +284,10 @@ ### React -- Added support for [nested properties](cli/README.md#nested-properties), using `figma.nestedProps` -- Added support for [concatenating strings for CSS class names](cli/README.md#classname), using `figma.className` -- Added support for [text content from layers](cli/README.md#text-content), using `figma.textContent` -- Added support for [wildcards](cli/README.md#wildcard-match) with `figma.children` +- Added support for [nested properties](docs/react.md#nested-properties), using `figma.nestedProps` +- Added support for [concatenating strings for CSS class names](docs/react.md#classname), using `figma.className` +- Added support for [text content from layers](docs/react.md#text-content), using `figma.textContent` +- Added support for [wildcards](docs/react.md#wildcard-match) with `figma.children` ### SwiftUI diff --git a/Package.resolved b/Package.resolved index 47b3c84..00ea305 100644 --- a/Package.resolved +++ b/Package.resolved @@ -14,8 +14,8 @@ "kind" : "remoteSourceControl", "location" : "https://github.com/apple/swift-syntax", "state" : { - "revision" : "64889f0c732f210a935a0ad7cda38f77f876262d", - "version" : "509.1.1" + "revision" : "2bc86522d115234d1f588efe2bcb4ce4be8f8b82", + "version" : "510.0.3" } }, { diff --git a/Package.swift b/Package.swift index 6d2317e..b7a16f5 100644 --- a/Package.swift +++ b/Package.swift @@ -15,7 +15,7 @@ let package = Package( .executable(name: "figma-swift", targets: ["CodeConnectCLI"]) ], dependencies: [ - .package(url: "https://github.com/apple/swift-syntax", from: "509.1.1"), + .package(url: "https://github.com/apple/swift-syntax", "510.0.3"..."600.0.0"), .package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"), .package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.49.0"), ], diff --git a/README.md b/README.md index a890573..e26a763 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Code Connect is a tool for connecting your design system components in code with your design system in Figma. When using Code Connect, Figma's Dev Mode will display true-to-production code snippets from your design system instead of autogenerated code examples. In addition to connecting component definitions, Code Connect also supports mapping properties from code to Figma enabling dynamic and correct examples. This can be useful for when you have an existing design system and are looking to drive consistent and correct adoption of that design system across design and engineering. -Code Connect is easy to set up, easy to maintain, type-safe, and extensible. Out of the box Code Connect comes with support for React (and React Native), Storybook, SwiftUI and Jetpack Compose. +Code Connect is easy to set up, easy to maintain, type-safe, and extensible. Out of the box Code Connect comes with support for React (and React Native), Storybook, HTML (e.g. Web Components, Angular and Vue), SwiftUI and Jetpack Compose. ![image](https://static.figma.com/uploads/d98e747613e01685d6a0f9dd3e2dcd022ff289c0.png) @@ -11,7 +11,7 @@ Code Connect is easy to set up, easy to maintain, type-safe, and extensible. Out ## CLI installation -To install Code Connect locally to a React project, you can follow the instructions in the [React README](cli/README.md#installation). +To install Code Connect locally to a React project, you can follow the instructions in the [React README](docs/react.md#installation). For other platforms, you first need to have Node.js v16 or newer installed on your computer. You can check if you already have Node.js installed and which version by running `node -v`. If you need to install Node.js, instructions for all platforms can be found [on the Node.js website](https://nodejs.org/en/download/package-manager). @@ -25,9 +25,10 @@ We hope to provide a way to install Code Connect without requiring Node.js soon. To learn how to implement Code Connect for your platform, please navigate to the platform-specific API usage and documentation. -- [React (or React Native)](cli/README.md) -- [SwiftUI](swiftui/README.md) -- [Jetpack Compose](compose/README.md) +- [React (or React Native)](docs/react.md) +- [HTML (Web Components, Angular, Vue, etc.)](docs/html.md) +- [SwiftUI](docs/swiftui.md) +- [Jetpack Compose](docs/compose.md) ## General configuration @@ -37,7 +38,7 @@ Every platform supports some common configuration options, in addition to any pl ### `include` and `exclude` -`include` and `exclude` are lists of globs for where to parse Code Connect files, and for where to search for your component code when using the [interactive setup](cli/README.md#interactive-setup). `include` and `exclude` paths must be relative to the location of the config file. +`include` and `exclude` are lists of globs for where to parse Code Connect files, and for where to search for your component code when using the [interactive setup](docs/react.md#interactive-setup). `include` and `exclude` paths must be relative to the location of the config file. ```jsonp { @@ -53,10 +54,11 @@ Every platform supports some common configuration options, in addition to any pl Code Connect will attempt to determine your project type by looking the first ancestor of the working directory which matches one of the following: - If a `package.json` containing `react` is found, your project is detected as React +- If a `package.json` is found not containing `react`, your project is detected as HTML - If a file matching `Package.swift` or `*.xcodeproj` is found, your project is detected as Swift - If a file matching `build.gradle.kts` is found, your project is detected as Jetpack Compose -In case this does not correctly work for your project, you can override the project type by using the `parser` configuration key. Valid values are `react`, `swift` and `compose`. +In case this does not correctly work for your project, you can override the project type by using the `parser` configuration key. Valid values are `react`, `html`, `swift` and `compose`. ```jsonp { @@ -66,6 +68,10 @@ In case this does not correctly work for your project, you can override the proj } ``` +### `label` + +`label` allows you to specify the label used in Figma for your Code Connect docs. This defaults to the type of your project (e.g. `React`). You can override this to show a different name in the UI, which can be useful for e.g. showing different versions of the code. + ### `documentUrlSubstitutions` `documentUrlSubstitutions` allows you to specify a set of substitutions which will be run on the `figmaNode` URLs when parsing or publishing documents. diff --git a/cli/README.md b/cli/README.md index ee4d962..7626aa6 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,596 +1,3 @@ -# Code Connect (React) +See the [main README](../README.md) for Code Connect documentation. -For more information about Code Connect as well as guides for other platforms and frameworks, please [go here](../README.md). - -This documentation will help you connect your React (or React Native) components with Figma components using Code Connect. We'll cover basic setup to display your first connected code snippet, followed by making snippets dynamic by using property mappings. Code Connect for React works as both a standalone implementation and as an integration with existing Storybook files to enable easily maintaining both systems in parallel. - -## Installation - -Code Connect is used through a command line interface (CLI). The CLI comes bundled with the `@figma/code-connect` package, which you'll need to install through `npm`. This package also includes helper functions and types associated with Code Connect. - -```sh -npm install @figma/code-connect -``` - -## Basic setup - -To connect your first component go to Dev Mode in Figma and right-click on the component you want to connect, then choose `Copy link to selection` from the menu. Make sure you are copying the link to a main component and not an instance of the component. The main component will typically be located in a centralized design system library file. Using this link, run `figma connect create` from inside your React project. Note that depending on what terminal software you're using, you might need to wrap the URL in quotes. - -```sh -npx figma connect create "https://..." --token -``` - -This will create a Code Connect file with some basic scaffolding for the component you want to connect. By default this file will be called `.figma.tsx` based on the name of the component in Figma. However, you may rename this file as you see fit. The scaffolding that is generated is based on the interface of the component in Figma. Depending on how closely this matches your code component you'll need to make some edits to this file before you publish it. - -Some CLI commands, like `create`, require a valid [authentication token](https://help.figma.com/hc/en-us/articles/8085703771159-Manage-personal-access-tokens) with write permission for the Code Connect scope as well as the read permission for the File content scope. You can either pass this via the `--token` flag, or set the `FIGMA_ACCESS_TOKEN` environment variable. The Figma CLI reads this from a `.env` file in the same folder, if it exists. - -To keep things simple, we're going to start by replacing the contents of the generated file with the most basic Code Connect configuration possible to make sure everything is set up and working as expected. Replace the contents of the file with the following, replacing the `Button` reference with a reference to whatever component you are trying to connect. The object called by `figma.connect` is your Code Connect doc. - -```tsx -import figma from '@figma/code-connect' -import { Button } from 'src/components' - -figma.connect(Button, 'https://...', { - example: () => { - return - ) - }, -}) -``` - -And this is how we would achieve the same thing using the Storybook integration. Notice how this works well with existing `args` configuration you may already be using in Storybook. - -```tsx -import figma from "@figma/code-connect" - -export default { - component: Button, - parameters: { - design: { - type: 'figma', - url: 'https://...', - examples: [ButtonExample], - props: { - label: figma.string('Text Content'), - disabled: figma.boolean('Disabled'), - type: figma.enum('Type', { - Primary: ButtonType.Primary, - Secondary: ButtonType.Secondary - }, - }, - }, - argTypes: { - label: { control: 'string' }, - disabled: { control: 'boolean' }, - type: { - control: { - type: 'select', - options: [ButtonType.Primary, ButtonType.Secondary] - } - } - }, - args: { - label: 'Hello world', - disabled: false, - type: ButtonType.Primary - } - } -} - -export function ButtonExample({ label, disabled, type }) { - return -} -``` - -The `figma` import contains helpers for mapping all sorts of properties from design to code. They work for simple mappings where only the naming differs between Figma and code, as well as more complex mappings where the type differs. See the below reference for all the helpers that exist and the ways you can use them to connect Figma and code components using Code Connect. - -### figma.connect - -`figma.connect()` has two signatures for connecting components. - -``` -// connect a component in code to a Figma component -figma.connect(Button, "https://...") - -// connect a Figma component to e.g a native element -figma.connect("https://...") -``` - -The second option is useful if you want to just render a HTML tag instead of a React component. The first argument is used to determine where your component lives in code, in order to generate an import statement for the component. This isn't needed if you just want to render e.g a `button` tag. - -``` -figma.connect("https://...", { - example: () => -}) -``` - -### Strings - -Strings are the simplest value to map from Figma to code. Simply call `figma.string` with the Figma prop name you want to reference as a parameter. This is useful for things like button labels, header titles, tooltips, etc. - -```tsx -figma.string('Title') -``` - -### Booleans - -Booleans work similar to strings. However Code Connect also provides helpers for mapping booleans in Figma to more complex types in code. For example you may want to map a Figma boolean to the existence of a specific sublayer in code. In addition to mapping boolean props, `figma.boolean` can be used to map boolean Variants in Figma. A boolean Variant is a Variant with only two options that are either "Yes"/"No", "True"/"False" or "On"/Off". For `figma.boolean` these values are normalized to `true` and `false`. - -```tsx -// simple mapping of boolean from figma to code -figma.boolean('Has Icon') - -// map a boolean value to one of two options of any type -figma.boolean('Has Icon', { - true: , - false: , -}) -``` - -In some cases, you only want to render a certain prop if it matches some value in Figma. You can do this either by passing a partial mapping object, or setting the value to `undefined`. - -```tsx -// Don't render the prop if 'Has label' in figma is `false` -figma.boolean('Has label', { - true: figma.string('Label'), - false: undefined, -}) -``` - -### Enums - -Variants (or enums) in Figma are commonly used to control the look and feel of components that require more complex options than a simple boolean toggle. Variant properties are always strings in Figma but they can be mapped to any type in code. The first parameter is the name of the Variant in Figma, and the second parameter is a value mapping. The _keys_ in this object should match the different options of that Variant in Figma, and the _value_ is whatever you want to output instead. - -```tsx -// maps the 'Options' variant in Figma to enum values in code -figma.enum('Options', { - 'Option 1': Option.first, - 'Option 2': Option.second, -}) - -// maps the 'Options' variant in Figma to sub-component values in code -figma.enum('Options', { - 'Option 1': , - 'Option 2': , -}) - -// result is true for disabled variants otherwise undefined -figma.enum('Variant', { Disabled: true }) - -// enums mappings can be used to show a component based on a Figma variant -figma.connect(Modal, 'https://...', { - props: { - cancelButton: figma.enum('Type', { - Cancellable: , - }), - // ... - }, - example: ({ cancelButton }) => { - return ( - - Title - Some content - {cancelButton} - - ) - }, -}) -``` - -Mapping objects for `figma.enum` as well as `figma.boolean` allows nested references, which is useful if you want to conditionally render a nested instance for example. (see the next section for how to use `figma.instance`) - -```tsx -// maps the 'Options' variant in Figma to enum values in code -figma.enum('Type', { - WithIcon: figma.instance('Icon'), - WithoutIcon: undefined, -}) -``` - -Note that in contrast to `figma.boolean`, values are _not_ normalized for `figma.enum`. You always need to pass the exact literal values to the mapping object. - -```tsx -// These two are equivalent for a variant with the options "Yes" and "No" -disabled: figma.enum("Boolean Variant", { - Yes: // ... - No: // ... -}) -disabled: figma.boolean("Boolean Variant", { - true: // ... - false: // ... -}) -``` - -### Instances - -Instances is a Figma term for nested component references. For example, in the case of a `Button` containing an `Icon` as a nested component, we would call the `Icon` an instance. In Figma instances can be properties, (that is, inputs to the component), just like we have render props in code. Similarly to how we can map booleans, enums, and strings from Figma to code, we can also map these to instance props. - -To ensure instance properties are as useful as possible with Code Connect, it is advised that you also provide Code Connect for the common components which you would expect to be used as values to this property. Dev Mode will automatically hydrate the referenced component's connected code snippet example and how changes it in Dev Mode for instance props. - -```tsx -// maps an instance-swap property from Figma -figma.instance('PropName') -``` - -The return value of `figma.instance` is a JSX component and can be used in your example like a typical JSX component prop would be in your codebase. - -```tsx -figma.connect(Button, 'https://...', { - props: { - icon: figma.instance('Icon'), - }, - example: ({ icon }) => { - return - }, -}) -``` - -You should then have a separate `figma.connect` call that connects the Icon component with the nested Figma component. Make sure to connect the backing component of that instance, not the instance itself. - -```tsx -figma.connect(Icon32Add, 'https://...') -``` - -### Instance children - -It's common for components in Figma to have child instances that aren't bound to an instance-swap prop. Similarly to `figma.instance`, we can render the code snippets for these nested instances with `figma.children`. This helper takes the _name of the instance layer within the parent component_ as its parameter, rather than a Figma prop name. - -To illustrate this, consider the layer hierarchy in a component vs an instance of that component: - -Button (Component) -Icon (Instance) -- "Icon" is the original name of the layer, this is what you should pass to `figma.children()` - -Button (Instance) -RenamedIcon (Instance) -- here the instance layer was renamed, which won't break the mapping since we're not using this name - -Note that the nested instance also must be connected separately. - -> Layer names may differ between variants in a component set. To ensure the component (Button) can render a nested instance (Icon) for any of those variants, you must either use the wildcard option `figma.children("*")` or ensure that the layer name representing the instance (Icon) is the same across all variants of your component set (Button). - -```tsx -// map one child instance with the layer name "Tab" -figma.children('Tab') - -// map multiple child instances by their layer names to a single prop -figma.children(['Tab 1', 'Tab 2']) -``` - -### Wildcard match - -`figma.children()` can be used with a single wildcard '\*' character, to partially match names or to render any nested child. Wildcards cannot be used with the array argument. Matches are case sensitive. - -```tsx -// map any (all) child instances -figma.children('*') - -// map any child instances that starts with "Icon" -figma.children('Icon*') -``` - -### Nested properties - -In cases where you don't want to connect a child component, but instead map its properties on the parent level, you can use `figma.nestedProps()` to achieve this. This helper takes the name of the layer as it's first parameter, and a mapping object as the second parameter. These props can then be referenced in the example function. `nestedProps` will always select a **single** instance, and cannot be used to map multiple children. - -```tsx -// map the properties of a nested instance named "Button Shape" -figma.connect(Button, "https://...", { - props: { - buttonShape: figma.nestedProps('Button Shape', { - size: figma.enum({ ... }), - }) - }, - example: ({ buttonShape }) => -} -``` - -### className - -For mapping figma properties to a className string, you can use the `figma.className` helper. It takes an array of strings and returns the concatenated string. Any other helper that returns a string (or undefined) can be used in conjunction with this. Undefined values or empty strings will be filtered out from the result - -```tsx -figma.connect("https://...", { - props: { - className: figma.className([ - 'btn-base', - figma.enum("Size", { Large: 'btn-large' }), - figma.boolean("Disabled", { true: 'btn-disabled', false: '' }), - ]) - }, - example: ({ className }) =>