Admin-Generator: Fix problems when formatting Source Code

[manuelblum]

depends on: #3564

Description

Fix eslint formatting problems in Admin Generator

While formatting generated code during writing to the disk, ESLint fails with an error, which will lead to the fact that not ESLint-formatted code will be generated by admin-generator. This produces invalid code and will fail in lint step.

1. writing (not formatted file to filesystem) - this is required, because eslint searches in the file directory if the file is present (keyword: project service) - if not present it will fail with an error and will not format the provided source code.
2. formatting file with eslint
3. writing formatted source code to the file system

This fix is necessary, because if not fixed not valid source code will be generated.

Further information

• Task: https://vivid-planet.atlassian.net/browse/COM-1684

[nsams]

I'm sorry but I don't understand the problem. I don't know what you mean by that "keyword: project service"

Is this a new problem you have with all generated files? Or this this a problem you run into when the generator generates (for whatever reason) invalid code?

[manuelblum]

I'm sorry but I don't understand the problem. I don't know what you mean by that "keyword: project service"

Is this a new problem you have with all generated files? Or this this a problem you run into when the generator generates (for whatever reason) invalid code?

Let me explain how I understood the problem:

eslint.lintText in packages/admin-generator/src/commands/generate/writeGenerated.ts fails with the following error only on some Files ( i have no real clue why it only affects some files)

As far as I see it happens only when the problematic file is not available on the disk.

That's why I introduced the workaround that the file (with generated source code, but not formatted) will be written to the disk at the given path before linting. If the file is available on the disk, the lintText succeeds.

[nsams]

Ok, I understand the problem now - and can reproduce it. Very strange.

I don't understand the solution, but at least it is a working solution.

[nsams]

Suggested change

	await fs.writeFile(filePath, contents);
	await fs.writeFile(filePath, header + contents);

(was also wrong in line 33)

[nsams]

the unlinted file is already written above, no need to fallback to contents (which was missing header)

Suggested change

	const output = lintResult[0] && lintResult[0].output ? lintResult[0].output : lintResult[0].source;
	await fs.writeFile(filePath, output ?? contents);
	const lintOutput = lintResult[0] && lintResult[0].output ? lintResult[0].output : lintResult[0].source;
	if (lintOutput) {
	await fs.writeFile(filePath, lintOutput);
	}

alternatively you could switch from eslint.lintText to eslint.lintFiles