@grafana/create-plugin 0.0.1

package/src/commands/migrate.command.ts

@@ -0,0 +1,99 @@
+import { TEXT, MIGRATION_CONFIG } from '../constants';
+import { displayArrayAsList, printMessage, printSuccessMessage, confirmPrompt } from '../utils/utils.console';
+import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates';
+import { getOnlyExistingInCwd, getOnlyNotExistingInCwd, removeFilesInCwd } from '../utils/utils.files';
+import {
+  getPackageJsonUpdatesAsText,
+  updatePackageJson,
+  hasNpmDependenciesToUpdate,
+  getRemovableNpmDependencies,
+  removeNpmDependencies,
+  updateNpmScripts,
+} from '../utils/utils.npm';
+
+export const migrate = async () => {
+  try {
+    // 0. Warning
+    // -----------
+    printMessage(TEXT.migrationCommandWarning);
+
+    // 1. Add / update configuration files
+    // --------------------------
+    if (await confirmPrompt(TEXT.overrideFilesPrompt + '\n' + displayArrayAsList(MIGRATION_CONFIG.filesToOverride))) {
+      compileTemplateFiles(MIGRATION_CONFIG.filesToOverride, getTemplateData());
+      printSuccessMessage(TEXT.overrideFilesSuccess);
+    } else {
+      printMessage(TEXT.overrideFilesAborted);
+      process.exit(0);
+    }
+
+    // 2. Add necessary files if they don't exist (files we don't want to override)
+    // (skipped automatically if there are none)
+    // --------------------------------------------
+    const filesToExist = getOnlyNotExistingInCwd(MIGRATION_CONFIG.filesToExist);
+    if (filesToExist.length) {
+      if (await confirmPrompt(TEXT.filesToExistPrompt + '\n' + displayArrayAsList(filesToExist))) {
+        compileTemplateFiles(filesToExist, getTemplateData());
+        printSuccessMessage(TEXT.filesToExistSuccess);
+      } else {
+        printMessage(TEXT.filesToExistAborted);
+      }
+    }
+
+    // 3. Remove unnecessary files from the project
+    // (skipped automatically if there are none)
+    // --------------------------------------------
+    const filesToRemove = getOnlyExistingInCwd(MIGRATION_CONFIG.filesToRemove);
+    if (filesToRemove.length) {
+      if (await confirmPrompt(TEXT.removeFilesPrompt + '\n' + displayArrayAsList(filesToRemove))) {
+        removeFilesInCwd(filesToRemove);
+        printSuccessMessage(TEXT.removeFilesSuccess);
+      } else {
+        printMessage(TEXT.removeFilesAborted);
+      }
+    }
+
+    // 4. Add / update dependencies inside the `package.json`
+    // (skipped automatically if there is nothing to update)
+    // ------------------------------------------------
+    if (hasNpmDependenciesToUpdate()) {
+      if (await confirmPrompt(TEXT.updateNpmDependenciesPrompt + getPackageJsonUpdatesAsText())) {
+        updatePackageJson();
+        printSuccessMessage(TEXT.updateNpmDependenciesSuccess);
+      } else {
+        printMessage(TEXT.updateNpmDependenciesAborted);
+      }
+    }
+
+    // 5. Remove unncessary NPM dependencies from `package.json`
+    // (skipped automatically if there is nothing to be removed)
+    // ------------------------------------------------
+    const dependenciesToRemove = getRemovableNpmDependencies(MIGRATION_CONFIG.npmDependenciesToRemove);
+    const devDependenciesToRemove = getRemovableNpmDependencies(MIGRATION_CONFIG.devNpmDependenciesToRemove);
+    if (dependenciesToRemove.length) {
+      if (await confirmPrompt(TEXT.removeNpmDependenciesPrompt + '\n' + displayArrayAsList(dependenciesToRemove))) {
+        removeNpmDependencies(dependenciesToRemove);
+        removeNpmDependencies(devDependenciesToRemove, { devOnly: true });
+        printSuccessMessage(TEXT.removeNpmDependenciesSuccess);
+      } else {
+        printMessage(TEXT.removeNpmDependenciesAborted);
+      }
+    }
+
+    // 6. Add / update NPM scripts
+    // (skipped automatically if there is nothing to update)
+    // ------------------------------------------------
+    if (await confirmPrompt(TEXT.updateNpmScriptsPrompt)) {
+      updateNpmScripts();
+      printSuccessMessage(TEXT.updateNpmScriptsSuccess);
+    } else {
+      printMessage(TEXT.updateNpmScriptsAborted);
+    }
+
+    // 4. Summary
+    // -------------
+    printSuccessMessage(TEXT.migrationCommandSuccess);
+  } catch (error) {
+    console.error(error);
+  }
+};

