feat: add support for the strategy parameter in component-name-unique rule by harshit078 · Pull Request #3011 · Redocly/redocly-cli

harshit078 · 2026-08-04T12:17:21Z

What/Why/How?

#2898

Reference

Testing

Screenshots (optional)

Check yourself

This PR follows the contributing guide
All new/updated code is covered by tests
Core code changed? - Tested with other Redocly products (internal contributions only)
New package installed? - Tested in different environments (browser/node)
Documentation update has been considered

Security

The security impact of the change has been considered
Code follows company security practices and guidelines

Note

Low Risk
Default behavior stays basename; changes apply only when strategy: title is configured, with broad test coverage and shared naming logic with bundle.

Overview
Adds a strategy option (basename | title, default basename) to the component-name-unique lint rule so uniqueness checks mirror what bundle will produce for --component-names-strategy.

With strategy: title, externally referenced schemas (cross-file $ref) are keyed by the sanitized PascalCase name derived from title instead of file/fragment basename—so same filenames with different titles no longer collide, while identical titles across files do. The rule also errors on referenced schemas missing title (matching bundle failure), and still uses basename for the uniqueness check when title is absent.

Title-to-name logic is extracted to shared componentNameFromTitle and wired into bundle-visitor (renamed resolver). Docs and a changeset describe configuration and link bundle to the rule; tests cover the new title behavior.

^{Reviewed by Cursor Bugbot for commit ff9deed. Bugbot is set up for automated code reviews on this repo. Configure here.}

changeset-bot · 2026-08-04T12:17:24Z

🦋 Changeset detected

Latest commit: ff9deed

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@redocly/cli	Minor
@redocly/openapi-core	Minor
@redocly/client-generator	Patch
@redocly/respect-core	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2026-08-04T12:19:56Z

Performance Benchmark (Lower is Faster)

CLI Version	Bundle	Lint	Check Config
cli-latest	▓ 1.00x ± 0.01	▓ 1.00x ± 0.01	▓ 1.00x (Fastest)
cli-next	▓ 1.00x (Fastest)	▓ 1.00x (Fastest)	▓ 1.00x ± 0.01

adamaltman · 2026-08-07T03:23:04Z

Interesting idea!

kanoru3101

Thank you for your contribution.

Three descriptions now behave differently under lint and bundle: two in my comments, plus the Bugbot one above — that one is correct, I reproduced it.
Left to do:

make the rule agree with the bundler in all three cases;
mirror the bundler's tests — none of the three cases is covered today.
The rest is in the inline comments.

kanoru3101 · 2026-08-10T16:45:40Z

+    if (
+      !useTitleStrategy ||
+      typeName !== TYPE_NAME_SCHEMA ||
+      resolved.location.source.absoluteRef === rootSourceRef


The rule skips the title strategy for every schema in the root file. The bundle command does not skip those schemas. It renames a root schema if an external file refers to it. So two schemas end up wanting the same name and the rule stays quiet.
Example

# openapi.yaml components: schemas: Foo: title: Bar thing type: object # ...a response in this file refers to ./Other.yaml

# Other.yaml title: Bar thing type: object properties: inner: $ref: './openapi.yaml#/components/schemas/Foo'

The bundle is still written, but Other.yaml gets Other, not the name from its title. The rule sees no problem here, the bundler does both and should see the same. Please check where the $ref comes from, not only where it points.

kanoru3101 · 2026-08-10T16:50:29Z

+
+    const { node } = resolved;
+    const title = isPlainObject(node) && isString(node.title) ? node.title.trim() : '';
+    return title === '' ? null : componentNameFromTitle(title);


If a schema has no title, the rule uses the file name and says nothing. The bundler doesn't stop.

# openapi.yaml openapi: 3.0.0 info: title: Referenced schema without a title version: 1.0.0 paths: /carts: get: responses: '200': description: ok content: application/json: schema: $ref: './Cart.yaml'

# Cart.yaml - no title here type: object properties: total: type: number

Lint says the description is fine, and then there is no bundle at all. The two commands disagree again, and this is the most common way the title strategy breaks, so the rule should report it:

kanoru3101 · 2026-08-10T17:02:58Z

+    }
+
+    const { node } = resolved;
+    const title = isPlainObject(node) && isString(node.title) ? node.title.trim() : '';


