feat(cem): add dependencies/dependants graph to the components descri…

…ption

Fixes #826

cem/add-dependencies-in-description.js

@@ -0,0 +1,39 @@
+/**
+ * CEM analyzer plugin: add-dependencies-in-description
+ *
+ * This plugin adds the dependencies and the dependants at the description of each component if they have some.
+ */
+import {
+  getComponentsGraph,
+  getComponentsTree,
+} from '../tasks/component-usage-graph.js';
+
+const graph = await getComponentsGraph();
+
+export default function addDependenciesInDescription () {
+
+  return {
+    name: 'add-dependencies-in-description',
+    moduleLinkPhase ({ moduleDoc }) {
+
+      const isNotSmartComponentFile = !moduleDoc.path.includes('.smart');
+
+      const dependencies = isNotSmartComponentFile ? getComponentsTree([moduleDoc.path], graph, 'dependencies') : '';
+      const dependants = isNotSmartComponentFile ? getComponentsTree([moduleDoc.path], graph, 'dependants', 1) : '';
+
+      let sourceLine = '';
+      if (dependencies !== '') {
+        sourceLine += '### Dependencies\n' + '```\n' + dependencies + '\n```';
+      }
+      if (dependants !== '') {
+        sourceLine += '\n\n### Dependants\n' + '```\n' + dependants + '\n```';
+      }
+
+      moduleDoc.declarations
+        ?.filter((declaration) => declaration.kind === 'class')
+        ?.forEach((declaration) => {
+          declaration.description += '\n\n' + sourceLine;
+        });
+    },
+  };
+}

custom-elements-manifest.config.mjs

@@ -2,6 +2,7 @@ import fs from 'fs';
 import sortItems from './cem/sort-items.js';
 import removePrivateMembers from './cem/remove-private-members.js';
 import identifyReadonlyMembers from './cem/identify-readonly-members.js';
+import addDependenciesInDescription from './cem/add-dependencies-in-description.js';
 import addGithubSourceInDescription from './cem/add-github-source-in-description.js';
 import supportCssdisplayJsdoc from './cem/support-cssdisplay-jsdoc.js';
 import supportTypedefJsdoc from './cem/support-typedef-jsdoc.js';
@@ -22,6 +23,7 @@ export default {
     identifyReadonlyMembers(),
     supportCssdisplayJsdoc(),
     supportTypedefJsdoc(),
+    addDependenciesInDescription(),
     addGithubSourceInDescription({ githubProject: 'CleverCloud/clever-components' }),
     listImages(),
   ],