[DIT 11281] CLI support for components

[JWhite30515]

Overview

Adds support for fetching components via NS CLI

Context

DIT-11281: CLI support for components

Screenshots

Screen.Recording.2025-09-19.at.12.53.20.PM.mov

Test Plan

Now the CLI config file supports a components object, that specifies a folders field to filter down by folder.

The top-level field called components is mainly for ease of distinguishing b/w project and component sources, we could have just had a top-level field called folders but that wouldn't be immediately clear to user it's for Library (confusion b/w project folders + component folders)

This is for JSON formatting, so test with vue-i18n and i18next formats:

• in v5-beta CLI branch, run yarn
• Add either components: {} or components: folders: [] to existing config.yml pulling down from projects, running yarn start pull should pull down from ALL components as well as projects (with no variants filter, should see only components__base.json written to)
• Add a variants filter, either variants: [{ id: all }] or whichever ids you want to specify, pull down, should write a components file to each variant for each group of components that has that variant (e.g. if you have components with French variant, should write to components__{french_dev_id}.json
• all components, regardless of their folderId, get saved to same variant file (either components__base or components__variantId)
• In the index.js file that's generated, component files are always exported last after the project-named files
• Test removing the projects field entirely, should be allowed, on next pull it should only pull from components and write to components files
• Test removing the components field entirely, should be allowed, on next pull it should only pull from projects and write to projects files
• Add a folder devID to component: folders: [<{id: string}>], should only pull components from that folder and its children
• Add rich text to a component, add richText: html to one of your output configs, should show rich text for components with rich text
• Test specifying an extra output in outputs, that writes to another file, specify a specific set of component folders and only those components should show up in this extra output file

[JWhite30515]

since we always write components to file after writing textItems, component files will always be sorted last in the generated index.js file

[marla-hoggard]

Testing went well! I left one suggestion for a small refactor, but otherwise everything looks good. Do we want to merge this as is and then open another PR with the nested folders filter or just wait for that PR to merge and get it updated here?

We will need to be careful about the timing of merging and publishing. If we can merge to v5-beta without releasing the update externally, then we can go ahead and merge any time. But I think we should wait to publish again until:

1. This is updated with the new nested folder param + root support
2. We publicly release component dev ids

[marla-hoggard]

I'm curious why we didn't need these before and do now?

[JWhite30515]

I pulled these out into instance variables so that they can be referenced transformAPITextEntity, which handles writing to these files for a given textItem/component returned from API response

transformAPITextEntity is called on each text entity returned from API, to avoid code duplication for comps and textItems

[JWhite30515]

Pushed up nit fix to split filter functions, and added some improved error logging-- I was seeing "Invalid project filters" error, which was pretty vague and made me think I'd messed up my config, but what happened was I had renamed a project's devId.

Added some extra metadata to error logs so it's clearer when we get a 400 with response data:

[marla-hoggard]

@JWhite30515 This looks good except for the excludeNestedFolders param isn't recognized. I'm testing with that branch pulled down locally. Let's get that functionality added here so we only have to publish one new version.

We will also need to make sure we're doing versioning correctly - think we have to update the version in package.json before we merge.

[JWhite30515]

Now that root and excludeNestedFolders are supported, updated this PR to support them as well and upgraded version, should be good to go

Screen.Recording.2025-09-25.at.1.52.00.PM.mov

[marla-hoggard]

Still looks good! I tested again with root and excludeNestedFolders and all still looks good.

I'm approving but don't merge this just yet. We'll coordinate merging this in the proper sequence with the other related pieces on Monday.

[marla-hoggard]

We are actually moving to v8. Looks like the steps to properly release v7 last month were not followed, missing the version bump and publishing release notes 😬

Suggested change

	"version": "5.0.0-beta.7",
	"version": "5.0.0-beta.8",