add display name; update tests

Author: thymikee

packages/create-app/src/lib/__tests__/bin.test.ts

@@ -7,13 +7,15 @@ test('should format config without plugins', () => {
     .toMatchInlineSnapshot(`
       "import { platformIOS } from '@rock-js/platform-ios';
       import { platformAndroid } from '@rock-js/platform-android';
+      import { platformHarmony } from '@rock-js/platform-harmony';
       import { pluginMetro } from '@rock-js/plugin-metro';
 
       export default {
         bundler: pluginMetro(),
         platforms: {
           ios: platformIOS(),
           android: platformAndroid(),
+          harmony: platformHarmony(),
         },
       };
       "
@@ -25,6 +27,7 @@ test('should format config with plugins', () => {
     {
       type: 'npm',
       name: 'test',
+      displayName: 'test',
       packageName: '@rock-js/plugin-test',
       version: 'latest',
       directory: 'template',

packages/create-app/src/lib/__tests__/templates.test.ts

@@ -6,6 +6,7 @@ test('resolveTemplateName with built-in templates', () => {
   expect(resolveTemplate(TEMPLATES, 'default')).toEqual({
     type: 'npm',
     name: 'default',
+    displayName: 'default',
     packageName: '@rock-js/template-default',
     version: 'latest',
     directory: '.',
@@ -16,6 +17,7 @@ test('resolveTemplateName with local paths', () => {
   expect(resolveTemplate(TEMPLATES, './directory/template-1')).toEqual({
     type: 'local',
     name: 'template-1',
+    displayName: 'template-1',
     localPath: path.resolve('./directory/template-1'),
     directory: '.',
     packageName: 'template-1',
@@ -24,6 +26,7 @@ test('resolveTemplateName with local paths', () => {
   expect(resolveTemplate(TEMPLATES, '../../up/up/away/template-2')).toEqual({
     type: 'local',
     name: 'template-2',
+    displayName: 'template-2',
     localPath: path.resolve('../../up/up/away/template-2'),
     directory: '.',
     packageName: 'template-2',
@@ -32,6 +35,7 @@ test('resolveTemplateName with local paths', () => {
   expect(resolveTemplate(TEMPLATES, '/absolute/path/template-3')).toEqual({
     type: 'local',
     name: 'template-3',
+    displayName: 'template-3',
     localPath: '/absolute/path/template-3',
     directory: '.',
     packageName: 'template-3',
@@ -42,6 +46,7 @@ test('resolveTemplateName with local paths', () => {
   ).toEqual({
     type: 'local',
     name: 'template-4',
+    displayName: 'template-4',
     localPath: '/url-based/path/template-4',
     directory: '.',
     packageName: 'template-4',
@@ -50,6 +55,7 @@ test('resolveTemplateName with local paths', () => {
   expect(resolveTemplate(TEMPLATES, './directory/template-5.tgz')).toEqual({
     type: 'local',
     name: 'template-5',
+    displayName: 'template-5',
     localPath: path.resolve('./directory/template-5.tgz'),
     directory: '.',
     packageName: 'template-5',
@@ -58,6 +64,7 @@ test('resolveTemplateName with local paths', () => {
   expect(resolveTemplate(TEMPLATES, '../up/template-6.tar')).toEqual({
     type: 'local',
     name: 'template-6',
+    displayName: 'template-6',
     localPath: path.resolve('../up/template-6.tar'),
     directory: '.',
     packageName: 'template-6',
@@ -66,6 +73,7 @@ test('resolveTemplateName with local paths', () => {
   expect(resolveTemplate(TEMPLATES, '/root/directory/template-7.tgz')).toEqual({
     type: 'local',
     name: 'template-7',
+    displayName: 'template-7',
     localPath: '/root/directory/template-7.tgz',
     directory: '.',
     packageName: 'template-7',
@@ -76,20 +84,23 @@ test('resolveTemplateName with npm packages', () => {
   expect(resolveTemplate(TEMPLATES, 'package-name')).toEqual({
     type: 'npm',
     name: 'package-name',
+    displayName: 'package-name',
     directory: '.',
     packageName: 'package-name',
     version: 'latest',
   });
   expect(resolveTemplate(TEMPLATES, '[email protected]')).toEqual({
     type: 'npm',
     name: 'package-name',
+    displayName: 'package-name',
     directory: '.',
     packageName: 'package-name',
     version: '1.2.3',
   });
   expect(resolveTemplate(TEMPLATES, '@scoped/[email protected]')).toEqual({
     type: 'npm',
     name: '@scoped/package-name',
+    displayName: '@scoped/package-name',
     directory: '.',
     packageName: '@scoped/package-name',
     version: '1.2.3',

packages/create-app/src/lib/templates.ts

@@ -9,6 +9,7 @@ export type TemplateInfo = NpmTemplateInfo | LocalTemplateInfo;
 export type NpmTemplateInfo = {
   type: 'npm';
   name: string;
+  displayName: string;
   version: string;
   packageName: string;
   /** Directory inside package that contains the template */
@@ -21,6 +22,7 @@ export type LocalTemplateInfo = {
   type: 'local';
   name: string;
   localPath: string;
+  displayName: string | undefined;
   packageName: string;
   directory: string | undefined;
   importName?: string;
@@ -31,6 +33,7 @@ export const TEMPLATES: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'default',
+    displayName: 'default',
     packageName: '@rock-js/template-default',
     version: 'latest',
     directory: '.',
@@ -41,6 +44,7 @@ export const PLUGINS: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'brownfield-ios',
+    displayName: 'Brownfield iOS',
     packageName: '@rock-js/plugin-brownfield-ios',
     hint: 'Setup packaging React Native app as a XCFramework',
     version: 'latest',
@@ -50,6 +54,7 @@ export const PLUGINS: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'brownfield-android',
+    displayName: 'Brownfield Android',
     packageName: '@rock-js/plugin-brownfield-android',
     hint: 'Setup packaging React Native app as an AAR',
     version: 'latest',
@@ -62,6 +67,7 @@ export const BUNDLERS: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'metro',
+    displayName: 'Metro',
     packageName: '@rock-js/plugin-metro',
     version: 'latest',
     directory: 'template',
@@ -70,6 +76,7 @@ export const BUNDLERS: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'repack',
+    displayName: 'Re.Pack',
     packageName: '@rock-js/plugin-repack',
     version: 'latest',
     directory: 'template',
@@ -81,6 +88,7 @@ export const PLATFORMS: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'ios',
+    displayName: 'iOS',
     packageName: '@rock-js/platform-ios',
     version: 'latest',
     directory: 'template',
@@ -89,6 +97,7 @@ export const PLATFORMS: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'android',
+    displayName: 'Android',
     packageName: '@rock-js/platform-android',
     version: 'latest',
     directory: 'template',
@@ -97,6 +106,7 @@ export const PLATFORMS: TemplateInfo[] = [
   {
     type: 'npm',
     name: 'harmony',
+    displayName: 'Harmony (experimental)',
     packageName: '@rock-js/platform-harmony',
     version: 'latest',
     directory: 'template',
@@ -183,6 +193,7 @@ export function resolveTemplate(
     return {
       type: 'local',
       name: basename.slice(0, basename.length - ext.length),
+      displayName: basename.slice(0, basename.length - ext.length),
       localPath: resolveAbsolutePath(name),
       directory: '.',
       packageName: basename.slice(0, basename.length - ext.length),
@@ -195,6 +206,7 @@ export function resolveTemplate(
   return {
     type: 'npm',
     name: getNpmLibraryName(name),
+    displayName: getNpmLibraryName(name),
     packageName: getNpmLibraryName(name),
     directory: '.',
     version: getNpmLibraryVersion(name) ?? 'latest',

packages/create-app/src/lib/utils/prompts.ts

@@ -96,7 +96,7 @@ export async function promptTemplate(
     // @ts-expect-error todo
     options: templates.map((template) => ({
       value: template,
-      label: template.name,
+      label: template.displayName,
     })),
   });
 }
@@ -118,7 +118,7 @@ export function promptPlatforms(
     // @ts-expect-error todo
     options: platforms.map((platform) => ({
       value: platform,
-      label: platform.name,
+      label: platform.displayName,
     })),
   });
 }
@@ -135,7 +135,7 @@ export function promptPlugins(
     // @ts-expect-error todo fixup type
     options: plugins.map((plugin) => ({
       value: plugin,
-      label: plugin.name,
+      label: plugin.displayName,
       hint: plugin.hint,
     })),
     required: false,
@@ -155,7 +155,7 @@ export function promptBundlers(
     // @ts-expect-error todo fixup type
     options: bundlers.map((bundler) => ({
       value: bundler,
-      label: bundler.name,
+      label: bundler.displayName,
     })),
   });
 }