dev: Experiment with ESTree (#2438)

streetsidesoftware · Feb 12, 2022 · 58e92ee · 58e92ee
1 parent e4fc3fb
commit 58e92ee
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 7 deletions.
diff --git a/packages/cspell-eslint-plugin/samples/sampleESM.mjs b/packages/cspell-eslint-plugin/samples/sampleESM.mjs
@@ -1,8 +1,13 @@
 import { promises as fs } from 'fs';
 
+function mapDir(dir) {
+    return `type: ${dir.isFile ? 'F' : ' '}${dir.isDirectory() ? 'D' :' '} name: ${dir.name}`;
+}
+
 async function listFiles() {
-    const dir = await fs.readdir('.');
-    console.log(dir.join('\n'));
+    const dirs = await fs.readdir('.', { withFileTypes: true });
+    const entries = dirs.map(mapDir);
+    console.log(entries.join('\n'));
 }
 
 listFiles();
diff --git a/packages/cspell-eslint-plugin/scope.md b/packages/cspell-eslint-plugin/scope.md
@@ -1,8 +1,14 @@
 # Code Scopes
 
-| Scope       | Meaning                        |
-| ----------- | ------------------------------ |
-| `source.ts` | Matches extension of the file. |
+| Scope                       | Meaning                        |
+| --------------------------- | ------------------------------ |
+| `source.ts`                 | Matches extension of the file. |
+| `string.quoted.single.ts`   | Single quote string            |
+| `string.quoted.double.ts`   | Double quote string            |
+| `string.template.js`        | Template string                |
+| `entity.name.function.ts`   | Function name                  |
+| `entity.name.type.class.ts` |                                |
+| `meta.class.ts`             |                                |
 
 References:
 

diff --git a/packages/cspell-eslint-plugin/src/index.ts b/packages/cspell-eslint-plugin/src/index.ts
@@ -76,14 +76,26 @@ scope: ${context.getScope().type}
         }
         if (node.type === 'MemberExpression') {
             const extra = node.property === child ? 'property' : node.object === child ? 'object' : '';
-            return [node.type, extra].join('.');
+            return node.type + '.' + extra;
+        }
+        if (node.type === 'ArrowFunctionExpression') {
+            const extra = node.body === child ? 'body' : 'param';
+            return node.type + '.' + extra;
+        }
+        if (node.type === 'FunctionDeclaration') {
+            const extra = node.id === child ? 'id' : node.body === child ? 'body' : 'params';
+            return node.type + '.' + extra;
+        }
+        if (node.type === 'ClassDeclaration' || node.type === 'ClassExpression') {
+            const extra = node.id === child ? 'id' : node.body === child ? 'body' : 'superClass';
+            return node.type + '.' + extra;
         }
         return node.type;
     }
 
     function inheritance(node: Node) {
         const a = [...context.getAncestors(), node];
-        return a.map(mapNode).join('.');
+        return a.map(mapNode).join(' ');
     }
 }