chore: add jsdoc explaining the need for getAbsoluteDependencyPath

tkajtoch · tkajtoch · commit 208e430ae959 · 2024-05-13T11:48:42.000+02:00
diff --git a/packages/eui/.storybook/main.ts b/packages/eui/.storybook/main.ts
@@ -9,6 +9,17 @@
 import path from 'path';
 import type { StorybookConfig } from '@storybook/react-webpack5';
 
+/**
+ * Get an absolute path to package's `node_modules` directory. It's compatible
+ * with yarn hoisting logic.
+ *
+ * It works by resolving a path to its `package.json` file since it's the only
+ * file that must exist in the package's root directory. Resolving the package
+ * itself would return a path to the entry point that could be anywhere within
+ * that package's directory.
+ *
+ * @see {@link https://github.com/storybookjs/storybook/issues/21710#issuecomment-1604260157}
+ */
 const getAbsoluteDependencyPath = (packageName: string) =>
   path.dirname(require.resolve(path.join(packageName, 'package.json')));
 