package/src/commands/update.command.ts

@@ -0,0 +1,66 @@
+import { TEXT, UDPATE_CONFIG } from '../constants';
+import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates';
+import { confirmPrompt, selectPrompt, printMessage, printSuccessMessage } from '../utils/utils.console';
+import {
+  updatePackageJson,
+  hasNpmDependenciesToUpdate,
+  getPackageJsonUpdatesAsText,
+  updateNpmScripts,
+} from '../utils/utils.npm';
+
+export const update = async () => {
+  try {
+    // 0. Warning
+    // ----------
+    printMessage(TEXT.updateCommandWarning);
+
+    // 1. Add / update configuration files
+    // -----------------------------------
+    if (await confirmPrompt(TEXT.overrideFilesPrompt)) {
+      compileTemplateFiles(UDPATE_CONFIG.filesToOverride, getTemplateData());
+      printSuccessMessage(TEXT.overrideFilesSuccess);
+    } else {
+      printMessage(TEXT.overrideFilesAborted);
+      process.exit(0);
+    }
+
+    // 2. Add / update dependencies inside the `package.json`
+    // (skipped automatically if there is nothing to update)
+    // ------------------------------------------------
+    if (hasNpmDependenciesToUpdate()) {
+      const PROMPT_CHOICES = {
+        ALL: 'Yes, all of them',
+        ONLY_OUTDATED: 'Yes, but only the outdated ones',
+        NONE: 'No',
+      };
+      const shouldUpdateDeps = await selectPrompt(TEXT.updateNpmDependenciesPrompt + getPackageJsonUpdatesAsText(), [
+        PROMPT_CHOICES.ALL,
+        PROMPT_CHOICES.ONLY_OUTDATED,
+        PROMPT_CHOICES.NONE,
+      ]);
+
+      if (shouldUpdateDeps && shouldUpdateDeps !== PROMPT_CHOICES.NONE) {
+        updatePackageJson({ onlyOutdated: shouldUpdateDeps === PROMPT_CHOICES.ONLY_OUTDATED });
+        printSuccessMessage(TEXT.updateNpmDependenciesSuccess);
+      } else {
+        printMessage(TEXT.updateNpmDependenciesAborted);
+      }
+    }
+
+    // 3. Add / update NPM scripts
+    // (skipped automatically if there is nothing to update)
+    // ------------------------------------------------
+    if (await confirmPrompt(TEXT.updateNpmScriptsPrompt)) {
+      updateNpmScripts();
+      printSuccessMessage(TEXT.updateNpmScriptsSuccess);
+    } else {
+      printMessage(TEXT.updateNpmScriptsAborted);
+    }
+
+    // 4. Summary
+    // -------------
+    printSuccessMessage(TEXT.updateCommandSuccess);
+  } catch (error) {
+    console.error(error);
+  }
+};

package/src/constants.ts

