Log the file scope in debug

Display the scopes of the last cursor in the current file in the debug command so they can be verified against the scopes allowed in the configuration of the package.
AtomLinter · Mar 3, 2017 · e635a3e · e635a3e
1 parent 4a3d02d
commit e635a3e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/lib/helpers.js b/lib/helpers.js
@@ -10,11 +10,14 @@ let getDebugInfo = exports.getDebugInfo = (() => {
   var _ref = _asyncToGenerator(function* (worker) {
     const textEditor = atom.workspace.getActiveTextEditor();
     let filePath;
+    let editorScopes;
     if (atom.workspace.isTextEditor(textEditor)) {
       filePath = textEditor.getPath();
+      editorScopes = textEditor.getLastCursor().getScopeDescriptor().getScopesArray();
     } else {
       // Somehow this can be called with no active TextEditor, impossible I know...
       filePath = 'unknown';
+      editorScopes = ['unknown'];
     }
     const packagePath = atom.packages.resolvePackagePath('linter-eslint');
     let linterEslintMeta;
@@ -43,7 +46,8 @@ let getDebugInfo = exports.getDebugInfo = (() => {
         hoursSinceRestart,
         platform: process.platform,
         eslintType: response.type,
-        eslintPath: response.path
+        eslintPath: response.path,
+        editorScopes
       };
     } catch (error) {
       atom.notifications.addError(`${error}`);
@@ -59,7 +63,7 @@ let getDebugInfo = exports.getDebugInfo = (() => {
 let generateDebugString = exports.generateDebugString = (() => {
   var _ref2 = _asyncToGenerator(function* (worker) {
     const debug = yield getDebugInfo(worker);
-    const details = [`Atom version: ${debug.atomVersion}`, `linter-eslint version: ${debug.linterEslintVersion}`, `ESLint version: ${debug.eslintVersion}`, `Hours since last Atom restart: ${debug.hoursSinceRestart}`, `Platform: ${debug.platform}`, `Using ${debug.eslintType} ESLint from: ${debug.eslintPath}`, `linter-eslint configuration: ${JSON.stringify(debug.linterEslintConfig, null, 2)}`];
+    const details = [`Atom version: ${debug.atomVersion}`, `linter-eslint version: ${debug.linterEslintVersion}`, `ESLint version: ${debug.eslintVersion}`, `Hours since last Atom restart: ${debug.hoursSinceRestart}`, `Platform: ${debug.platform}`, `Using ${debug.eslintType} ESLint from: ${debug.eslintPath}`, `Current file's scopes: ${JSON.stringify(debug.editorScopes, null, 2)}`, `linter-eslint configuration: ${JSON.stringify(debug.linterEslintConfig, null, 2)}`];
     return details.join('\n');
   });
 

diff --git a/src/helpers.js b/src/helpers.js
@@ -71,11 +71,14 @@ function validatePoint(textEditor, line, col) {
 export async function getDebugInfo(worker) {
   const textEditor = atom.workspace.getActiveTextEditor()
   let filePath
+  let editorScopes
   if (atom.workspace.isTextEditor(textEditor)) {
     filePath = textEditor.getPath()
+    editorScopes = textEditor.getLastCursor().getScopeDescriptor().getScopesArray()
   } else {
     // Somehow this can be called with no active TextEditor, impossible I know...
     filePath = 'unknown'
+    editorScopes = ['unknown']
   }
   const packagePath = atom.packages.resolvePackagePath('linter-eslint')
   let linterEslintMeta
@@ -105,6 +108,7 @@ export async function getDebugInfo(worker) {
       platform: process.platform,
       eslintType: response.type,
       eslintPath: response.path,
+      editorScopes,
     }
   } catch (error) {
     atom.notifications.addError(`${error}`)
@@ -121,6 +125,7 @@ export async function generateDebugString(worker) {
     `Hours since last Atom restart: ${debug.hoursSinceRestart}`,
     `Platform: ${debug.platform}`,
     `Using ${debug.eslintType} ESLint from: ${debug.eslintPath}`,
+    `Current file's scopes: ${JSON.stringify(debug.editorScopes, null, 2)}`,
     `linter-eslint configuration: ${JSON.stringify(debug.linterEslintConfig, null, 2)}`
   ]
   return details.join('\n')