Merge pull request #220 from timlindvall/fix-module-name

Author: dfreeman

packages/ember-css-modules/lib/modules-preprocessor.js

@@ -15,6 +15,19 @@ module.exports = class ModulesPreprocessor {
     this._modulesTree = null;
     this._modulesBasePath = null;
     this._modulesBridge = new Bridge();
+
+    /*
+     * The addon name we should use to look up modules.
+     * Uses moduleName if defined, else uses the parent/package name.
+     */
+    this._ownerName = null;
+
+    /*
+     * The parent/package name. This is used as a fallback to look up
+     * paths that may reference the package name instead of the
+     * module name. (See resolve-path.js)
+     */
+    this._parentName = null;
   }
 
   toTree(inputTree, path) {
@@ -37,10 +50,17 @@ module.exports = class ModulesPreprocessor {
         });
       }
 
+      // If moduleName is defined, that should override the parent's name.
+      // Otherwise, the template and generated module will disagree as to what the path should be.
+      let ownerParent = this.owner.getParent();
+      this._parentName = this.owner.getParentName();
+      let ownerName = ownerParent.moduleName ? ownerParent.moduleName() : this._parentName;
+      this._ownerName = ownerName;
+
       let modulesSources = new ModuleSourceFunnel(inputRoot, modulesInput, {
         include: ['**/*.' + this.owner.getFileExtension()],
         outputRoot,
-        parentName: this.owner.getParentName()
+        parentName: ownerName,
       });
 
       let modulesTree = new (require('broccoli-css-modules'))(modulesSources, {
@@ -184,10 +204,12 @@ module.exports = class ModulesPreprocessor {
 
     return this._resolvePath(importPath, fromFile, {
       defaultExtension: this.owner.getFileExtension(),
-      ownerName: this.owner.getParentName(),
+      ownerName: this._ownerName,
+      parentName: this._parentName,
       addonModulesRoot: this.owner.getAddonModulesRoot(),
       root: ensurePosixPath(this._modulesTree.inputPaths[0]),
-      parent: this.owner.getParent()
+      parent: this.owner.getParent(),
+      ui: this.owner.ui
     });
   }
 };

packages/ember-css-modules/lib/resolve-path.js

@@ -10,6 +10,16 @@ module.exports = function resolvePath(importPath, fromFile, options) {
     return resolveRelativePath(pathWithExtension, fromFile, options);
   } else if (isLocalPath(pathWithExtension, options)) {
     return resolveLocalPath(pathWithExtension, fromFile, options);
+  } else if (isLocalPathWithOldPackageNameRef(pathWithExtension, options)) {
+    const amendedPathWithExtension = pathWithExtension.replace(options.parentName, options.ownerName);
+    options.ui.writeWarnLine(
+      'For addons that define a moduleName, you should reference any CSS Modules provided by that addon ' +
+      'using its moduleName instead of the package name.\n' +
+      'Current path: ' + importPath + '\n' +
+      'Replace with: ' + importPath.replace(options.parentName, options.ownerName) + '\n' +
+      'File: ' + fromFile
+    );
+    return resolveLocalPath(amendedPathWithExtension, fromFile, options);
   } else {
     return resolveExternalPath(pathWithExtension, importPath, fromFile, options);
   }
@@ -23,6 +33,10 @@ function isLocalPath(importPath, options) {
   return importPath.indexOf(options.ownerName + '/') === 0;
 }
 
+function isLocalPathWithOldPackageNameRef(importPath, options) {
+  return (options.ownerName !== options.parentName) && importPath.indexOf(options.parentName + '/') === 0;
+}
+
 function resolveRelativePath(importPath, fromFile, options) {
   let absolutePath = ensurePosixPath(path.resolve(path.dirname(fromFile), importPath));
   return internalDep(absolutePath, options);
@@ -49,7 +63,12 @@ function resolveLocalPath(importPath, fromFile, options) {
 function resolveExternalPath(importPath, originalPath, fromFile, options) {
   let baseIndex = importPath[0] === '@' ? importPath.indexOf('/') + 1 : 0;
   let addonName = importPath.substring(0, importPath.indexOf('/', baseIndex));
-  let addon = options.parent.addons.find(addon => addon.name === addonName);
+  let addon = options.parent.addons.find((addon) => {
+    if (addon.moduleName) {
+      return addon.moduleName() === addonName;
+    }
+    return addon.name === addonName;
+  });
 
   if (!addon) {
     throw new Error(

test-packages/dummy-addon-with-module-name/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.hbs]
+insert_final_newline = false
+
+[*.{diff,md}]
+trim_trailing_whitespace = false

test-packages/dummy-addon-with-module-name/.ember-cli

@@ -0,0 +1,9 @@
+{
+  /**
+    Ember CLI sends analytics information by default. The data is completely
+    anonymous, but there are times when you might want to disable this behavior.
+
+    Setting `disableAnalytics` to true will prevent any data from being sent.
+  */
+  "disableAnalytics": false
+}

test-packages/dummy-addon-with-module-name/.eslintignore

@@ -0,0 +1,20 @@
+# unconventional js
+/blueprints/*/files/
+/vendor/
+
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+/node_modules/
+
+# misc
+/coverage/
+!.*
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/package.json.ember-try

test-packages/dummy-addon-with-module-name/.eslintrc.js

@@ -0,0 +1,53 @@
+module.exports = {
+  root: true,
+  parser: 'babel-eslint',
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module'
+  },
+  plugins: [
+    'ember'
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:ember/recommended'
+  ],
+  env: {
+    browser: true
+  },
+  rules: {
+    'ember/no-jquery': 'error'
+  },
+  overrides: [
+    // node files
+    {
+      files: [
+        '.eslintrc.js',
+        '.template-lintrc.js',
+        'ember-cli-build.js',
+        'index.js',
+        'testem.js',
+        'blueprints/*/index.js',
+        'config/**/*.js',
+        'tests/dummy/config/**/*.js'
+      ],
+      excludedFiles: [
+        'addon/**',
+        'addon-test-support/**',
+        'app/**',
+        'tests/dummy/app/**'
+      ],
+      parserOptions: {
+        sourceType: 'script'
+      },
+      env: {
+        browser: false,
+        node: true
+      },
+      plugins: ['node'],
+      rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
+        // add your custom rules and overrides for node files here
+      })
+    }
+  ]
+};

