Documented what the regular expression /\/\-[\w\-]+\.hbs/ does

Author: ijlee2

lib/migrator.js

@@ -75,6 +75,15 @@ module.exports = class Migrator {
         // Extract '/app/templates/components/nested1/nested-component.hbs'
         let filePathFromApp = templateFilePath.slice(this.projectRoot.length);
 
+        /*
+          When Ember sees `{{partial "foo"}}`, it will look for the template in
+          two locations:
+
+          - `app/templates/foo.hbs`
+          - `app/templates/-foo.hbs`
+
+          If `filePathFromApp` matches the latter pattern, we remove the hyphen. 
+        */
         if (/\/\-[\w\-]+\.hbs/.test(filePathFromApp)) {
           filePathFromApp = filePathFromApp.replace('/-', '/');
         }

test/fixtures/classic-to-flat/example-1/input.js

@@ -66,10 +66,15 @@ module.exports = {
 
         // A partial template
         'partials': {
-          'partials-template.hbs': '{{!-- partials-template.hbs --}}',
+          'partial-one-template.hbs': '{{!-- partial-one-template.hbs --}}',
+          'partial-two-template.hbs': '{{!-- partial-two-template.hbs --}}',
+          '-partial-three-template.hbs': '{{!-- partial-three-template.hbs --}}',
+
           'with-partial.hbs': [
             '{{!-- with-partial.hbs --}}',
-            '{{partial "components/partials/partials-template"}}'
+            '{{partial "components/partials/partial-one-template"}}',
+            '{{partial "components/partials/partial-two-template"}}',
+            '{{partial "components/partials/partial-three-template"}}'
           ].join('\n')
         }
       }

test/fixtures/classic-to-flat/example-1/output.js

@@ -44,7 +44,9 @@ module.exports = {
       'partials': {
         'with-partial.hbs': [
           '{{!-- with-partial.hbs --}}',
-          '{{partial "components/partials/partials-template"}}'
+          '{{partial "components/partials/partial-one-template"}}',
+          '{{partial "components/partials/partial-two-template"}}',
+          '{{partial "components/partials/partial-three-template"}}'
         ].join('\n')
       }
     },
@@ -60,7 +62,9 @@ module.exports = {
 
         // A partial template
         'partials': {
-          'partials-template.hbs': '{{!-- partials-template.hbs --}}',
+          'partial-one-template.hbs': '{{!-- partial-one-template.hbs --}}',
+          'partial-two-template.hbs': '{{!-- partial-two-template.hbs --}}',
+          '-partial-three-template.hbs': '{{!-- partial-three-template.hbs --}}'
         }
       }
     }

test/fixtures/classic-to-nested/example-1/input.js

@@ -66,10 +66,15 @@ module.exports = {
 
         // A partial template
         'partials': {
-          'partials-template.hbs': '{{!-- partials-template.hbs --}}',
+          'partial-one-template.hbs': '{{!-- partial-one-template.hbs --}}',
+          'partial-two-template.hbs': '{{!-- partial-two-template.hbs --}}',
+          '-partial-three-template.hbs': '{{!-- partial-three-template.hbs --}}',
+
           'with-partial.hbs': [
             '{{!-- with-partial.hbs --}}',
-            '{{partial "components/partials/partials-template"}}'
+            '{{partial "components/partials/partial-one-template"}}',
+            '{{partial "components/partials/partial-two-template"}}',
+            '{{partial "components/partials/partial-three-template"}}'
           ].join('\n')
         }
       }

test/fixtures/classic-to-nested/example-1/output.js

@@ -55,7 +55,9 @@ module.exports = {
         'with-partial': {
           'index.hbs': [
             '{{!-- with-partial.hbs --}}',
-            '{{partial "components/partials/partials-template"}}'
+            '{{partial "components/partials/partial-one-template"}}',
+            '{{partial "components/partials/partial-two-template"}}',
+            '{{partial "components/partials/partial-three-template"}}'
           ].join('\n')
         }
       }
@@ -72,7 +74,9 @@ module.exports = {
 
         // A partial template
         'partials': {
-          'partials-template.hbs': '{{!-- partials-template.hbs --}}',
+          'partial-one-template.hbs': '{{!-- partial-one-template.hbs --}}',
+          'partial-two-template.hbs': '{{!-- partial-two-template.hbs --}}',
+          '-partial-three-template.hbs': '{{!-- partial-three-template.hbs --}}'
         }
       }
     }