This duplicates code that already exists; you should consider reusing the existing logic

kanoru3101 · 2026-08-10T17:21:11Z

-          addComponentFromAbsoluteLocation(typeName, resolvedRef.location);
+          const titleName = getTitleComponentName(typeName, resolvedRef);
+          if (titleName) {
+            addFoundComponent(typeName, titleName, resolvedRef.location);


The report points at the start of the file, but the line to change is the title. Pass resolvedRef.location.child('title') here, in the same place the bundler reports at bundle-visitor.ts.

Co-authored-by: Viktor Sydor <31951646+kanoru3101@users.noreply.github.com>

kanoru3101 · 2026-08-26T07:30:48Z

Hey @harshit078 !
Just checking in on this PR. If you’re not planning to continue with it, I’d be happy to take it over and keep working on it. Let me know if that works for you!

harshit078 · 2026-08-26T07:44:38Z

Hey @kanoru3101 , I completely forgot to push my fixes for this PR and left it stale. I'll push the solution for it. Thanks !

cursor

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit ff9deed. Configure here.}

feat: add componentNameFromTitle utility function

026b58d

Merge branch 'main' into feat-support-for-strategy-parameter

f40a1e4

harshit078 and others added 5 commits August 4, 2026 23:48

feat: updated component name from title to use utility function

e970517

fix: updated bundle file for v2

ec68603

Merge branch 'main' into feat-support-for-strategy-parameter

f38370c

feat: added changeset and updated tests

1f25bc8

fix: updated to minor version

8cbffec

harshit078 marked this pull request as ready for review August 5, 2026 07:52

harshit078 requested review from a team as code owners August 5, 2026 07:52

cursor Bot reviewed Aug 5, 2026

View reviewed changes

Comment thread packages/core/src/rules/oas3/component-name-unique.ts

Merge branch 'main' into feat-support-for-strategy-parameter

12f8387

kanoru3101 reviewed Aug 10, 2026

View reviewed changes

harshit078 and others added 2 commits August 11, 2026 16:09

Update .changeset/vast-kids-add.md

b3888b9

Co-authored-by: Viktor Sydor <31951646+kanoru3101@users.noreply.github.com>

Merge branch 'main' into feat-support-for-strategy-parameter

cd72939

cursor Bot reviewed Aug 11, 2026

View reviewed changes

Comment thread packages/core/src/rules/oas3/component-name-unique.ts Outdated

Comment thread packages/core/src/rules/oas3/component-name-unique.ts Outdated

harshit078 and others added 3 commits August 26, 2026 13:14

Merge branch 'main' into feat-support-for-strategy-parameter

c89df2b

fix: address comments

d720811

Merge branch 'main' into feat-support-for-strategy-parameter

afe0a43

cursor Bot reviewed Aug 26, 2026

View reviewed changes

Comment thread packages/core/src/rules/oas3/component-name-unique.ts Outdated

fix: address cursor comment

ff9deed

cursor Bot reviewed Aug 26, 2026

View reviewed changes

Comment thread packages/core/src/rules/oas3/component-name-unique.ts

harshit078 requested a review from kanoru3101 August 26, 2026 13:03

Uh oh!

Conversation

harshit078 commented Aug 4, 2026 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

Uh oh!

changeset-bot Bot commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions Bot commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance Benchmark (Lower is Faster)

Uh oh!

Uh oh!

adamaltman commented Aug 7, 2026

Uh oh!

kanoru3101 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kanoru3101 Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kanoru3101 Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kanoru3101 Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

kanoru3101 Aug 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kanoru3101 commented Aug 26, 2026

Uh oh!

harshit078 commented Aug 26, 2026

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

harshit078 commented Aug 4, 2026 •

edited by cursor Bot

Loading

changeset-bot Bot commented Aug 4, 2026 •

edited

Loading

github-actions Bot commented Aug 4, 2026 •

edited

Loading

kanoru3101 Aug 10, 2026 •

edited

Loading

kanoru3101 Aug 10, 2026 •

edited

Loading

kanoru3101 Aug 10, 2026 •

edited

Loading