Merge pull request #42 from open-wc/fix/default-slot

thepassle · web-flow · commit e8794d46c149 · 2021-06-25T11:57:52.000+02:00
fix: default slot name handling
diff --git a/packages/analyzer/README.md b/packages/analyzer/README.md
@@ -326,6 +326,7 @@ customElements.define('my-element', MyElement);
  *
  * @csspart bar - Styles the color of bar
  *
+ * @slot - This is a default/unnamed slot
  * @slot container - You can put some elements here
  *
  * @cssprop --text-color - Controls the color of foo
diff --git a/packages/analyzer/browser/index.js b/packages/analyzer/browser/index.js
diff --git a/packages/analyzer/custom-elements.json b/packages/analyzer/custom-elements.json
@@ -10,17 +10,14 @@
           "kind": "class",
           "description": "",
           "name": "MyElement",
-          "members": [
+          "slots": [
             {
-              "kind": "method",
-              "name": "myMethod"
-            }
-          ],
-          "events": [
+              "description": "- foo slot",
+              "name": "foo"
+            },
             {
-              "type": {
-                "text": "MyCustomEvent"
-              }
+              "description": "description is this",
+              "name": ""
             }
           ],
           "superclass": {
diff --git a/packages/analyzer/fixtures/-default/package/bar.js b/packages/analyzer/fixtures/-default/package/bar.js
@@ -1,18 +1,7 @@
 
-import { LitElement } from 'lit';
-
 /**
- * Some information here.
+ * @slot foo - foo slot
+ * @slot - description is this
  */
-class MyCustomEvent extends CustomEvent {
-  constructor(eventInit) {
-    super('my-custom-event', eventInit);
-  }
-}
-
 export class MyElement extends LitElement {
-  myMethod() {
-      // FAILS HERE because no `type` argument is being passed to `MyCustomEvent`.
-      this.dispatchEvent(new MyCustomEvent());
-  }
 }
diff --git a/packages/analyzer/fixtures/class-jsdoc/fixture/custom-elements.json b/packages/analyzer/fixtures/class-jsdoc/fixture/custom-elements.json
@@ -28,6 +28,10 @@
             }
           ],
           "slots": [
+            {
+              "description": "This is the default slot",
+              "name": ""
+            },
             {
               "description": "- You can put some elements here",
               "name": "container"
diff --git a/packages/analyzer/fixtures/class-jsdoc/output.json b/packages/analyzer/fixtures/class-jsdoc/output.json
@@ -28,6 +28,10 @@
             }
           ],
           "slots": [
+            {
+              "description": "This is the default slot",
+              "name": ""
+            },
             {
               "description": "- You can put some elements here",
               "name": "container"
diff --git a/packages/analyzer/fixtures/class-jsdoc/package/my-element.js b/packages/analyzer/fixtures/class-jsdoc/package/my-element.js
@@ -12,6 +12,7 @@
  *
  * @csspart bar - Styles the color of bar
  *
+ * @slot - This is the default slot
  * @slot container - You can put some elements here
  *
  * @cssprop --text-color - Controls the color of foo
diff --git a/packages/analyzer/package.json b/packages/analyzer/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@custom-elements-manifest/analyzer",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "",
   "license": "MIT",
   "type": "module",
diff --git a/packages/analyzer/src/features/analyse-phase/class-jsdoc.js b/packages/analyzer/src/features/analyse-phase/class-jsdoc.js
@@ -129,7 +129,7 @@ function handleClassJsDoc(doc, tag) {
   }
 
   if(tag?.name) {
-    doc.name = tag.name;
+    doc.name = tag.name === '-' ? '' : tag.name;
   }
 
   if(tag?.default) {

Original file line number	Diff line number	Diff line change
`@@ -326,6 +326,7 @@ customElements.define('my-element', MyElement);`
`326`	`326`	`*`
`327`	`327`	`* @csspart bar - Styles the color of bar`
`328`	`328`	`*`
	`329`	`+ * @slot - This is a default/unnamed slot`
`329`	`330`	`* @slot container - You can put some elements here`
`330`	`331`	`*`
`331`	`332`	`* @cssprop --text-color - Controls the color of foo`
Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,10 @@`
`28`	`28`	`}`
`29`	`29`	`],`
`30`	`30`	`"slots": [`
	`31`	`+ {`
	`32`	`+ "description": "This is the default slot",`
	`33`	`+ "name": ""`
	`34`	`+ },`
`31`	`35`	`{`
`32`	`36`	`"description": "- You can put some elements here",`
`33`	`37`	`"name": "container"`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`*`
`13`	`13`	`* @csspart bar - Styles the color of bar`
`14`	`14`	`*`
	`15`	`+ * @slot - This is the default slot`
`15`	`16`	`* @slot container - You can put some elements here`
`16`	`17`	`*`
`17`	`18`	`* @cssprop --text-color - Controls the color of foo`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@custom-elements-manifest/analyzer",`
`3`		`- "version": "0.3.4",`
	`3`	`+ "version": "0.3.5",`
`4`	`4`	`"description": "",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ function handleClassJsDoc(doc, tag) {`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`if(tag?.name) {`
`132`		`- doc.name = tag.name;`
	`132`	`+ doc.name = tag.name === '-' ? '' : tag.name;`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`if(tag?.default) {`