feat: Update readme with Feature Key Tracking feature #13
Conversation
README.md
Outdated
|
|
||
| This extension is compatiable with 1.34 and higher of vscode. | ||
| This extension also evaluates the use of Optimizely's public APIs (e.g. getFeatureVariableJSON(feature_key, userId, attributes)) in active .js and .ts files, and highlights Feature Keys that do not exist in datafile. |
There was a problem hiding this comment.
I'd reword as:
This extension also evaluates if parameter values are valid for Optimizely's public SDK methods (for example, getFeatureVariable(feature_key, userID, attributes), or isFeatureEnabled(feature_key)) for Javascript and Typescript. If a given parameter is invalid (i.e., doesn't exist in the datafile), this extension highlights it and displays a warning on hover.
There was a problem hiding this comment.
I think this is great! I would just specify what parameter values being evaluated, which are only feature keys at the moment:
This extension also evaluates if provided feature keys are valid for Optimizely's public SDK methods (for example, getFeatureVariable(feature_key, userID, attributes), or isFeatureEnabled(feature_key, userID)) for Javascript and TypeScript. If a given feature_key is invalid (i.e., doesn't exist in the datafile), the extension highlights it and displays a warning on hover.
README.md
Outdated
| @@ -1,8 +1,10 @@ | |||
| # Optimizely VSCode Extension | |||
|
|
|||
| The Optimizely VSCode extension lets you access Feature Keys, Experiment Keys and Feature Variables via auto-complete for javascript typescript and react. If not using these languages, you can use the keyboard shortcuts below to insert your experiment and feature keys as well as attribute and event keys. | |||
| The Optimizely VSCode extension lets you access Feature Keys, Experiment Keys and Feature Variables via auto-complete for javascript, typescript and react. If not using these languages, you can use the keyboard shortcuts below to insert your experiment and feature keys as well as attribute and event keys. | |||
There was a problem hiding this comment.
The Optimizely VSCode extension autocompletes:
- feature keys
- experiment keys
- feature variables
in Javascript, Typescript, and React.
QUESTION: it's not clear if In .js, .ts, and react, you can also autocomplete attribute and event keys without keyboard shortcuts? if you can, please add them to the list and modify the second sentence:
In other languages, you can insert the preceding list of elements using the following keyboard shortcuts.
There was a problem hiding this comment.
I believe we can, so they should be added to the list. @thomaszurkan-optimizely WDYT?
There was a problem hiding this comment.
events and attributes don't auto-complete.
There was a problem hiding this comment.
I added back events keys since we added it in our last #14 pr
README.md
Outdated
| This extension is compatiable with 1.34 and higher of vscode. | ||
| In other languages, you can insert the preceding list of elements using the following keyboard shortcuts. | ||
|
|
||
| This extension also evaluates if provided feature keys are valid for Optimizely's public SDK methods (for example, getFeatureVariable(feature_key, userID, attributes), or isFeatureEnabled(feature_key, userID)) for Javascript and TypeScript. If a given feature_key is invalid (i.e., doesn't exist in the datafile), the extension highlights it and displays a warning on hover. |
There was a problem hiding this comment.
Can we change this slightly to say something like: "(i.e. doesn't exist in the datafile for the sdk key used to configure)."
bf8038e to
69f2180
Compare
This pr updates README.md with feature key tracking feature