@@ -0,0 +1,99 @@
+import path from 'path';
+
+export const IS_DEV = process.env.CREATE_PLUGIN_DEV !== undefined;
+
+export const DEV_EXPORT_DIR = path.join(__dirname, '..', 'generated');
+
+export const EXPORT_PATH_PREFIX = IS_DEV ? DEV_EXPORT_DIR : process.cwd();
+
+export const DIST_DIR = path.join(__dirname, 'dist');
+
+export const TEMPLATES_DIR = path.join(__dirname, '..', 'templates');
+
+// Partials are template files that can be used in other templates
+// (they won't be copied over to the generated folder as they are)
+export const PARTIALS_DIR = path.join(TEMPLATES_DIR, '_partials');
+
+export const TEMPLATE_PATHS: Record<string, string> = {
+  app: path.join(TEMPLATES_DIR, 'app'),
+  backend: path.join(TEMPLATES_DIR, 'backend'),
+  common: path.join(TEMPLATES_DIR, 'common'),
+  datasource: path.join(TEMPLATES_DIR, 'datasource'),
+  panel: path.join(TEMPLATES_DIR, 'panel'),
+  ciWorkflows: path.join(TEMPLATES_DIR, 'github', 'ci'),
+  isCompatibleWorkflow: path.join(TEMPLATES_DIR, 'github', 'is-compatible'),
+};
+
+export enum PLUGIN_TYPES {
+  app = 'app',
+  panel = 'panel',
+  datasource = 'datasource',
+}
+
+// This gets merged into variables coming from user prompts (when using Plop) or any other dynamic variables,
+// and will be available to use in the templates.
+// Example: "@grafana/ui": "{{ grafanaVersion }}"
+export const EXTRA_TEMPLATE_VARIABLES = {
+  grafanaVersion: '9.1.2',
+};
+
+export const MIGRATION_CONFIG = {
+  // Files that should be overriden during a migration.
+  // (paths are relative to the scaffolded projects root)
+  filesToOverride: [
+    '.config/',
+    '.eslintrc',
+    '.nvmrc',
+    '.prettierrc.js',
+    'docker-compose.yaml', // Using .yaml instead of .yml (https://yaml.org/faq.html)
+    'jest-setup.js',
+    'jest.config.js',
+    'tsconfig.json',
+  ],
+  // Files that are mandatory for the plugins, but we don't want to ever override them. We are only creating the ones that don't exist.
+  // (paths are relative to the scaffolded projects root)
+  filesToExist: ['CHANGELOG.md'],
+  // Files that are no longer needed for the project and possibly can be removed.
+  filesToRemove: ['Dockerfile', 'docker-compose.yml', 'webpack/', '.webpack/', '.prettierrc'],
+  // NPM dependencies that are no longer needed for the project and possibly can be removed.
+  npmDependenciesToRemove: ['ts-loader', 'babel-loader', '@grafana/toolkit'],
+  devNpmDependenciesToRemove: ['@grafana/toolkit', '@grafana/runtime', '@grafana/data', '@grafana/ui'],
+};
+
+export const UDPATE_CONFIG = {
+  // Files that should be overriden between configuration version updates.
+  filesToOverride: ['.config/'],
+};
+
+// prettier-ignore
+export const TEXT = {
+  overrideFilesPrompt: '**The following files will be overriden, would you like to continue?**',
+  overrideFilesSuccess: 'Configuration files updated successfully.',
+  overrideFilesAborted: 'Migration aborted.',
+
+  filesToExistPrompt: '**The following files are necessary for the project to work, can we scaffold them for you?**',
+  filesToExistSuccess: 'Extra necessaryily files created successfully.',
+  filesToExistAborted: 'No extra necessary files were scaffolded.',
+
+  removeFilesPrompt: '**The following files are possibly not needed for the project anymore, are you ok with us removing them?**',
+  removeFilesSuccess: 'Unnecessary files have been removed successfully.',
+  removeFilesAborted: 'No unnecessary files were deleted.',
+
+  updateNpmDependenciesPrompt: '**Would you like to update the following dependencies in the `package.json?`**',
+  updateNpmDependenciesSuccess: 'Successfully updated the NPM dependencies.',
+  updateNpmDependenciesAborted: 'No NPM dependencies have been updated.',
+
+  removeNpmDependenciesPrompt: '**Would you like to remove the following possibly unnecessary NPM dependencies?**',
+  removeNpmDependenciesSuccess: 'Unnecessary NPM dependencies removed successfully.',
+  removeNpmDependenciesAborted: 'No NPM dependencies have been removed.',
+
+  updateNpmScriptsPrompt: '**Would you like to update the `{ scripts }` in your `package.json`?**',
+  updateNpmScriptsSuccess: 'NPM scripts updated successfully.',
+  updateNpmScriptsAborted: 'No NPM scripts have been added or updated.',
+
+  migrationCommandWarning:  '**⚠️  Warning!**\nThis is going to change files in your current project to make it up-to-date with the latest plugin configuration.\nPlease make sure that you have backed up your changes.',
+  migrationCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/create-plugin.',
+
+  updateCommandWarning: '**⚠️  Warning!**\nThis is going to update files under the `.config/` folder.\nMake sure to commit your changes before running this script.',
+  updateCommandSuccess: '**Done.**\nIf you have any questions please open an issue/discussion in https://github.com/grafana/create-plugin.',
+}

package/src/utils/tests/utils.files.test.ts

