Skip to content
This repository was archived by the owner on May 7, 2024. It is now read-only.

Better installation experience with example settings #20

Closed
miohtama opened this issue Jan 18, 2020 · 4 comments
Closed

Better installation experience with example settings #20

miohtama opened this issue Jan 18, 2020 · 4 comments

Comments

@miohtama
Copy link

I really love this extension, very good work!

I have some suggestion to make new users to get faster up-to-speed with the extension. Maybe README can supply sample settings.json for copy-pasting, possible values and more background what the setting does.

E.g.

  • What Grammarly username/password is used for and where are they stored
  • What options there are settings like dialect, audience etc.

if you could provide me with some pointers where I can this information, I am happy to do a PR to make README better.

@znck
Copy link
Owner

znck commented Jan 18, 2020

Would love a PR.

username/password for logging into grammarly.com to enable paid features like advanced grammar issues.

dialect, audience etc to set document goals, can use overrides to set goals for specific files (can use glob pattern to match files). Exactly same as Get Goals on grammarly.com UI.

ignore to skip files, can use glob patterns

@miohtama
Copy link
Author

miohtama commented Jan 19, 2020

Where is the list of (multichoice?) values I can have in dialect and audience field? I assume these are identifies, not plain English.

@znck
Copy link
Owner

znck commented Jan 20, 2020

In package.json

grammarly/package.json

Lines 38 to 131 in 6749bba

"grammarly.audience": {
"scope": "resource",
"enum": [
"general",
"knowledgeable",
"expert"
],
"default": "knowledgeable",
"enumDescriptions": [
"Easy for anyone to read with minimal effort.",
"Requires focus to read and understand.",
"May require rereading to understand."
]
},
"grammarly.dialect": {
"scope": "resource",
"enum": [
"american",
"british"
],
"default": "american",
"enumDescriptions": [
"English (US)",
"English (UK)"
]
},
"grammarly.domain": {
"scope": "resource",
"enum": [
"academic",
"business",
"general",
"technical",
"casual",
"creative"
],
"default": "general",
"enumDescriptions": [
"Strictly applies all rules and formal writing conventions.",
"Applies almost all rules, but allow some informal expressions.",
"Applies most rules and conventions with medium strictness.",
"Applies almost all rules, plus technical writing conventions.",
"Applies most rules, but allow stylistic flexibility.",
"Allows some intentional bending of rules and conventions."
]
},
"grammarly.emotions": {
"markdownDescription": "**Experimental.** How do you want to sound?",
"scope": "resource",
"type": "array",
"items": {
"enum": [
"neutral",
"confident",
"joyful",
"optimistic",
"respectful",
"urgent",
"friendly",
"analytical"
],
"enumDescriptions": [
"😐 Neutral",
"🤝 Confident",
"🙂 Joyful",
"✌️ Optimistic",
"🤗 Friendly",
"⏰ Urgent",
"📊 Analytical",
"🙌 Respectful"
]
},
"default": []
},
"grammarly.goals": {
"markdownDescription": "**Experimental.** What are you trying to do?",
"scope": "resource",
"type": "array",
"items": {
"enum": [
"inform",
"describe",
"convince",
"tellStory"
],
"enumDescriptions": [
"Inform",
"Describe",
"Convince",
"Tell A Story"
]
},
"default": []
},

@znck
Copy link
Owner

znck commented Apr 14, 2020

Related: microsoft/vscode#95186

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants