@rancher/create-extension 1.0.0-rc.2 → 1.0.1

package/update/upgrade

@@ -1,6 +1,6 @@
 #!/usr/bin/env sh
 
-SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )"/.. &> /dev/null && pwd )
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 
 echo "Upgrading Rancher Shell"
 
@@ -19,13 +19,13 @@ fi
 # Check for a clean git repository
 if [ ! -d ".git" ] && [ "${FORCE}" == "false" ]; then
   echo "Not runnning in a git repository. Re-run with -f to ignore this check"
-  echo "Note: This action will update your files - running in a git repository will ensure you have visibility over changes made"
+  echo "Note: This action will update yuor files - running in a git repsository will ensure you have visibility over changes made"
   exit 1 
 fi
 
 if [[ $(git diff --stat) != '' ]] && [ "${FORCE}" == "false" ]; then
   echo "Git repository is not clean. Re-run with -f to ignore this check"
-  echo "Note: This action will update your files - running in a clean git repository will ensure you have visibility over changes made"
+  echo "Note: This action will update yuor files - running in a clean git repsository will ensure you have visibility over changes made"
   exit 1 
 fi
 
@@ -42,7 +42,7 @@ if [ "${HAS_SHELL}" != "1" ]; then
 fi
 
 # Copy files for the top-level folder (from the app creator)
-rsync ${SCRIPT_DIR}/app/files/* .
+rsync --exclude nuxt.config.js ${SCRIPT_DIR}/app/files/* .
 
 # Go through each folder in the pkg folder and update their files
 for pkg in ./pkg/*

package/migrate/config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  nodeRequirement:   '20.0.0',
-  isDry:             process.argv.includes('--dry'),
-  isVerbose:         process.argv.includes('--verbose'),
-  isSuggest:         process.argv.includes('--suggest'),
-  removePlaceholder: 'REMOVE',
-};

package/migrate/ignore.js

@@ -1,14 +0,0 @@
-module.exports = [
-  '**/node_modules/**',
-  '**/dist/**',
-  '**/dist-pkg/**',
-  '**/.vscode/**',
-  '**/assets/**',
-  '**/charts/**',
-  '**/extensions/**',
-  '**/scripts/vue-migrate.js',
-  'docusaurus/**',
-  'storybook-static/**',
-  'storybook/**',
-  'migration/**',
-];

package/migrate/init

@@ -1,35 +0,0 @@
-#!/usr/bin/env node
-
-const { setParams, printLog, printUsage } = require('./utils/content');
-const {
-  packageUpdates,
-  nvmUpdates,
-  vueConfigUpdates,
-  vueSyntaxUpdates,
-  routerUpdates,
-  eslintUpdates,
-  tsUpdates,
-  stylesUpdates,
-} = require('./tasks');
-const params = require('./params');
-
-(function main() {
-  if (process.argv.includes('--help') || process.argv.includes('-h')) {
-    printUsage();
-
-    return;
-  }
-
-  setParams(params);
-
-  packageUpdates(params);
-  nvmUpdates(params);
-  vueConfigUpdates(params);
-  vueSyntaxUpdates(params);
-  routerUpdates(params);
-  eslintUpdates(params);
-  tsUpdates(params);
-  stylesUpdates(params);
-
-  printLog();
-})();

package/migrate/package.json

@@ -1,23 +0,0 @@
-{
-  "name": "@rancher/create-migration",
-  "description": "Rancher UI Vue3 migration helper",
-  "version": "0.0.0",
-  "license": "Apache-2.0",
-  "author": "SUSE",
-  "private": false,
-  "bin": "./init",
-  "files": [
-    "**/*.*",
-    "init"
-  ],
-  "engines": {
-    "node": ">=20.0.0"
-  },
-  "dependencies": {
-    "diff": "^7.0.0",
-    "fs-extra": "^10.0.0",
-    "glob": "^11.0.0",
-    "path": "^0.12.7",
-    "semver": "^7.6.3"
-  }
-}

package/migrate/params.js

@@ -1,7 +0,0 @@
-const ignore = require('./ignore');
-
-module.exports = {
-  paths:          null,
-  ignorePatterns: [],
-  ignore,
-};

package/migrate/stats.js

@@ -1,13 +0,0 @@
-// stats.js
-module.exports = {
-  libraries:  [],
-  node:       [],
-  nvmrc:      [],
-  webpack:    [],
-  router:     [],
-  resolution: [],
-  eslint:     [],
-  vueSyntax:  [],
-  style:      [],
-  total:      [],
-};

package/migrate/tasks/eslintUpdates.js

@@ -1,70 +0,0 @@
-const glob = require('glob');
-const fs = require('fs');
-const path = require('path');
-const stats = require('../stats');
-const { writeContent, printContent } = require('../utils/content');
-
-/**
- * ESLint Updates
- * Files: .eslintrc.js, .eslintrc.json, .eslintrc.yml
- */
-const eslintUpdates = (params) => {
-  const files = glob.sync(params.paths || '**/.eslintrc.*{js,json,yml}', { ignore: params.ignore });
-  const replacePlugins = [
-    ['plugin:vue/essential', 'plugin:vue/vue3-essential'],
-    ['plugin:vue/strongly-recommended', 'plugin:vue/vue3-strongly-recommended'],
-    ['plugin:vue/recommended', 'plugin:vue/vue3-recommended']
-  ];
-  const newRules = {
-    'vue/one-component-per-file':       'off',
-    'vue/no-deprecated-slot-attribute': 'off',
-    'vue/require-explicit-emits':       'off',
-    'vue/v-on-event-hyphenation':       'off',
-  };
-
-  files.forEach((file) => {
-    const originalContent = fs.readFileSync(file, 'utf8');
-    let content = originalContent;
-    const matchedCases = [];
-
-    replacePlugins.forEach(([text, replacement]) => {
-      if (content.includes(text)) {
-        content = content.replaceAll(text, replacement);
-        matchedCases.push([text, replacement]);
-
-        writeContent(file, content, originalContent);
-      }
-    });
-
-    const eslintConfigPath = path.join(process.cwd(), `${ file }`);
-    let eslintConfig;
-
-    try {
-      eslintConfig = require(eslintConfigPath);
-    } catch (error) {
-      eslintConfig = {};
-    }
-
-    if (!eslintConfig.rules) {
-      eslintConfig.rules = {};
-    }
-
-    Object.keys(newRules).forEach((rule) => {
-      if (!eslintConfig.rules[rule]) {
-        eslintConfig.rules[rule] = newRules[rule];
-        matchedCases.push(rule);
-      }
-    });
-
-    if (matchedCases.length) {
-      const updatedConfig = `module.exports = ${ JSON.stringify(eslintConfig, null, 2) }`;
-
-      writeContent(file, updatedConfig, originalContent);
-      printContent(file, `Updating ESLint`, matchedCases);
-      stats.eslint.push(file);
-      stats.total.push(file);
-    }
-  });
-};
-
-module.exports = eslintUpdates;

package/migrate/tasks/index.js

@@ -1,19 +0,0 @@
-const packageUpdates = require('./packageUpdates');
-const nvmUpdates = require('./nvmUpdates');
-const vueConfigUpdates = require('./vueConfigUpdates');
-const vueSyntaxUpdates = require('./vueSyntaxUpdates');
-const routerUpdates = require('./routerUpdates');
-const eslintUpdates = require('./eslintUpdates');
-const tsUpdates = require('./tsUpdates');
-const stylesUpdates = require('./stylesUpdates');
-
-module.exports = {
-  packageUpdates,
-  nvmUpdates,
-  vueConfigUpdates,
-  vueSyntaxUpdates,
-  routerUpdates,
-  eslintUpdates,
-  tsUpdates,
-  stylesUpdates,
-};

