reposition alerts on typing & user configuration for hiding username in status bar (#155)

* reposition alerts on typing

* add changeset

Co-authored-by: Rahul Kadyan <[email protected]>

Author: znck

.changeset/config.json

@@ -2,11 +2,13 @@
   "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
   "changelog": "@changesets/cli/changelog",
   "commit": false,
-  "linked": [],
+  "linked": [
+    [
+      "unofficial-grammarly-language-client",
+      "unofficial-grammarly-language-server"
+    ]
+  ],
   "access": "public",
   "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": [
-    "grammarly-workspace"
-  ]
+  "updateInternalDependencies": "patch"
 }

.changeset/itchy-steaks-bow.md

@@ -0,0 +1,5 @@
+---
+'unofficial-grammarly-language-server': minor
+---
+
+Support dismiss alert feedback

.changeset/loud-dancers-run.md

@@ -0,0 +1,5 @@
+---
+'grammarly': minor
+---
+
+Show diagnostics in the correct position after accepting fixes

.changeset/six-dolphins-decide.md

@@ -0,0 +1,5 @@
+---
+'unofficial-grammarly-api': minor
+---
+
+Add text transformation helper functions

extension/package.json

@@ -325,21 +325,30 @@
           "type": "boolean",
           "default": false,
           "description": "Hide premium alerts when fix is not available"
+        },
+        "grammarly.showDeletedTextInQuickFix": {
+          "type": "boolean",
+          "default": true,
+          "description": "Show replaced text in quick-fix option."
+        },
+        "grammarly.showUsernameInStatusBar": {
+          "type": "boolean",
+          "default": true,
+          "description": "Show signed in user in status bar."
         }
       }
     },
     "commands": [
       {
         "command": "grammarly.check",
         "title": "Check grammar errors",
-        "category": "Grammarly",
-        "enablement": "grammarly:isSupported"
+        "category": "Grammarly"
       },
       {
         "command": "grammarly.stop",
         "title": "Stop checking grammar errors",
         "category": "Grammarly",
-        "enablement": "grammarly:isSupported && grammarly:isActive"
+        "enablement": "grammarly:isActive"
       },
       {
         "command": "grammarly.login",
@@ -357,7 +366,7 @@
         "command": "grammarly.setGoals",
         "title": "Set document goals",
         "category": "Grammarly",
-        "enablement": "grammarly:isSupported && grammarly:isActive"
+        "enablement": "grammarly:isActive"
       }
     ]
   },

extension/src/client/index.ts

