fix: make typings more accurate by avoiding explict cast on consts

[kpanot]

Proposed change

When creating an object that is intended to be read-only, we should let typescript infer the type.

Not good:

interface NamedObjectMaybe {
  name?: string;
}
const UNMOVABLE_OBJECT: NamedObjectMaybe = {
  name: 'unicorn'
};

// UNMOVABLE_OBJECT.name is typed as string | undefined

Nice:

interface NamedObjectMaybe {
  name?: string;
}
const UNMOVABLE_OBJECT = {
  name: 'unicorn'
} as const satisfies NamedObjectMaybe;

// UNMOVABLE_OBJECT.name is typed as 'unicorn' but we still validate that UNMOVABLE_OBJECT matches the interface

Related issues

• Pull Request fix: make typings more accurate by avoiding explict cast on consts #2271

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit d51da86. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

🟥 Failed Commands
nx run-many --target=test-int --parallel 3

✅ Successfully ran 10 targets

• nx run-many --target=build --projects=eslint-plugin --parallel 3
• nx run-many --target=test-e2e --parallel 3
• nx run-many --target=publish --parallel 3 --nx-bail --userconfig .verdaccio/conf/.npmrc-logged --tag=latest --@o3r:registry=http://127.0.0.1:4873 --@ama-sdk:registry=http://127.0.0.1:4873 --@ama-terasu:registry=http://127.0.0.1:4873 --@o3r-training:registry=http://127.0.0.1:4873
• nx run-many --target=build --parallel 3
• nx affected --target=lint --parallel 3 --base=remotes/origin/main --configuration ci
• nx affected --target=test --parallel 3 --cacheDirectory=D:\a\otter\otter/.cache/jest --base=remotes/origin/main --collectCoverage
• nx affected --target=test --parallel 3 --cacheDirectory=/home/runner/work/otter/otter/.cache/jest --base=remotes/origin/main --collectCoverage
• nx run-many --target=documentation --parallel 3
• nx run ama-sdk-schematics:build-swagger
• nx run-many --target=build-swagger --parallel 3

---

Sent with 💌 from NxCloud.

[codecov]

Codecov Report

Attention: Patch coverage is 82.85714% with 12 lines in your changes missing coverage. Please review.

Project coverage is 66.20%. Comparing base (3a6a2d7) to head (d51da86).
Report is 2 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
packages/@ama-sdk/core/src/utils/generic-api.ts	0.00%	2 Missing ⚠️
.../src/components/showcase/sdk/sdk-pres.component.ts	0.00%	1 Missing ⚠️
...r/open-api-cli-generator/open-api-cli.generator.ts	0.00%	1 Missing ⚠️
...r/swagger-java-generator/swagger-java.generator.ts	0.00%	1 Missing ⚠️
...cs/src/services/event-track/event-track.service.ts	66.66%	1 Missing ⚠️
packages/@o3r/extractors/src/core/wrapper.ts	0.00%	1 Missing ⚠️
...engine-extractor/helpers/rules-engine.extractor.ts	50.00%	1 Missing ⚠️
.../schematics/src/rule-factories/eslint-fix/index.ts	0.00%	1 Missing ⚠️
packages/@o3r/schematics/src/utility/logo.ts	0.00%	1 Missing ⚠️
packages/@o3r/schematics/src/utility/wrapper.ts	0.00%	1 Missing ⚠️
... and 1 more

Additional details and impacted files

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[matthieu-crouzet]

• As discussed wait for Migrate to eslint 9 and flat config #2192 before merging this PR

[matthieu-crouzet]

Why do we put Readonly on some but not on all of the as const ?

[kpanot]

Not sure I got the question :S.
readonly<...> is mandatory when the constant is declared as const but, as it is exposed, should also have an explicit type following an interface.
When there are not exported, it does not need to have the type defined but only to satisfy it. So no need Readonly<...>.