Merge pull request #104 from open-wc/fix/comment-parser

fix: comment parser

Author: thepassle

packages/analyzer/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Release 0.4.14
+- Fix comment-parser dependency
+
 ## Release 0.4.13
 - Add support for class expressions in `customElements.define` calls, e.g.: `customElements.define('m-e', class extends HTMLElement{})`
 - Fixed bug in lit-plugin to avoid duplicate attributes

packages/analyzer/browser/index.js

@@ -5,7 +5,11 @@
     <script type="module">
       import {ts, create} from '../../browser/index.js';
 
-      const code = `export class MyEl extends HTMLElement {
+      const code = `
+      /**
+       * @prop {string} name - The name of the person. 
+       */
+      export class MyEl extends HTMLElement {
         /**
          * @attr
          */

packages/analyzer/demo/browser/index.html

@@ -41,7 +41,7 @@
     "@web/config-loader": "^0.1.3",
     "chokidar": "^3.5.2",
     "command-line-args": "^5.1.2",
-    "comment-parser": "^1.1.5",
+    "comment-parser": "^1.2.0",
     "custom-elements-manifest": "^1.0.0",
     "debounce": "^1.2.1",
     "globby": "^11.0.4",

packages/analyzer/package.json

@@ -1,7 +1,6 @@
 import resolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
 import {terser} from 'rollup-plugin-terser';
-const commentParser = require.resolve('comment-parser');
 
 const IGNORE = [
   'perf_hooks',
@@ -25,16 +24,6 @@ export default [
       commonjs({
         ignore: (id) => IGNORE.includes(id),
       }),
-      {
-      load(id) {
-        if (id === commentParser) {
-          return `
-  import { parse } from 'comment-parser/es6/index.js'
-  export default { parse: parse };
-          `;
-          }
-        }  
-      },
       resolve(),
       terser()
     ],

packages/analyzer/rollup.browser.config.js

@@ -1,4 +1,4 @@
-import parse from 'comment-parser';
+import { parse } from 'comment-parser';
 import { handleJsDocType, normalizeDescription } from '../../utils/jsdoc.js';
 import { safe } from '../../utils/index.js';
 
@@ -25,7 +25,7 @@ export function classJsDocPlugin() {
            * Checks to see if the item is already in the classDoc, and if so merge and overwrite (JSDoc takes precedence)
            */
           node?.jsDoc?.forEach(jsDoc => {
-            const parsed = parse.parse(jsDoc?.getFullText());
+            const parsed = parse(jsDoc?.getFullText());
             parsed?.forEach(parsedJsDoc => {
 
               /**

packages/analyzer/src/features/analyse-phase/class-jsdoc.js

@@ -3,7 +3,7 @@ import { createFunctionLike } from './createFunctionLike.js';
 import { createAttribute, createAttributeFromField } from './createAttribute.js';
 import { createField } from './createClassField.js';
 import { handleHeritage, handleJsDoc, handleAttrJsDoc, handleTypeInference, handleDefaultValue } from './handlers.js';
-import { hasAttrAnnotation, hasIgnoreJSDoc, isDispatchEvent, isPrimitive, isProperty, isReturnStatement, isStaticMember } from '../../../utils/ast-helpers.js';
+import { hasAttrAnnotation, hasIgnoreJSDoc, isDispatchEvent, isProperty, isReturnStatement } from '../../../utils/ast-helpers.js';
 import { resolveModuleOrPackageSpecifier } from '../../../utils/index.js';
 
 

packages/analyzer/src/features/analyse-phase/creators/createClass.js

@@ -1,9 +1,9 @@
 import ts from 'typescript';
-import parse from 'comment-parser';
+import { parse } from 'comment-parser';
 
 import { has, resolveModuleOrPackageSpecifier, safe } from '../../../utils/index.js';
 import { handleJsDocType, normalizeDescription } from '../../../utils/jsdoc.js';
-import { isPrimitive, isWellKnownType } from '../../../utils/ast-helpers.js';
+import { isWellKnownType } from '../../../utils/ast-helpers.js';
 
 /**
  * @example static foo;
@@ -197,7 +197,7 @@ export function handleHeritage(classTemplate, moduleDoc, context, node) {
  */
 export function handleAttrJsDoc(node, doc) {
   node?.jsDoc?.forEach(jsDoc => {
-    const docs = parse.parse(jsDoc?.getFullText())?.find(doc => doc?.tags?.some(({tag}) => tag === 'attr'));
+    const docs = parse(jsDoc?.getFullText())?.find(doc => doc?.tags?.some(({tag}) => tag === 'attr'));
     const attrTag = docs?.tags?.find(({tag}) => tag === 'attr');
 
     if(attrTag?.name) {