Merge pull request #92 from brizental/1694897-troubleshooting

Bug 1694897 - Provide troubleshooting documentation for known issues

Author: Beatriz Rizental

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Unreleased changes
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.3.0...main)
+
+* [#92](https://github.com/mozilla/glean.js/pull/92): Remove `web-ext-types` from `peerDependencies` list.
 # v0.3.0 (2021-02-24)
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.2.0...v0.3.0)

docs/troubleshooting.md

@@ -0,0 +1,18 @@
+# Troubleshooting
+
+## "Cannot find module '@mozilla/glean'"
+
+Glean.js does not have a [`main`](https://nodejs.org/api/packages.html#packages_main_entry_point_export) package entry point. Instead it relies on a series of entry points depending on the platform you are targeting.
+
+In order to import Glean use `import Glean from '@mozilla/glean/<your-platform>`.
+
+> **Note**: Currently, the only supported platform is `webext`. Therefore the only valid import is `@mozilla/glean/webext`.
+
+## "Module not found: Error: Can't resolve '@mozilla/glean/webext' in '...'"
+
+Glean.js relies on Node.js' [subpath exports](https://nodejs.org/api/packages.html#packages_subpath_exports) feature to define multiple package entry points.
+
+Please make sure that you are using a supported Node.js runtime (>= v12.7.0) and also make sure
+the tools you are using support this Node.js feature.
+
+> **Note**: If using Webpack, make sure you have a version >= 5.0.0 (see v5.0.0 [release notes](https://webpack.js.org/blog/2020-10-10-webpack-5-release/#major-changes-new-nodejs-ecosystem-features) for details).

glean/package.json

@@ -97,8 +97,5 @@
   },
   "dependencies": {
     "uuid": "^8.3.2"
-  },
-  "peerDependencies": {
-    "web-ext-types": "^3.2.1"
   }
 }