@@ -0,0 +1,41 @@
+import { PLUGIN_TYPES, TEMPLATE_PATHS } from '../../constants';
+import { filterOutCommonFiles, isFile } from '../utils.files';
+
+describe('Utils/Files', () => {
+  describe('filterOutCommonFiles()', () => {
+    test('should remove common template files from the list that have a plugin-specific override', () => {
+      expect(
+        filterOutCommonFiles(
+          [
+            // Common template files
+            `${TEMPLATE_PATHS.common}/.config/.eslintrc`,
+            `${TEMPLATE_PATHS.common}/.config/.gitignore`,
+            `${TEMPLATE_PATHS.common}/.config/package.json`,
+
+            // Override of a common template file
+            `${TEMPLATE_PATHS.app}/.config/package.json`,
+
+            // Only exists in the plugin-type specific templates
+            `${TEMPLATE_PATHS.app}/.config/README.md`,
+          ],
+          PLUGIN_TYPES.app
+        )
+      ).toEqual([
+        `${TEMPLATE_PATHS.common}/.config/.eslintrc`,
+        `${TEMPLATE_PATHS.common}/.config/.gitignore`,
+        `${TEMPLATE_PATHS.app}/.config/package.json`,
+        `${TEMPLATE_PATHS.app}/.config/README.md`,
+      ]);
+    });
+  });
+
+  describe('isFile()', () => {
+    test('should return TRUE if the path is pointing to a file', () => {
+      expect(isFile(`${TEMPLATE_PATHS.common}/LICENSE`)).toBe(true);
+    });
+
+    test('should return FALSE if the path is pointing to a directory', () => {
+      expect(isFile(TEMPLATE_PATHS.common)).toBe(false);
+    });
+  });
+});

package/src/utils/tests/utils.handlebars.test.ts

@@ -0,0 +1,35 @@
+import { PLUGIN_TYPES } from '../../constants';
+import { normalizeId } from '../utils.handlebars';
+
+describe('Handlebars helpers', () => {
+  describe('normalize id', () => {
+    test.each([PLUGIN_TYPES.app, PLUGIN_TYPES.datasource, PLUGIN_TYPES.panel])(
+      'should return the id with the type appended',
+      (type: PLUGIN_TYPES) => {
+        const pluginName = 'my-plugin';
+        const orgName = 'my-org';
+        const actual = normalizeId(pluginName, orgName, type);
+        expect(actual).toEqual(`my-org-my-plugin-${type}`);
+      }
+    );
+    test.each([PLUGIN_TYPES.app, PLUGIN_TYPES.datasource, PLUGIN_TYPES.panel])(
+      'should not duplicate the type if it is already present',
+      (type: PLUGIN_TYPES) => {
+        const pluginName = `my-plugin-${type}`;
+        const orgName = 'my-org';
+        const actual = normalizeId(pluginName, orgName, type);
+        expect(actual).toEqual(`my-org-my-plugin-${type}`);
+      }
+    );
+
+    test.each([PLUGIN_TYPES.app, PLUGIN_TYPES.datasource, PLUGIN_TYPES.panel])(
+      'should not duplicate the type if it is already present (no dash before type)',
+      (type: PLUGIN_TYPES) => {
+        const pluginName = `my-plugin${type}`;
+        const orgName = 'my-org';
+        const actual = normalizeId(pluginName, orgName, type);
+        expect(actual).toEqual(`my-org-my-plugin-${type}`);
+      }
+    );
+  });
+});

package/src/utils/tests/utils.npm.test.ts