@@ -16,7 +16,6 @@ export class GrammarlyClient extends GrammarlyLanguageClient implements Register
         return null
       },
       loadToken: async () => {
-        console.log('Get token...')
         if (process.env.EXTENSION_TEST_MODE) return null
 
         return await this.auth.getCookie()

extension/src/commands/ServerCallbackCommand.ts

@@ -8,7 +8,7 @@ import { Logger } from '../utils/Logger'
 export class ServerCallbackCommand implements Registerable {
   private LOGGER = new Logger(ServerCallbackCommand.name)
 
-  constructor(private readonly client: GrammarlyClient) {}
+  constructor (private readonly client: GrammarlyClient) { }
 
   register() {
     this.LOGGER.trace('Registering grammarly.callback command')
@@ -17,7 +17,6 @@ export class ServerCallbackCommand implements Registerable {
   }
 
   private async execute(options: { method: string; params: any }) {
-    this.LOGGER.trace('Executed with', options)
     if (!this.client.isReady()) {
       await this.client.onReady()
     }

extension/src/controllers/StatusBarController.ts

@@ -1,9 +1,10 @@
 import { ref } from '@vue/reactivity'
 import { injectable } from 'inversify'
 import { GrammarlyLanguageServer } from 'unofficial-grammarly-language-server'
-import { Disposable, StatusBarAlignment, StatusBarItem, TextEditor, ThemeColor, window } from 'vscode'
+import { Disposable, StatusBarAlignment, StatusBarItem, TextEditor, ThemeColor, Uri, window, workspace } from 'vscode'
 import { GrammarlyClient } from '../client'
 import { Registerable } from '../interfaces'
+import { DEFAULT, GrammarlySettings } from '../settings'
 import { asText, calculateTime, capitalize, choose, formatLines } from '../utils/string'
 import { watchEffect } from '../utils/watch'
 
@@ -39,6 +40,11 @@ export class StatusBarController implements Registerable {
       this.statusBar,
       this.goalsBar,
       window.onDidChangeActiveTextEditor(this.onDidChangeActiveTextEditor.bind(this)),
+      workspace.onDidChangeConfiguration(event => {
+        if (event.affectsConfiguration('grammarly')) {
+          this.update()
+        }
+      }),
       {
         dispose: watchEffect(() => {
           this.update()
@@ -47,19 +53,26 @@ export class StatusBarController implements Registerable {
     )
   }
 
+  private getSettings(): GrammarlySettings {
+    const uri = this.document.value != null ? Uri.parse(this.document.value.uri) : undefined
+    const config = workspace.getConfiguration(undefined, uri)
+
+    return config.get<GrammarlySettings>('grammarly') ?? DEFAULT
+  }
+
   private update() {
-    console.log('Calling watch effect...')
     const state = this.state.value
     const document = this.document.value
 
     if (state != null && 'status' in state) {
       const prefix = state.emotions.length ? state.emotions[0].emoji : ``
 
+      const settings = this.getSettings()
       this.statusBar.command = 'grammarly.stop'
-      this.statusBar.text = `${state.status === 'CHECKING' ? '$(loading~spin)' : '$(debug-disconnect)'} ${state.user.username}`
+      this.statusBar.text = `${state.status === 'CHECKING' ? '$(loading~spin)' : '$(debug-disconnect)'}${settings.showUsernameInStatusBar ? ` ${state.user.username}` : ''}`
 
       this.statusBar.tooltip = `${state.status === 'IDLE' ? 'Grammarly is checking for grammar errors.\n\n' : ''
-        }Click to disconnect Grammarly.`
+        }Connected as ${state.user.username}, click to disconnect.`
 
       this.goalsBar.command = 'grammarly.setGoals'
       this.goalsBar.text = `${prefix} ${state.score > 0 ? `${state.score} overall score` : ''}`

extension/src/settings.ts

@@ -21,6 +21,8 @@ export interface GrammarlySettings extends DocumentContext {
   }>
 
   debug: boolean
+  showUsernameInStatusBar: boolean
+  showDeletedTextInQuickFix: boolean
   showExplanation: boolean
   showExamples: boolean
   hideUnavailablePremiumAlerts: boolean
@@ -72,6 +74,8 @@ export const DEFAULT: GrammarlySettings = {
 
   /** Internal */
   debug: false,
+  showUsernameInStatusBar: true,
+  showDeletedTextInQuickFix: true,
   showExplanation: true,
   showExamples: false,
   hideUnavailablePremiumAlerts: false,

extension/src/utils/Logger.ts

@@ -1,23 +1,38 @@
 import { inspect } from 'util'
-import { isError, isString } from './is'
-
-export enum LoggerLevel {
-  TRACE = 'TRACE',
-  DEBUG = 'DEBUG',
-  INFO = 'INFO',
-  WARN = 'WARN',
-  ERROR = 'ERROR',
-  NONE = 'NONE',
+
+export const enum LoggerLevel {
+  TRACE,
+  DEBUG,
+  INFO,
+  WARN,
+  ERROR,
+  NONE,
+}
+
+const displayLevel = {
+  [LoggerLevel.TRACE]: 'TRACE',
+  [LoggerLevel.DEBUG]: 'DEBUG',
+  [LoggerLevel.INFO]: 'INFO',
+  [LoggerLevel.WARN]: 'WARN',
+  [LoggerLevel.ERROR]: 'ERROR',
+  [LoggerLevel.NONE]: 'NONE',
+}
+
+function isString(value: any): value is string {
+  return typeof value === 'string'
+}
+
+function isError(value: any): value is Error {
+  return value instanceof Error
 }
 
 export class Logger {
-  static Level = LoggerLevel
   static options = {
     enabled: new Set(['*']),
-    level: LoggerLevel.TRACE,
+    level: LoggerLevel.DEBUG,
   }
 
-  constructor(public readonly name: string, public readonly defaultContext: string = '') {}
+  constructor (public readonly name: string, public readonly defaultContext: string = '') { }
 
   trace(msg: string, ...args: any[]): void
   trace(context: string, msg: string, ...args: any[]): void
@@ -28,37 +43,40 @@ export class Logger {
   debug(msg: string, ...args: any[]): void
   debug(context: string, msg: string, ...args: any[]): void
   debug(...args: any[]) {
-    this.write(LoggerLevel.TRACE, args)
+    this.write(LoggerLevel.DEBUG, args)
   }
 
   info(msg: string, ...args: any[]): void
   info(context: string, msg: string, ...args: any[]): void
   info(...args: any[]) {
-    this.write(LoggerLevel.TRACE, args)
+    this.write(LoggerLevel.INFO, args)
   }
 
   warn(msg: string, ...args: any[]): void
   warn(context: string, msg: string, ...args: any[]): void
   warn(...args: any[]) {
-    this.write(LoggerLevel.TRACE, args)
+    this.write(LoggerLevel.WARN, args)
   }
 
   error(msg: string, ...args: any[]): void
   error(msg: Error, ...args: any[]): void
   error(context: string, msg: string, ...args: any[]): void
   error(context: string, msg: Error, ...args: any[]): void
   error(...args: any[]) {
-    this.write(LoggerLevel.TRACE, args)
+    this.write(LoggerLevel.ERROR, args)
   }
 
   private write(level: LoggerLevel, args: any[]) {
-    if (level >= Logger.options.level && (Logger.options.enabled.has('*') || Logger.options.enabled.has(this.name))) {
+    if (
+      level >= Logger.options.level &&
+      (Logger.options.enabled.has('*') || Logger.options.enabled.has(this.name))
+    ) {
       const context =
         args.length >= 2 && isString(args[0]) && (isString(args[1]) || isError(args[1]))
           ? args.shift()
           : this.defaultContext
 
-      const message = `${Date.now()} ${level}  [${this.name}]${context ? ' (' + context + ')' : ''} ${this.inspect(
+      const message = `${Date.now()} ${displayLevel[level]}  [${this.name}]${context ? ' (' + context + ')' : ''} ${this.inspect(
         args,
       )}`
 
@@ -80,3 +98,5 @@ export class Logger {
     return args.map((arg) => (typeof arg === 'object' && arg ? inspect(arg, true, null) : arg)).join(' ')
   }
 }
+
+export class DevLogger extends Logger { }