improve component blueprint for octane

.eslintrc.js

@@ -1,3 +1,4 @@
+/* eslint-env node */
 module.exports = {
   root: true,
   parserOptions: {

blueprints/-addon-import.js

@@ -0,0 +1,48 @@
+'use strict';
+
+const stringUtil = require('ember-cli-string-utils');
+const path = require('path');
+const inflector = require('inflection');
+
+module.exports = {
+  description: 'Generates an import wrapper.',
+
+  fileMapTokens: function () {
+    return {
+      __name__: function (options) {
+        return options.dasherizedModuleName;
+      },
+      __path__: function (options) {
+        return inflector.pluralize(options.locals.blueprintName);
+      },
+      __root__: function (options) {
+        if (options.inRepoAddon) {
+          return path.join('lib', options.inRepoAddon, 'app');
+        }
+        return 'app';
+      },
+    };
+  },
+
+  locals: function (options) {
+    let addonRawName = options.inRepoAddon ? options.inRepoAddon : options.project.name();
+    let addonName = stringUtil.dasherize(addonRawName);
+    let fileName = stringUtil.dasherize(options.entity.name);
+    let blueprintName = options.originBlueprintName;
+    let modulePathSegments = [
+      addonName,
+      inflector.pluralize(options.originBlueprintName),
+      fileName,
+    ];
+
+    if (blueprintName.match(/-addon/)) {
+      blueprintName = blueprintName.substr(0, blueprintName.indexOf('-addon'));
+      modulePathSegments = [addonName, inflector.pluralize(blueprintName), fileName];
+    }
+
+    return {
+      modulePath: modulePathSegments.join('/'),
+      blueprintName: blueprintName,
+    };
+  },
+};

blueprints/component-addon/files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+export { default } from '<%= modulePath %>';

blueprints/component-addon/index.js

@@ -0,0 +1,76 @@
+'use strict';
+
+const path = require('path');
+const stringUtil = require('ember-cli-string-utils');
+const getPathOption = require('ember-cli-get-component-path-option');
+const normalizeEntityName = require('ember-cli-normalize-entity-name');
+const useEditionDetector = require('../edition-detector');
+
+module.exports = useEditionDetector({
+  description: 'Generates a component.',
+
+  fileMapTokens: function () {
+    return {
+      __path__: function (options) {
+        if (options.pod) {
+          return path.join(options.podPath, options.locals.path, options.dasherizedModuleName);
+        }
+        return 'components';
+      },
+      __name__: function (options) {
+        if (options.pod) {
+          return 'component';
+        }
+        return options.dasherizedModuleName;
+      },
+      __root__: function (options) {
+        if (options.inRepoAddon) {
+          return path.join('lib', options.inRepoAddon, 'app');
+        }
+        return 'app';
+      },
+      __templatepath__: function (options) {
+        if (options.pod) {
+          return path.join(options.podPath, options.locals.path, options.dasherizedModuleName);
+        }
+        return 'templates/components';
+      },
+      __templatename__: function (options) {
+        if (options.pod) {
+          return 'template';
+        }
+        return options.dasherizedModuleName;
+      },
+    };
+  },
+
+  normalizeEntityName: function (entityName) {
+    return normalizeEntityName(entityName);
+  },
+
+  locals: function (options) {
+    let addonRawName = options.inRepoAddon ? options.inRepoAddon : options.project.name();
+    let addonName = stringUtil.dasherize(addonRawName);
+    let fileName = stringUtil.dasherize(options.entity.name);
+    let importPathName = [addonName, 'components', fileName].join('/');
+    let templatePath = '';
+
+    if (options.pod) {
+      importPathName = [addonName, 'components', fileName, 'component'].join('/');
+    }
+
+    if (this.project.isEmberCLIAddon() || (options.inRepoAddon && !options.inDummy)) {
+      if (options.pod) {
+        templatePath = './template';
+      } else {
+        templatePath = [addonName, 'templates/components', fileName].join('/');
+      }
+    }
+
+    return {
+      modulePath: importPathName,
+      templatePath,
+      path: getPathOption(options),
+    };
+  },
+});

blueprints/component-addon/native-files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+export { default } from '<%= modulePath %>';

blueprints/component-class-addon/files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+export { default } from '<%= modulePath %>';

blueprints/component-class-addon/index.js

@@ -0,0 +1,54 @@
+'use strict';
+
+const path = require('path');
+const stringUtil = require('ember-cli-string-utils');
+const getPathOption = require('ember-cli-get-component-path-option');
+const normalizeEntityName = require('ember-cli-normalize-entity-name');
+const useEditionDetector = require('../edition-detector');
+
+module.exports = useEditionDetector({
+  description: 'Generates a component class.',
+
+  fileMapTokens: function () {
+    return {
+      __path__: function (options) {
+        if (options.pod) {
+          return path.join(options.podPath, options.locals.path, options.dasherizedModuleName);
+        }
+        return 'components';
+      },
+      __name__: function (options) {
+        if (options.pod) {
+          return 'component';
+        }
+        return options.dasherizedModuleName;
+      },
+      __root__: function (options) {
+        if (options.inRepoAddon) {
+          return path.join('lib', options.inRepoAddon, 'app');
+        }
+        return 'app';
+      },
+    };
+  },
+
+  normalizeEntityName: function (entityName) {
+    return normalizeEntityName(entityName);
+  },
+
+  locals: function (options) {
+    let addonRawName = options.inRepoAddon ? options.inRepoAddon : options.project.name();
+    let addonName = stringUtil.dasherize(addonRawName);
+    let fileName = stringUtil.dasherize(options.entity.name);
+    let importPathName = [addonName, 'components', fileName].join('/');
+
+    if (options.pod) {
+      importPathName = [addonName, 'components', fileName, 'component'].join('/');
+    }
+
+    return {
+      modulePath: importPathName,
+      path: getPathOption(options),
+    };
+  },
+});

blueprints/component-class-addon/native-files/__root__/__path__/__name__.js

@@ -0,0 +1 @@
+export { default } from '<%= modulePath %>';

blueprints/component-class/files/__root__/__path__/__name__.js

@@ -0,0 +1,3 @@
+<%= importComponent %>
+<%= importTemplate %>
+export default <%= defaultExport %>

blueprints/component-class/index.js

@@ -0,0 +1,175 @@
+'use strict';
+
+const path = require('path');
+const SilentError = require('silent-error');
+const stringUtil = require('ember-cli-string-utils');
+const pathUtil = require('ember-cli-path-utils');
+const getPathOption = require('ember-cli-get-component-path-option');
+const normalizeEntityName = require('ember-cli-normalize-entity-name');
+const { EOL } = require('os');
+const { has } = require('@ember/edition-utils');
+
+const OCTANE = has('octane');
+
+// TODO: this should be reading from the @ember/canary-features module
+// need to refactor broccoli/features.js to be able to work more similarly
+// to https://github.com/emberjs/data/pull/6231
+const EMBER_GLIMMER_SET_COMPONENT_TEMPLATE = true;
+
+// intentionally avoiding use-edition-detector
+module.exports = {
+  description: 'Generates a component class.',
+
+  availableOptions: [
+    {
+      name: 'path',
+      type: String,
+      default: 'components',
+      aliases: [{ 'no-path': '' }],
+    },
+    {
+      name: 'component-class',
+      type: ['@ember/component', '@glimmer/component', '@ember/component/template-only'],
+      default: OCTANE ? '@glimmer/component' : '@ember/component',
+      aliases: [
+        { cc: '@ember/component' },
+        { gc: '@glimmer/component' },
+        { tc: '@ember/component/template-only' },
+      ],
+    },
+    {
+      name: 'component-structure',
+      type: OCTANE ? ['flat', 'nested', 'classic'] : ['classic'],
+      default: OCTANE ? 'flat' : 'classic',
+      aliases: OCTANE ? [{ fs: 'flat' }, { ns: 'nested' }, { cs: 'classic' }] : [{ cs: 'classic' }],
+    },
+  ],
+
+  init() {
+    this._super && this._super.init.apply(this, arguments);
+    let isOctane = has('octane');
+
+    this.availableOptions.forEach((option) => {
+      if (option.name === 'component-class') {
+        if (isOctane) {
+          option.default = '@glimmer/component';
+        } else {
+          option.default = '@ember/component';
+        }
+      } else if (option.name === 'component-structure') {
+        if (isOctane) {
+          option.type = ['flat', 'nested', 'classic'];
+          option.default = 'flat';
+          option.aliases = [{ fs: 'flat' }, { ns: 'nested' }, { cs: 'classic' }];
+        } else {
+          option.type = ['classic'];
+          option.default = 'classic';
+          option.aliases = [{ cs: 'classic' }];
+        }
+      }
+    });
+
+    this.EMBER_GLIMMER_SET_COMPONENT_TEMPLATE = EMBER_GLIMMER_SET_COMPONENT_TEMPLATE || isOctane;
+  },
+
+  install() {
+    if (!this.EMBER_GLIMMER_SET_COMPONENT_TEMPLATE) {
+      throw new SilentError(
+        'Usage of `ember generate component-class` is only available on canary'
+      );
+    }
+
+    return this._super.install.apply(this, arguments);
+  },
+
+  fileMapTokens(options) {
+    let commandOptions = this.options;
+
+    if (commandOptions.pod) {
+      return {
+        __path__() {
+          return path.join(options.podPath, options.locals.path, options.dasherizedModuleName);
+        },
+        __name__() {
+          return 'component';
+        },
+      };
+    } else if (
+      commandOptions.componentStructure === 'classic' ||
+      commandOptions.componentStructure === 'flat'
+    ) {
+      return {
+        __path__() {
+          return 'components';
+        },
+      };
+    } else if (commandOptions.componentStructure === 'nested') {
+      return {
+        __path__() {
+          return `components/${options.dasherizedModuleName}`;
+        },
+        __name__() {
+          return 'index';
+        },
+      };
+    }
+  },
+
+  normalizeEntityName(entityName) {
+    return normalizeEntityName(
+      entityName.replace(/\.js$/, '') //Prevent generation of ".js.js" files
+    );
+  },
+
+  locals(options) {
+    let sanitizedModuleName = options.entity.name.replace(/\//g, '-');
+    let classifiedModuleName = stringUtil.classify(sanitizedModuleName);
+
+    let templatePath = '';
+    let importComponent = '';
+    let importTemplate = '';
+    let defaultExport = '';
+
+    // if we're in an addon, build import statement
+    if (options.project.isEmberCLIAddon() || (options.inRepoAddon && !options.inDummy)) {
+      if (options.pod) {
+        templatePath = './template';
+      } else {
+        templatePath =
+          pathUtil.getRelativeParentPath(options.entity.name) +
+          'templates/components/' +
+          stringUtil.dasherize(options.entity.name);
+      }
+    }
+
+    let componentClass = options.componentClass;
+
+    switch (componentClass) {
+      case '@ember/component':
+        importComponent = `import Component from '@ember/component';`;
+        if (templatePath) {
+          importTemplate = `import layout from '${templatePath}';${EOL}`;
+          defaultExport = `Component.extend({${EOL}  layout${EOL}});`;
+        } else {
+          defaultExport = `Component.extend({${EOL}});`;
+        }
+        break;
+      case '@glimmer/component':
+        importComponent = `import Component from '@glimmer/component';`;
+        defaultExport = `class ${classifiedModuleName}Component extends Component {\n}`;
+        break;
+      case '@ember/component/template-only':
+        importComponent = `import templateOnly from '@ember/component/template-only';`;
+        defaultExport = `templateOnly();`;
+        break;
+    }
+
+    return {
+      importTemplate,
+      importComponent,
+      defaultExport,
+      path: getPathOption(options),
+      componentClass,
+    };
+  },
+};