@@ -0,0 +1,193 @@
+import { updateNpmDependencies, getUpdatableNpmDependencies } from '../utils.npm';
+
+describe('Utils / NPM', () => {
+  describe('getDepenciesToBeUpdated()', () => {
+    test('it should return a summary of dependencies to be updated', () => {
+      expect(
+        getUpdatableNpmDependencies(
+          // current
+          {
+            '@grafana/tsconfig': '^1.2.0-rc1',
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.6.2',
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^7.3.9',
+            'node-plop': '0.26.3',
+          },
+          // new
+          {
+            '@grafana/tsconfig': '^2.0.0', // updated
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.4.2', // updated
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^7.3.9',
+          }
+        )
+      ).toEqual({
+        '@grafana/tsconfig': { prev: '^1.2.0-rc1', next: '^2.0.0' },
+        '@types/minimist': { prev: '^1.6.2', next: '^1.4.2' },
+      });
+    });
+
+    test('it should be possible to only update dependencies that are outdated', () => {
+      expect(
+        getUpdatableNpmDependencies(
+          // current
+          {
+            '@grafana/tsconfig': '^1.2.0-rc1',
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.6.2',
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^7.3.9',
+            'node-plop': '0.26.3',
+          },
+          // new
+          {
+            '@grafana/tsconfig': '^2.0.0', // updated
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.4.2', // updated - BUT older than the current one
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^7.3.9',
+          },
+          { onlyOutdated: true }
+        )
+      ).toEqual({
+        '@grafana/tsconfig': { prev: '^1.2.0-rc1', next: '^2.0.0' },
+      });
+    });
+
+    test('it should be able to override with using release channels like "latest"', () => {
+      expect(
+        getUpdatableNpmDependencies(
+          // current
+          {
+            '@grafana/tsconfig': 'latest',
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.6.2',
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^7.3.9',
+            'node-plop': '0.26.3',
+          },
+          // new
+          {
+            '@grafana/tsconfig': '^2.0.0', // updated
+            '@swc/core': 'latest', // updated
+            '@types/minimist': '^1.4.2', // updated
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^7.3.9',
+          }
+        )
+      ).toEqual({
+        '@grafana/tsconfig': { prev: 'latest', next: '^2.0.0' },
+        '@swc/core': { prev: '^1.2.162', next: 'latest' },
+        '@types/minimist': { prev: '^1.6.2', next: '^1.4.2' },
+      });
+    });
+  });
+
+  describe('updateDependencies()', () => {
+    test('it should update existing dependencies', () => {
+      expect(
+        updateNpmDependencies(
+          // dependencies
+          {
+            '@grafana/tsconfig': '^1.2.0-rc1',
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.2.2',
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^7.3.9',
+            'node-plop': '0.26.3',
+          },
+          // update summary
+          {
+            '@grafana/tsconfig': { prev: '^1.2.0-rc1', next: '^2.0.0' },
+            '@types/minimist': { prev: '^1.2.2', next: '^1.4.2' },
+          }
+        )
+      ).toEqual({
+        '@grafana/tsconfig': '^2.0.0', // updated
+        '@swc/core': '^1.2.162',
+        '@types/minimist': '^1.4.2', // updated
+        '@types/mkdirp': '^1.0.2',
+        '@types/semver': '^7.3.9',
+        'node-plop': '0.26.3',
+      });
+    });
+
+    test('it should add new depdendencies', () => {
+      expect(
+        updateNpmDependencies(
+          // dependencies
+          {
+            '@grafana/tsconfig': '^1.2.0-rc1',
+            '@swc/core': '^1.2.162',
+          },
+          // update summary
+          {
+            '@grafana/tsconfig': { prev: '^1.2.0-rc1', next: '^1.2.0-rc1' },
+            '@swc/core': { prev: '^1.2.162', next: '^1.2.162' },
+            '@types/minimist': { prev: null, next: '^1.4.2' }, // new
+          }
+        )
+      ).toEqual({
+        '@grafana/tsconfig': '^1.2.0-rc1',
+        '@swc/core': '^1.2.162',
+        '@types/minimist': '^1.4.2', // new
+      });
+    });
+
+    test('it should override `latest` and other release channels', () => {
+      expect(
+        updateNpmDependencies(
+          // dependencies
+          {
+            '@grafana/tsconfig': 'latest',
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.2.2',
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^8.0.0',
+            'node-plop': '0.26.3',
+          },
+          // update summary
+          {
+            '@grafana/tsconfig': { prev: 'latest', next: '^2.0.0' },
+          }
+        )
+      ).toEqual({
+        '@grafana/tsconfig': '^2.0.0', // updated
+        '@swc/core': '^1.2.162',
+        '@types/minimist': '^1.2.2',
+        '@types/mkdirp': '^1.0.2',
+        '@types/semver': '^8.0.0',
+        'node-plop': '0.26.3',
+      });
+    });
+
+    test('it should be able to override with using release channels like "latest"', () => {
+      expect(
+        updateNpmDependencies(
+          // dependencies
+          {
+            '@grafana/tsconfig': '^2.0.0',
+            '@swc/core': '^1.2.162',
+            '@types/minimist': '^1.2.2',
+            '@types/mkdirp': '^1.0.2',
+            '@types/semver': '^8.0.0',
+            'node-plop': '0.26.3',
+          },
+          // update summary
+          {
+            '@grafana/tsconfig': { prev: '', next: 'latest' },
+          }
+        )
+      ).toEqual({
+        '@grafana/tsconfig': 'latest', // updated
+        '@swc/core': '^1.2.162',
+        '@types/minimist': '^1.2.2',
+        '@types/mkdirp': '^1.0.2',
+        '@types/semver': '^8.0.0',
+        'node-plop': '0.26.3',
+      });
+    });
+  });
+});

