Skip to content

chore: Skip as keyword and aliases in barrel files when checking public APIs #5945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 30, 2025
Merged

chore: Skip as keyword and aliases in barrel files when checking public APIs #5945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c1089cf
fix: ignore as aliases in barrel files
ZhongpinWang Jul 24, 2025
a590d7a
Changes from lint:fix
Jul 24, 2025
ace83c0
Changes from lint:fix
Jul 24, 2025
387c82f
Merge branch 'main' into chore-skip-aliases-in-barrel-files-for-publi…
deekshas8 Jul 30, 2025
d94dced
Merge branch 'main' into chore-skip-aliases-in-barrel-files-for-publi…
ZhongpinWang Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/actions/check-public-api/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions build-packages/check-public-api/check-public-api.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,9 +235,11 @@ export declare type MyType = {value:string}

const dummyIndexFile = `export { o1 } from './bla';

export { o2, o3 } from './bla';
export { o4,

export { o2, o3 as o3$Some_thing } from './bla'; // :-) This is a comment
export { o4 as o4Something,
/****
* * This is a block comment **??? *
* **/
o5,o6,
o7} from './bla';
`;
8 changes: 6 additions & 2 deletions build-packages/check-public-api/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,13 +268,17 @@ export function parseExportedObjectsInFile(
/**
* Parse a barrel file for the exported objects.
* It selects all string in \{\} e.g. export \{a,b,c\} from './xyz' will result in [a,b,c].
* /\/\*[\s\S]*?\*\/|\/\/.*|[\s]+/g - Matches single-line comments or multi-line comments or whitespaces.
* Aliases defined with 'as' keyword are removed.
* @param fileContent - Content of the index file to be parsed.
* @param regex - Regular expression used for matching exports.
* @returns List of objects exported by the given index file.
*/
export function parseBarrelFile(fileContent: string, regex: RegExp): string[] {
const normalized = fileContent.replace(/\/\*[\s\S]*?\*\/|\/\/.*|[\s]+/g, '');
// Remove block comments, single-line comments, 'as' keyword and aliases, and whitespace characters
const normalized = fileContent.replace(
/\/\*[\s\S]*?\*\/|\/\/.*|[\s]+as[\s]+[a-zA-Z_$][0-9a-zA-Z_$]*|[\s]+/g,
''
);
const groups = captureGroupsFromGlobalRegex(regex, normalized);

return flatten(groups.map(group => group.split(',')));
Expand Down
Loading