fix(core): Fixed workspace setting does not append a newline to the end of a line in an existing index file #1875

[maroKanatani]

Status

READY

Description

Fixed workspace setting does not append a newline to the end of a line in an existing index file.

I don't know the details of the code, so if you think another way is better or whatever, you can close this PR.

• Fix When I set workspace and generate code, the line breaks keep increasing. #1875

Related PRs

List related PRs against other branches:

branch	PR
other_pr_production	link
other_pr_master	link

Todos

• Tests
• Documentation
• Changelog Entry (unreleased)

Steps to Test or Reproduce

Please follow the steps in the following Issue

• When I set workspace and generate code, the line breaks keep increasing. #1875

[soartec-lab]

@maroKanatani
Thank you for the nice update. I made one change request and a question

[soartec-lab]

It should be aligned with the pattern written in else.

orval/packages/orval/src/write-specs.ts

Lines 139 to 144 in 419fa48

	await fs.outputFile(
	indexFile,
	uniq(imports)
	.map((imp) => `export * from '${imp}';`)
	.join('\n') + '\n',
	);

Suggested change

	.map((imp) => `export * from '${imp}';\n`)
	.join(),
	.map((imp) => `export * from '${imp}';`)
	.join('\n'),

[maroKanatani]

I was a little worried that if I implemented it with .join('\n'), the last line would not have a newline.

"export * from './zod/pet/pet';\n" +
"export * from './zod/store/store';\n" +
"export * from './zod/user/user';\n" +
+"export * from './types';\n" // my pattern
-"export * from './types';"    // with `.join('\n')`

With .join('\n') + '\n' before the modification, a newline is inserted even if the result of uniq(imports) is empty.

[soartec-lab]

I see. You're right.

[soartec-lab]

If there is already a newline at the end, will a new definition be added below that newline?
In that case, you may need to first remove the original trailing newline and then add another trailing newline.

[maroKanatani]

If there is already a newline at the end, will a new definition be added below that newline?

No, the behavior appears to be the same, especially before this modification.

No, the behavior does not seem to change, especially before this modification.
I have confirmed that it is appended by preparing and executing petstore index.ts with a new line at the end as shown below.

before

export * from './zod/user/user';
export * from './types';
export * from './zod/store/store';
- export * from './zod/pet/pet'; // remove this line

after

export * from './zod/user/user';
export * from './types';
export * from './zod/store/store';
+ export * from './zod/pet/pet';

[maroKanatani]

@soartec-lab Thanks for the review! I have returned your comment.

[soartec-lab]

Thanks!