package/migrate/tasks/nvmUpdates.js

@@ -1,51 +0,0 @@
-const fs = require('fs');
-const glob = require('glob');
-const semver = require('semver');
-const stats = require('../stats');
-const { printContent, writeContent } = require('../utils/content');
-const { nodeRequirement, isDry, isSuggest } = require('../config');
-
-/**
- * NVM updates
- * Files: .nvmrc
- *
- * Verify presence of .nvmrc, create one if none, update if any
- */
-const nvmUpdates = (params) => {
-  const files = glob.sync(params.paths || '**/.nvmrc', { ignore: params.ignore });
-  const nvmRequirement = 20;
-
-  if (files.length === 0) {
-    // If no .nvmrc files found, create one
-    const newFilePath = '.nvmrc';
-
-    if (!isDry && !isSuggest) {
-      fs.writeFileSync(newFilePath, nvmRequirement.toString());
-      printContent(newFilePath, `Created ${ newFilePath } with Node version ${ nvmRequirement }`, '');
-    }
-
-    writeContent(newFilePath, nvmRequirement.toString(), '');
-    stats.nvmrc.push(newFilePath);
-    stats.total.push(newFilePath);
-  }
-
-  files.forEach((file) => {
-    if (file) {
-      const originalContent = fs.readFileSync(file, 'utf8');
-      let content = originalContent;
-      const nodeVersionMatch = content.match(/([0-9.x]+)/g);
-      const nodeVersion = semver.coerce(nodeVersionMatch[0]);
-
-      // Ensure node version is up to date
-      if (nodeVersion && semver.lt(nodeVersion, semver.coerce(nodeRequirement))) {
-        printContent(file, `Updating node ${ [nodeVersionMatch[0], nvmRequirement] }`);
-        content = content.replaceAll(nodeVersionMatch[0], nvmRequirement);
-        writeContent(file, content, originalContent);
-        stats.nvmrc.push(file);
-        stats.total.push(file);
-      }
-    }
-  });
-};
-
-module.exports = nvmUpdates;

package/migrate/tasks/packageUpdates.js