package/src/utils/tests/utils.plugin.test.ts

@@ -0,0 +1,22 @@
+import { TEMPLATE_PATHS } from '../../constants';
+import { getPluginJson } from '../utils.plugin';
+
+describe('Utils / Plugins', () => {
+  describe('getPluginJson()', () => {
+    test('should return the parsed plugin JSON if the file exits', () => {
+      const srcDir = `${TEMPLATE_PATHS.app}/src`;
+      const pluginJson = getPluginJson(srcDir);
+
+      expect(pluginJson).toBeDefined();
+      expect(pluginJson.type).toBe('app');
+    });
+
+    test('should throw an error if the plugin.json is not found', () => {
+      const srcDir = `${TEMPLATE_PATHS.app}/src/unknown`;
+
+      expect(() => {
+        getPluginJson(srcDir);
+      }).toThrow();
+    });
+  });
+});

package/src/utils/tests/utils.templates.test.ts

@@ -0,0 +1,44 @@
+import { PLUGIN_TYPES } from '../../constants';
+import { getTemplateFiles } from '../utils.templates';
+
+describe('Utils / Templates', () => {
+  describe('getTemplateFiles()', () => {
+    test('should return with a list of files', () => {
+      expect(getTemplateFiles(PLUGIN_TYPES.app).length).toBeGreaterThan(0);
+    });
+
+    test('should be possible to filter templates by a sub-folder', () => {
+      const templateFiles = getTemplateFiles(PLUGIN_TYPES.app, '.config/types');
+
+      // Should have found at least one file
+      expect(templateFiles.length).toBeGreaterThan(0);
+
+      // A file that should live in this sub-directory
+      expect(templateFiles.find((t) => t.includes('custom.d.ts'))).not.toBeUndefined();
+
+      // Something that should not be found in this sub-directory
+      expect(templateFiles.find((t) => t.includes('Dockerfile'))).toBeUndefined();
+    });
+
+    test('should return an empty array when filtering by a non-existing sub-folder', () => {
+      const templateFiles = getTemplateFiles(PLUGIN_TYPES.app, '.config/types/foo/bar/unknown');
+
+      expect(Array.isArray(templateFiles)).toBe(true);
+      expect(templateFiles.length).toBe(0);
+    });
+
+    test('should be possible to filter for multiple different files', () => {
+      const templateFiles = getTemplateFiles(PLUGIN_TYPES.app, ['.eslintrc', '.prettierrc.js', 'tsconfig.json']);
+
+      expect(Array.isArray(templateFiles)).toBe(true);
+      expect(templateFiles.length).toBe(3);
+    });
+
+    test('should be possible to filter for a single file', () => {
+      const templateFiles = getTemplateFiles(PLUGIN_TYPES.app, '.config/types/custom.d.ts');
+
+      expect(Array.isArray(templateFiles)).toBe(true);
+      expect(templateFiles.length).toBe(1);
+    });
+  });
+});

package/src/utils/utils.console.ts

@@ -0,0 +1,41 @@
+const { marked } = require('marked');
+const TerminalRenderer = require('marked-terminal');
+const { Confirm, Select } = require('enquirer');
+
+marked.setOptions({
+  renderer: new TerminalRenderer(),
+});
+
+export function displayAsMarkdown(msg: string) {
+  return marked(msg);
+}
+
+export function displayArrayAsList(files: string[]) {
+  return ` - ${files.map((t) => `\`${t}\``).join('\n - ')}`;
+}
+
+export function printMessage(msg: string) {
+  console.log(displayAsMarkdown(`\n${msg}`));
+}
+
+export function printSuccessMessage(msg: string) {
+  console.log(displayAsMarkdown(`\n✔ ${msg}`));
+}
+
+export function confirmPrompt(message: string) {
+  const prompt = new Confirm({
+    name: 'question',
+    message: displayAsMarkdown(message),
+  });
+
+  return prompt.run();
+}
+
+export function selectPrompt(message: string, choices: string[]) {
+  const prompt = new Select({
+    choices,
+    message: displayAsMarkdown(message),
+  });
+
+  return prompt.run();
+}