prefer addon.moduleName as telemetry if one exists, otherwise fallback to packageName #38
Conversation
…k to package name
lib/utils/get-module-path-for.js
Outdated
| * @returns {String} The runtime name of the addon | ||
| */ | ||
| function getAddonPackageName(packagePath) { | ||
| const indexPath = path.resolve(path.dirname(packagePath), 'index.js'); |
There was a problem hiding this comment.
We shouldn't assume packagePath + index.js is the right addon entry point. We have to respect ember-addon.main in package.json.
lib/utils/get-module-path-for.js
Outdated
| // this is bad, fix later | ||
| return moduleName && typeof moduleName === 'function' ? moduleName() : packageName; |
There was a problem hiding this comment.
We should probably do this in a try/catch block. In most cases that I've seen, the moduleName function is simple (e.g. it returns a string directly, without logic) but in some cases it is reasonable to access other context off of the addon instance (e.g. this.name). If an addon's moduleName implementation does this it will error and break telemetry gathering.
| @@ -18,12 +18,37 @@ for (let packagePath of packagePaths) { | |||
| let packageDir = path.dirname(path.resolve(cwd, packagePath)); | |||
|
|
|||
| if (pkg.keywords && pkg.keywords.includes('ember-addon')) { | |||
| ADDON_PATHS[packageDir] = pkg.name; | |||
| // build addon instance | |||
| ADDON_PATHS[packageDir] = getAddonPackageName(packagePath); | |||
There was a problem hiding this comment.
Should this be packageDir and not packagePath?
(If it is packagePath, this function dies attempting to require('package.json') on my team's addon, but if it is packageDir, then the native-class codemod is able to transform classes. Our setup is a multi-app monorepo that also contains a shared ember addon with reused components and services.)
fixes #37.
if the codemod telemetry helpers are being run from inside of an ember-addon, prefer to use the addon's moduleName if it exists, otherwise fallback to the package name from package.json.
This is important as many packages now use npm's scoped package feature, which allows you to create packages like
@company/package-name. In ember-land, these packages need to have a different module name (in this case, justpackage-name, as the @ syntax breaks handlebars invocation of templates from this package (ex:<@Company/Package-Name />)