@@ -1,242 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const glob = require('glob');
-const semver = require('semver');
-const stats = require('../stats');
-const { nodeRequirement, removePlaceholder } = require('../config');
-const { writeContent, printContent } = require('../utils/content');
-
-function packageUpdates(params) {
-  const files = glob.sync(params.paths || '**/package.json', { ignore: params.ignore });
-
-  files.forEach((file) => {
-    const originalContent = fs.readFileSync(file, 'utf8');
-    let content = originalContent;
-
-    const [librariesContent, replaceLibraries] = packageUpdatesLibraries(file, content);
-
-    if (replaceLibraries.length) {
-      content = librariesContent;
-      printContent(file, `Updating libraries`, replaceLibraries);
-      stats.libraries.push(file);
-    }
-
-    const [nodeContent, replaceNode] = packageUpdatesEngine(file, content);
-
-    if (replaceNode.length) {
-      content = nodeContent;
-      printContent(file, `Updating node engine`, replaceNode);
-      stats.node.push(file);
-    }
-
-    const [resolutionContent, replaceResolution] = packageUpdatesResolution(file, content);
-
-    if (replaceResolution.length) {
-      content = resolutionContent;
-      printContent(file, `Updating resolutions`, replaceResolution);
-      stats.libraries.push(file);
-    }
-
-    const [annotationsContent, annotationsChanges] = packageUpdatesAnnotations(file, content);
-
-    if (annotationsChanges.length) {
-      content = annotationsContent;
-      printContent(file, `Updating annotations`, annotationsChanges);
-      stats.annotations = stats.annotations || [];
-      stats.annotations.push(file);
-    }
-
-    if (
-      replaceLibraries.length ||
-      replaceNode.length ||
-      replaceResolution.length ||
-      annotationsChanges.length
-    ) {
-      writeContent(file, content, originalContent);
-      stats.total.push(file);
-    }
-  });
-}
-
-function packageUpdatesLibraries(file, oldContent) {
-  let content = oldContent;
-  let parsedJson = JSON.parse(content);
-  const replaceLibraries = [];
-  const types = ['dependencies', 'devDependencies', 'peerDependencies'];
-
-  // [Library name, new version or new library, new library version]
-  const librariesUpdates = [
-    ['@rancher/shell', '^3.0.0'],
-    ['@rancher/components', '^0.3.0-alpha.1'],
-    ['@nuxt/babel-preset-app', removePlaceholder],
-    ['@types/jest', '^29.5.2'],
-    ['@typescript-eslint/eslint-plugin', '~5.4.0'],
-    ['@typescript-eslint/parser', '~5.4.0'],
-    ['@vue/cli-plugin-babel', '~5.0.0'],
-    ['@vue/cli-plugin-e2e-cypress', '~5.0.0'],
-    ['@vue/cli-plugin-eslint', '~5.0.0'],
-    ['@vue/cli-plugin-router', '~5.0.0'],
-    ['@vue/cli-plugin-typescript', '~5.0.0'],
-    ['@vue/cli-plugin-unit-jest', '~5.0.0'],
-    ['@vue/cli-plugin-vuex', '~5.0.0'],
-    ['@vue/cli-service', '~5.0.0'],
-    ['@vue/eslint-config-typescript', '~9.1.0'],
-    ['@vue/vue2-jest', '@vue/vue3-jest', '^27.0.0-alpha.1'],
-    ['@vue/test-utils', '~2.0.0-0'],
-    ['core-js', '3.25.3'],
-    ['cache-loader', '^4.1.0'],
-    ['node-polyfill-webpack-plugin', '^3.0.0'],
-    ['portal-vue', '~3.0.0'],
-    ['require-extension-hooks-babel', '1.0.0'],
-    ['require-extension-hooks-vue', '3.0.0'],
-    ['require-extension-hooks', '0.3.3'],
-    ['sass-loader', '~12.0.0'],
-    ['typescript', '~4.5.5'],
-    ['vue-router', '~4.0.3'],
-    ['vue-virtual-scroll-list', 'vue3-virtual-scroll-list', '0.2.1'],
-    ['vue', '~3.2.13'],
-    ['vuex', '~4.0.0'],
-    ['xterm', '5.2.1'],
-  ];
-
-  types.forEach((type) => {
-    if (parsedJson[type]) {
-      librariesUpdates.forEach(([library, newVersion, newLibraryVersion]) => {
-        if (parsedJson[type][library]) {
-          const version = semver.coerce(parsedJson[type][library]);
-
-          if (newVersion === removePlaceholder) {
-            // Remove library
-            replaceLibraries.push([library, [parsedJson[type][library], removePlaceholder]]);
-            delete parsedJson[type][library];
-            content = JSON.stringify(parsedJson, null, 2);
-          } else if (newLibraryVersion) {
-            // Replace with a new library
-            replaceLibraries.push([library, [parsedJson[type][library], newVersion, newLibraryVersion]]);
-            content = content.replace(
-              `"${ library }": "${ parsedJson[type][library] }"`,
-              `"${ newVersion }": "${ newLibraryVersion }"`
-            );
-            parsedJson = JSON.parse(content);
-          } else if (version && semver.lt(version, semver.coerce(newVersion))) {
-            // Update library version if outdated
-            replaceLibraries.push([library, [parsedJson[type][library], newVersion]]);
-            content = content.replace(
-              `"${ library }": "${ parsedJson[type][library] }"`,
-              `"${ library }": "${ newVersion }"`
-            );
-            parsedJson = JSON.parse(content);
-          }
-        } else if (newLibraryVersion && library === newVersion) {
-          // Add new library if it doesn't exist
-          parsedJson[type][library] = newLibraryVersion;
-          replaceLibraries.push([library, [null, newLibraryVersion]]);
-          content = JSON.stringify(parsedJson, null, 2);
-        }
-      });
-    }
-  });
-
-  return [content, replaceLibraries];
-}
-
-function packageUpdatesEngine(file, oldContent) {
-  let content = oldContent;
-  let parsedJson = JSON.parse(content);
-  const replaceNode = [];
-
-  if (parsedJson.engines) {
-    const outdated = semver.lt(semver.coerce(parsedJson.engines.node), semver.coerce(nodeRequirement));
-
-    if (outdated) {
-      replaceNode.push([parsedJson.engines.node, nodeRequirement]);
-      content = content.replace(
-        `"node": "${ parsedJson.engines.node }"`,
-        `"node": ">=${ nodeRequirement }"`
-      );
-      parsedJson = JSON.parse(content);
-    }
-  }
-
-  return [content, replaceNode];
-}
-
-function packageUpdatesResolution(file, oldContent) {
-  let content = oldContent;
-  let parsedJson = JSON.parse(content);
-  const replaceResolution = [];
-  const resolutions = [
-    ['@vue/cli-service/html-webpack-plugin', '^5.0.0'],
-    ['**/webpack', removePlaceholder],
-  ];
-
-  if (parsedJson.resolutions) {
-    resolutions.forEach(([library, newVersion]) => {
-      if (newVersion === removePlaceholder) {
-        delete parsedJson.resolutions[library];
-        content = JSON.stringify(parsedJson, null, 2);
-        parsedJson = JSON.parse(content);
-      } else if (!parsedJson.resolutions[library]) {
-        parsedJson.resolutions[library] = newVersion;
-        content = JSON.stringify(parsedJson, null, 2);
-        parsedJson = JSON.parse(content);
-      } else {
-        const outdated = semver.lt(
-          semver.coerce(parsedJson.resolutions[library]),
-          semver.coerce(newVersion)
-        );
-
-        if (outdated) {
-          replaceResolution.push([parsedJson.engines.node, nodeRequirement]);
-          content = content.replace(
-            `"${ library }": "${ parsedJson.resolutions[library] }"`,
-            `"${ library }": "${ newVersion }"`
-          );
-          parsedJson = JSON.parse(content);
-        }
-      }
-    });
-  }
-
-  return [content, replaceResolution];
-}
-
-function packageUpdatesAnnotations(file, oldContent) {
-  let content = oldContent;
-  const parsedJson = JSON.parse(content);
-  const changesMade = [];
-
-  // Check if the file is in pkg/*/package.json
-  const dirName = path.dirname(file); // e.g., 'pkg/extension-name'
-  const parentDirName = path.basename(path.dirname(dirName)); // Should be 'pkg'
-
-  if (parentDirName === 'pkg') {
-    // The file is in pkg/<extension-name>/package.json
-    const annotations = {
-      'catalog.cattle.io/rancher-version':      '>= 2.10.0-0',
-      'catalog.cattle.io/ui-extension-version': '>= 3.0.0',
-    };
-
-    if (!parsedJson.rancher) {
-      parsedJson.rancher = { annotations };
-      changesMade.push('Added rancher annotations');
-    } else if (!parsedJson.rancher.annotations) {
-      parsedJson.rancher.annotations = annotations;
-      changesMade.push('Added rancher annotations');
-    } else {
-      // Merge existing annotations with the new ones
-      parsedJson.rancher.annotations = {
-        ...parsedJson.rancher.annotations,
-        ...annotations,
-      };
-      changesMade.push('Updated rancher annotations');
-    }
-
-    // Update content
-    content = JSON.stringify(parsedJson, null, 2);
-  }
-
-  return [content, changesMade];
-}
-
-module.exports = packageUpdates;

