fix: mark fields and methods starting with # as private

open-wc · May 7, 2024 · a61e373 · a61e373
1 parent ac5227b
commit a61e373
Show file tree

Hide file tree

Showing 9 changed files with 46 additions and 13 deletions.
diff --git a/packages/analyzer/CHANGELOG.md b/packages/analyzer/CHANGELOG.md
@@ -1,3 +1,6 @@
+## Release 0.10.2
+- Mark fields and methods starting with `#` as `private`
+
 ## Release 0.10.1
 - Escape newlines and whitespaces from object output
 

diff --git a/packages/analyzer/browser/index.js b/packages/analyzer/browser/index.js
@@ -203730,6 +203730,9 @@ function handleModifiers(doc, node) {
         break;
     }
   });
+  if (node.name?.text.startsWith("#")) {
+    doc.privacy = "private";
+  }
   return doc;
 }
 function handleJsDoc(doc, node) {

diff --git a/packages/analyzer/custom-elements.json b/packages/analyzer/custom-elements.json
@@ -12,12 +12,9 @@
           "name": "Foo",
           "members": [
             {
-              "kind": "field",
-              "name": "foo",
-              "type": {
-                "text": "object"
-              },
-              "default": "{ foo: 'bar' }"
+              "kind": "method",
+              "name": "#foo",
+              "privacy": "private"
             }
           ],
           "superclass": {

diff --git a/packages/analyzer/fixtures/01-class/-default/package/bar.js b/packages/analyzer/fixtures/01-class/-default/package/bar.js
@@ -1,9 +1,4 @@
 
 export class Foo extends HTMLElement{ 
-  constructor() {
-    super();
-    this.foo = {
-        foo: 'bar'
-    };
-  }
+  #foo() {}
 }
diff --git a/packages/analyzer/fixtures/01-class/01-fields/fixture/custom-elements.json b/packages/analyzer/fixtures/01-class/01-fields/fixture/custom-elements.json
@@ -253,6 +253,20 @@
               "kind": "field",
               "name": "arrowfn"
             },
+            {
+              "kind": "field",
+              "name": "#truePrivateField",
+              "privacy": "private",
+              "type": {
+                "text": "number"
+              },
+              "default": "1"
+            },
+            {
+              "kind": "method",
+              "name": "#truePrivateMethod",
+              "privacy": "private"
+            },
             {
               "kind": "field",
               "name": "commaprop1",

diff --git a/packages/analyzer/fixtures/01-class/01-fields/output.json b/packages/analyzer/fixtures/01-class/01-fields/output.json
@@ -253,6 +253,20 @@
               "kind": "field",
               "name": "arrowfn"
             },
+            {
+              "kind": "field",
+              "name": "#truePrivateField",
+              "privacy": "private",
+              "type": {
+                "text": "number"
+              },
+              "default": "1"
+            },
+            {
+              "kind": "method",
+              "name": "#truePrivateMethod",
+              "privacy": "private"
+            },
             {
               "kind": "field",
               "name": "commaprop1",

diff --git a/packages/analyzer/fixtures/01-class/01-fields/package/my-element.js b/packages/analyzer/fixtures/01-class/01-fields/package/my-element.js
@@ -74,6 +74,9 @@ class MyEl extends HTMLElement {
     console.log('dont output me')
   }
 
+  #truePrivateField = 1;
+  #truePrivateMethod() {}
+
   constructor() {
     super();
     this.prop2 = 'default';

diff --git a/packages/analyzer/package.json b/packages/analyzer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@custom-elements-manifest/analyzer",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "",
   "license": "MIT",
   "type": "module",

diff --git a/packages/analyzer/src/features/analyse-phase/creators/handlers.js b/packages/analyzer/src/features/analyse-phase/creators/handlers.js
@@ -34,6 +34,10 @@ export function handleModifiers(doc, node) {
     }
   });
 
+  if (node.name?.text.startsWith('#')) {
+    doc.privacy = 'private';
+  }
+
   return doc;
 }