test-packages/dummy-addon-with-module-name/.gitignore

@@ -0,0 +1,25 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+/node_modules/
+
+# misc
+/.env*
+/.pnp*
+/.sass-cache
+/connect.lock
+/coverage/
+/libpeerconnection.log
+/npm-debug.log*
+/testem.log
+/yarn-error.log
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/package.json.ember-try

test-packages/dummy-addon-with-module-name/.npmignore

@@ -0,0 +1,32 @@
+# compiled output
+/dist/
+/tmp/
+
+# dependencies
+/bower_components/
+
+# misc
+/.bowerrc
+/.editorconfig
+/.ember-cli
+/.env*
+/.eslintignore
+/.eslintrc.js
+/.git/
+/.gitignore
+/.template-lintrc.js
+/.travis.yml
+/.watchmanconfig
+/bower.json
+/config/ember-try.js
+/CONTRIBUTING.md
+/ember-cli-build.js
+/testem.js
+/tests/
+/yarn.lock
+.gitkeep
+
+# ember-try
+/.node_modules.ember-try/
+/bower.json.ember-try
+/package.json.ember-try

test-packages/dummy-addon-with-module-name/.template-lintrc.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+  extends: 'recommended'
+};

test-packages/dummy-addon-with-module-name/.travis.yml

@@ -0,0 +1,67 @@
+---
+language: node_js
+node_js:
+  # we recommend testing addons with the same minimum supported node version as Ember CLI
+  # so that your addon works for all apps
+  - "8"
+
+sudo: false
+dist: trusty
+
+addons:
+  chrome: stable
+
+cache:
+  yarn: true
+
+env:
+  global:
+    # See https://git.io/vdao3 for details.
+    - JOBS=1
+
+branches:
+  only:
+    - master
+    # npm version tags
+    - /^v\d+\.\d+\.\d+/
+
+jobs:
+  fail_fast: true
+  allow_failures:
+    - env: EMBER_TRY_SCENARIO=ember-canary
+
+  include:
+    # runs linting and tests with current locked deps
+
+    - stage: "Tests"
+      name: "Tests"
+      install:
+        - yarn install --non-interactive
+      script:
+        - yarn lint:hbs
+        - yarn lint:js
+        - yarn test
+
+    - name: "Floating Dependencies"
+      script:
+        - yarn test
+
+    # we recommend new addons test the current and previous LTS
+    # as well as latest stable release (bonus points to beta/canary)
+    - stage: "Additional Tests"
+      env: EMBER_TRY_SCENARIO=ember-lts-3.4
+    - env: EMBER_TRY_SCENARIO=ember-lts-3.8
+    - env: EMBER_TRY_SCENARIO=ember-release
+    - env: EMBER_TRY_SCENARIO=ember-beta
+    - env: EMBER_TRY_SCENARIO=ember-canary
+    - env: EMBER_TRY_SCENARIO=ember-default-with-jquery
+
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash
+  - export PATH=$HOME/.yarn/bin:$PATH
+
+install:
+  - yarn install --no-lockfile --non-interactive
+
+script:
+  - node_modules/.bin/ember try:one $EMBER_TRY_SCENARIO