package/migrate/tasks/routerUpdates.js

@@ -1,23 +0,0 @@
-const glob = require('glob');
-const { replaceCases } = require('../utils/content');
-
-/**
- * Vue Router
- * Files: .vue, .js, .ts
- */
-const routerUpdates = (params) => {
-  const files = glob.sync(params.paths || '**/*.{vue,js,ts}', { ignore: params.ignore });
-  const replacementCases = [
-    [`import Router from 'vue-router'`, `import { createRouter } from 'vue-router'`, 'Ensure correct import of createRouter'],
-    [`vueApp.use(Router)`, `const router = createRouter({})`, 'Update router initialization'],
-    [`Vue.use(Router)`, `const router = createRouter({})`, 'Update router initialization'],
-
-    [/import\s*\{([^}]*)\s* RouteConfig\s*([^}]*)\}\s*from\s*'vue-router'/g, (match, before, after) => `import {${ before.trim() } RouteRecordRaw ${ after.trim() }} from 'vue-router'`, 'Update RouteConfig to RouteRecordRaw'],
-    [/import\s*\{([^}]*)\s* Location\s*([^}]*)\}\s*from\s*'vue-router'/g, (match, before, after) => `import {${ before.trim() } RouteLocation ${ after.trim() }} from 'vue-router'`, 'Update Location to RouteLocation'],
-    ['mode: \'history\'', 'history: createWebHistory()', 'Update router mode to history'],
-  ];
-
-  replaceCases('router', files, replacementCases, `Updating Vue Router`);
-};
-
-module.exports = routerUpdates;

