feat!: expose language metadata as const #1111
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Exposing the LanguageMetadata as const with satisfies allows the values of its members like `languageId` or `fileExtensions` to be exposed statically. This allows for patterns like ``` type MyFileExtensions = typeof MyFancyDSLLanguageMetaData.fileExtensions ``` Where then MyFileExtensions is not typed to a generic `string[]` but to `['.myDsl']` which makes it easier to avoid mistakes. Unfortunately this is a breaking change because it requires the fileExtensions on the LanguageMetaData to be readonly to work.
msujew
approved these changes
Jul 11, 2023
spoenemann
pushed a commit
that referenced
this pull request
Aug 15, 2023
Exposing the LanguageMetadata as const with satisfies allows the values of its members like `languageId` or `fileExtensions` to be exposed statically. This allows for patterns like ``` type MyFileExtensions = typeof MyFancyDSLLanguageMetaData.fileExtensions ``` Where then MyFileExtensions is not typed to a generic `string[]` but to `['.myDsl']` which makes it easier to avoid mistakes. Unfortunately this is a breaking change because it requires the fileExtensions on the LanguageMetaData to be readonly to work.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Exposing the LanguageMetadata as const with satisfies allows the values of its members like
languageIdorfileExtensionsto be exposed statically. This allows for patterns likeWhere
MyFileExtensionsis not typed to a genericstring[]but to['.myDsl']which makes it easier to avoid mistakes.Unfortunately this is a breaking change because it requires the
fileExtensionson the LanguageMetaData to be readonly to work.