feat(generators): add .generatorTag symbol to Generators
#82
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
fedeci
commented
Oct 28, 2022
| @@ -1211,3 +1216,7 @@ declare namespace Fig { | |||
| cache?: Cache; | |||
| } | |||
| } | |||
|
|
|||
| interface SymbolConstructor { | |||
| readonly generatorTag: unique symbol; | |||
There was a problem hiding this comment.
An alternative name may be this one:
Suggested change
| readonly generatorTag: unique symbol; | |
| readonly generatorName: unique symbol; |
fedeci
commented
Oct 28, 2022
| @@ -140,6 +140,8 @@ function filepathsFn(options: FilepathsOptions = {}): Fig.Generator { | |||
| }; | |||
|
|
|||
| return { | |||
| [Symbol.generatorTag]: "filepathsTemplate", | |||
There was a problem hiding this comment.
NOTE: adding symbols properties to our objects makes a strong requirement for those creating tools relying on specs (e.g. AE, Dashboard) and running generators. They are basically a protocol that should be implemented.
e.g.
const generator: Fig.Generator = {
[Symbol.generatorTag]: "name"
}
// if `Symbol.generatorTag` is not defined in the environment (see the ref PR in AE to understand how it is defined)
// the objects assumes the following shape
const generator: Fig.Generator = {
undefined: "name"
}
// which means that if I try to access `undefined` I get "name"
generator[undefined] // "name"
generator["undefPropertyName"] // "name"
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.
No description provided.