package/migrate/tasks/stylesUpdates.js

@@ -1,19 +0,0 @@
-const glob = require('glob');
-const { replaceCases } = require('../utils/content');
-
-/**
- * Update styles (e.g., replace ::v-deep with :deep)
- */
-const stylesUpdates = (params) => {
-  const files = glob.sync(params.paths || '**/*.{vue,scss,css}', { ignore: params.ignore });
-  const cases = [
-    // Replace '::v-deep' without parentheses with ':deep()'
-    [/::v-deep(?!\()/g, ':deep()', 'Replace ::v-deep with :deep()'],
-    // Replace '::v-deep(' with ':deep('
-    [/::v-deep\(/g, ':deep(', 'Replace ::v-deep( with :deep('],
-  ];
-
-  replaceCases('style', files, cases, `Updating styles`);
-};
-
-module.exports = stylesUpdates;

package/migrate/tasks/tsUpdates.js

@@ -1,19 +0,0 @@
-const { isSuggest } = require('../config');
-
-/* eslint-disable no-console */
-/**
- * TS Updates
- * Files: tsconfig*.json
- *
- * Add information about TS issues, recommend @ts-nocheck as temporary solution
- */
-const tsUpdates = (params) => {
-  if (!isSuggest) {
-    console.warn('TS checks are stricter and may require to be fixed manually.',
-      'Use @ts-nocheck to give you time to fix them.',
-      'Add exception to your ESLint config to avoid linting errors.');
-  }
-  // TODO: Add case
-};
-
-module.exports = tsUpdates;

package/migrate/tasks/vueConfigUpdates.js

@@ -1,30 +0,0 @@
-const fs = require('fs');
-const glob = require('glob');
-const stats = require('../stats');
-const { writeContent } = require('../utils/content');
-
-/**
- * Vue config update
- * Files: vue.config.js
- *
- * Verify vue.config presence of deprecated Webpack5 options
- * - devServer.public: 'path' -> client: { webSocketURL: 'path' }
- */
-const vueConfigUpdates = (params) => {
-  const files = glob.sync(params.paths || 'vue.config**.js', { ignore: params.ignore });
-
-  files.forEach((file) => {
-    const originalContent = fs.readFileSync(file, 'utf8');
-    const content = originalContent;
-
-    // Verify vue.config presence of deprecated Webpack5 options
-    if (content.includes('devServer.public: \'path\'')) {
-      writeContent(file, content, originalContent);
-      stats.webpack.push(file);
-      stats.total.push(file);
-      // TODO: Add replacement
-    }
-  });
-};
-
-module.exports = vueConfigUpdates;