feat: analyze node modules

docs/analyzer/config.md

@@ -85,4 +85,20 @@ Using the `--config` flag in the CLI you can supply a custom path to your config
 
 ```bash
 cem analyze --config "../configs/custom-elements-manifest.js"
+```
+
+### Analyzing dependencies
+
+By default, the analyzer doesn't analyze any code inside `node_modules/`. For several reasons; you dont want all of `lodash` to accidentally get analyzed and output in your manifest, but also, we don't actually know which dependencies your project uses _until_ we're analyzing the code, by which time glob collection and compilation has already happened.
+
+If you want to analyze third-party dependencies, you're responsible for providing the globs for them as either a cli option, or in your `custom-elements-manifest.config.js` configuration file.
+
+Example:
+```js
+export default {
+  globs: [
+    'src/**/*.js',
+    'node_modules/foo/**/*.js'
+  ]
+}
 ```

packages/analyzer/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.6.0
+- Allow analyzing of `node_modules/` by user-provided globs
+
 ## Release 0.5.5
 - Pick up `@property` decorator in mixins as well
 

packages/analyzer/custom-elements-manifest.config.js

@@ -19,7 +19,9 @@
 let typeChecker;
 
 export default {
-  globs: ['fixtures/-default/package/**/*.{js,ts}'], 
+  globs: [
+    'fixtures/-default/package/**/*.{js,ts}',
+  ], 
   exclude: [],
   dev: false,
   plugins: [

packages/analyzer/custom-elements.json

@@ -7,45 +7,43 @@
       "path": "fixtures/-default/package/bar.js",
       "declarations": [
         {
-          "kind": "mixin",
+          "kind": "class",
           "description": "",
-          "name": "InputMixin",
+          "name": "MyEl",
+          "superclass": {
+            "name": "SuperFoo",
+            "package": "foo"
+          },
           "members": [
             {
-              "kind": "field",
-              "name": "disabled",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "description": "this description never gets picked up by the analyzer. \nso we lose some info about default values and the fact it is both property and attribute",
-              "attribute": "disabled"
+              "kind": "method",
+              "name": "superMethod",
+              "inheritedFrom": {
+                "name": "SuperFoo",
+                "module": "fixtures/-default/package/node_modules/foo/index.js"
+              }
             }
           ],
-          "attributes": [
+          "events": [
             {
-              "name": "disabled",
+              "name": "super-event",
               "type": {
-                "text": "boolean"
+                "text": "CustomEvent"
               },
-              "default": "false",
-              "description": "this description never gets picked up by the analyzer. \nso we lose some info about default values and the fact it is both property and attribute",
-              "fieldName": "disabled"
-            }
-          ],
-          "parameters": [
-            {
-              "name": "superClass"
+              "inheritedFrom": {
+                "name": "SuperFoo",
+                "module": "fixtures/-default/package/node_modules/foo/index.js"
+              }
             }
           ]
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "InputMixin",
+          "name": "MyEl",
           "declaration": {
-            "name": "InputMixin",
+            "name": "MyEl",
             "module": "fixtures/-default/package/bar.js"
           }
         }

packages/analyzer/fixtures/-default/package/bar.js

@@ -1,11 +1,3 @@
-export function InputMixin(superClass) {
-  class InputElement extends superClass {
-    /**
-     * this description never gets picked up by the analyzer. 
-     * so we lose some info about default values and the fact it is both property and attribute
-     */
-    @property({ type: Boolean }) disabled = false
-  }
+import { SuperFoo } from 'foo';
 
-  return InputElement;
-}
+export class MyEl extends SuperFoo {}

packages/analyzer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@custom-elements-manifest/analyzer",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "description": "",
   "license": "MIT",
   "type": "module",

packages/analyzer/src/features/index.js

@@ -27,6 +27,7 @@ import { cleanupClassesPlugin } from './link-phase/cleanup-classes.js';
  * POST-PROCESSING
  */
 import { removeUnexportedDeclarationsPlugin } from './post-processing/remove-unexported-declarations.js';
+import { removeNodeModulesPlugin } from './post-processing/remove-node-modules.js';
 import { resolveInitializersPlugin } from './post-processing/resolve-initializers.js';
 import { isCustomElementPlugin } from './post-processing/is-custom-element.js';
 import { linkClassToTagnamePlugin } from './post-processing/link-class-to-tagname.js';
@@ -69,6 +70,7 @@ export const FEATURES = [
   linkClassToTagnamePlugin(),
   isCustomElementPlugin(),
   applyInheritancePlugin(),
+  removeNodeModulesPlugin(),
 
   /** FRAMEWORKS */
   // litPlugin()

packages/analyzer/src/features/post-processing/remove-node-modules.js

@@ -0,0 +1,15 @@
+/**
+ * REMOVE-NODE-MODULES
+ * 
+ * Removes any modules from `node_modules`
+ */
+export function removeNodeModulesPlugin() {
+  return {
+    name: 'CORE - REMOVE-NODE-MODULES',
+    packageLinkPhase({customElementsManifest}){
+      customElementsManifest.modules = customElementsManifest?.modules?.filter(mod => {
+        return !mod?.path?.includes('node_modules');
+      });
+    },
+  }
+}

packages/analyzer/src/utils/cli.js

@@ -4,7 +4,7 @@ import path from 'path';
 import commandLineArgs from 'command-line-args';
 import { has } from './index.js';
 
-const IGNORE = [
+let IGNORE = [
   '!node_modules/**/*.*', 
   '!bower_components/**/*.*', 
   '!**/*.test.{js,ts}', 
@@ -13,16 +13,23 @@ const IGNORE = [
 ];
 
 export function mergeGlobsAndExcludes(defaults, userConfig, cliConfig) {
-  const hasProvidedCliGlobs = has(cliConfig?.globs) || has(userConfig?.globs);
+  const cliGlobs = cliConfig?.globs || [];
+  const configGlobs = userConfig?.globs || [];
+  const userProvidedGlobs = [...cliGlobs, ...configGlobs];
 
+  const hasProvidedCliGlobs = has(cliConfig?.globs) || has(userConfig?.globs);
   if(hasProvidedCliGlobs) {
-    defaults.globs = defaults.globs.filter(glob => glob !== '**/*.{js,ts,tsx}');
+    defaults.globs = defaults.globs.filter(g => g !== '**/*.{js,ts,tsx}');
+  }
+
+  const wantsToAnalyzeNodeModules = userProvidedGlobs.some(g => g.includes('node_modules'));
+  if(wantsToAnalyzeNodeModules) {
+    IGNORE = IGNORE.filter(g => g !== '!node_modules/**/*.*');
   }
 
   const merged = [
     ...defaults.globs,
-    ...(userConfig?.globs || []),
-    ...(cliConfig?.globs || []),
+    ...userProvidedGlobs,
     ...(userConfig?.exclude?.map((i) => `!${i}`) || []),
     ...(cliConfig?.exclude?.map((i) => `!${i}`) || []),
     ...IGNORE,