edge-functions 2.12.1 → 3.0.0

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [3.0.0](https://github.com/aziontech/vulcan/compare/v2.12.1...v3.0.0) (2024-07-29)
+
+
+### ⚠ BREAKING CHANGES
+
+* change init command behavior.
+
+### Miscellaneous Chores
+
+* remove init cmd ([#364](https://github.com/aziontech/vulcan/issues/364)) ([eeb26bd](https://github.com/aziontech/vulcan/commit/eeb26bdac9a3f877cf54741b321e658ea5719158))
+
+## [3.0.0-stage.1](https://github.com/aziontech/vulcan/compare/v2.12.1...v3.0.0-stage.1) (2024-07-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* change init command behavior.
+
+### Miscellaneous Chores
+
+* remove init cmd ([#364](https://github.com/aziontech/vulcan/issues/364)) ([eeb26bd](https://github.com/aziontech/vulcan/commit/eeb26bdac9a3f877cf54741b321e658ea5719158))
+
 ### [2.12.1](https://github.com/aziontech/vulcan/compare/v2.12.0...v2.12.1) (2024-07-16)
 
 

package/README.md

@@ -43,7 +43,7 @@ Table:
 | Simple Js Esm                        | ✅      |
 | Simple Ts Esm                        | ✅      |
 
-Last test run date: 07/16/24 03:27:44 AM
+Last test run date: 07/29/24 03:38:09 AM
 ## Quick Installation
 
 For those who just want to use Vulcan in their project without contributing to the development, you can install it directly from npm.

package/lib/commands/init.commands.js

@@ -1,131 +1,38 @@
-import { join } from 'path';
-import { existsSync } from 'fs';
-import inquirer, { createPromptModule } from 'inquirer';
-import { TemplatesInitializer, TemplatesOptions, Messages } from '#constants';
-import { feedback, debug } from '#utils';
 import { vulcan } from '#env';
+import { feedback } from '#utils';
 
 import { Commands } from '#namespaces';
 
-const prompt = createPromptModule();
-
 /**
- * @description Get the selected template from the user
- * @param {Array} templateOptions - Array of template options
- * @param {string} template - Preset to select
- * @returns {object} - The selected template
+ * Throw a required attribute error.
+ * @param {string} arg - attribute that is required
+ * @throws {Error} - throws error based on arg
  */
-async function getTemplateSelection(templateOptions, template) {
-  if (template) {
-    const templateSelectionByLine = templateOptions.find(
-      (option) => option.message === template,
-    );
-    if (templateSelectionByLine) {
-      return templateSelectionByLine;
-    }
-  }
-
-  if (templateOptions.length > 1) {
-    const { templateChoice } = await inquirer.prompt([
-      {
-        type: 'list',
-        name: 'templateChoice',
-        message: 'Choose the template:',
-        choices: templateOptions.map((option) => ({
-          name: option.message,
-          value: option,
-        })),
-      },
-    ]);
-    return templateChoice;
-  }
-
-  return templateOptions[0]; // Assuming the first option is the default
+function throwError(arg) {
+  throw new Error(`'${arg}' is required.`);
 }
 
 /**
  * @function
  * @memberof Commands
- * @description Initializes a new project based on the selected framework template.
- * @param {object} options - Configuration options for initialization.
- * @param {string} options.template - Template to use for the project.
- * @param {string} options.preset - Preset to use for the project.
- * @param {string} options.name - Name of the new project.
- * If not provided, the function will prompt for it.
- * @example
- * initCommand({ name: 'my_new_project' });
+ * @description Initializes a new '.vulcan' file.
+ * @param {object} options - Configuration options for file initialization.
+ * @param {string} options.preset - Used preset.
+ * @param {string} options.mode - Used preset mode.
+ * @param {string} options.scope - Base path to create the file.
  */
-async function initCommand({ name, template, preset }) {
+async function initCommand({ preset, mode, scope }) {
   try {
-    const AVAILABLE_PRESETS = Object.keys(TemplatesInitializer);
-    let projectName = name;
-    let templateOptions = [];
-    let frameworkChoice;
-    const isPresetAvailable = AVAILABLE_PRESETS.find((t) => t === preset);
-
-    if (!isPresetAvailable && preset) {
-      feedback.error(
-        'The option entered does not exist, please select one of the options below.',
-      );
-    }
-
-    if (!isPresetAvailable) {
-      const { frameworkChoiceOps } = await prompt([
-        {
-          type: 'list',
-          name: 'frameworkChoiceOps',
-          message: 'Choose a preset for your project:',
-          choices: AVAILABLE_PRESETS,
-          pageSize: AVAILABLE_PRESETS.length,
-        },
-      ]);
-      frameworkChoice = frameworkChoiceOps;
-    } else {
-      frameworkChoice = preset;
-    }
-    templateOptions = TemplatesOptions[frameworkChoice]?.options || [];
-
-    const templateSelection = await getTemplateSelection(
-      templateOptions,
-      template,
-    );
-
-    while (!projectName) {
-      const dirExists = (dirName) => existsSync(join(process.cwd(), dirName));
-
-      // eslint-disable-next-line no-await-in-loop
-      const { projectName: inputName } = await prompt([
-        {
-          type: 'input',
-          name: 'projectName',
-          message: 'Enter your project name:',
-        },
-      ]);
+    if (!preset) throwError('preset');
+    if (!mode) throwError('mode');
+    if (!scope) throwError('scope');
 
-      if (inputName && !dirExists(inputName)) {
-        projectName = inputName;
-      } else if (dirExists(inputName)) {
-        feedback.pending(Messages.errors.folder_name_already_exists(inputName));
-      } else {
-        feedback.pending(Messages.info.name_required);
-      }
-    }
+    await vulcan.createVulcanEnv({ preset, mode }, scope);
 
-    const createFrameworkTemplate = TemplatesInitializer[frameworkChoice];
-    if (createFrameworkTemplate) {
-      const dest = join(process.cwd(), projectName);
-      feedback.interactive.await(Messages.init.info.preparing);
-      await createFrameworkTemplate(projectName, templateSelection.value);
-      feedback.interactive.success(Messages.init.success.ready);
-      await vulcan.createVulcanEnv(
-        { preset: frameworkChoice.toLowerCase(), mode: templateSelection.mode },
-        dest,
-      );
-    } else {
-      feedback.error(Messages.errors.invalid_choice);
-    }
+    feedback.info(`'.vulcan file created!'`);
   } catch (error) {
-    debug.error(error);
+    feedback.error(`Error creating '.vulcan' file: ${error.message}`);
+    process.exit(1);
   }
 }
 

package/lib/constants/index.js

@@ -1,15 +1,5 @@
 import RuntimeApis from './runtime-apis.constants.js';
 import AzionEdges from './azion-edges.constants.js';
 import Messages from './messages/index.js';
-import {
-  TemplatesInitializer,
-  TemplatesOptions,
-} from './framework-initializer.constants.js';
 
-export {
-  AzionEdges,
-  RuntimeApis,
-  Messages,
-  TemplatesInitializer,
-  TemplatesOptions,
-};
+export { AzionEdges, RuntimeApis, Messages };

package/lib/constants/messages/index.js

@@ -1,11 +1,9 @@
 import build from './build.messages.js';
 import env from './env.messages.js';
-import init from './init.messages.js';
 import global from './global.messages.js'; // generic messages
 
 const Messages = {
   env,
-  init,
   build,
   ...global,
 };

package/lib/main.js

@@ -116,10 +116,10 @@ function startVulcanProgram() {
 
   program
     .command('init')
-    .option('--name <project_name>', 'Project name')
     .option('--preset <preset_name>', 'Preset name', false)
-    .option('--template <template_name>', 'Template name', false)
-    .description('Initialize a new project')
+    .option('--mode <preset_mode>', 'Preset mode', false)
+    .option('--scope <scope>', 'project scope - base path', false)
+    .description('Initialize .vulcan file')
     .action(async (options) => {
       const { initCommand } = await import('#commands');
       await initCommand(options);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "edge-functions",
   "type": "module",
-  "version": "2.12.1",
+  "version": "3.0.0",
   "description": "Tool to launch and build JavaScript/Frameworks. This tool automates polyfills for Edge Computing and assists in creating Workers, notably for the Azion platform.",
   "main": "lib/main.js",
   "bin": {

package/lib/constants/framework-initializer.constants.js

@@ -1,190 +0,0 @@
-import { exec } from '#utils';
-
-const generateCloneCommand = (projectName, subdirectory) => {
-  const fullPath = `templates/${subdirectory}`;
-
-  return `
-mkdir ${projectName}
-cd ${projectName}
-git init
-git remote add -f origin https://github.com/aziontech/vulcan-examples.git > /dev/null 2>&1
-git config core.sparseCheckout true
-echo "${fullPath}/*" >> .git/info/sparse-checkout
-git pull origin main > /dev/null 2>&1
-mv ${fullPath}/* ./
-rm -rf templates .git
-`.trim();
-};
-
-const TemplatesOptions = {
-  JavaScript: {
-    options: [
-      {
-        value: 'javascript/simple-js-router',
-        message: 'Simple JS Router',
-        mode: 'compute',
-      },
-      {
-        value: 'javascript/simple-js-node',
-        message: 'Simple Node.js with Polyfills',
-        mode: 'compute',
-      },
-    ],
-  },
-  TypeScript: {
-    options: [{ value: 'typescript/simple-ts-router', mode: 'compute' }],
-  },
-  Angular: {
-    options: [
-      { value: 'angular-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Astro: {
-    options: [
-      { value: 'astro-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Gatsby: {
-    options: [
-      { value: 'gatsby-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Hexo: {
-    options: [
-      { value: 'hexo-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Jekyll: {
-    options: [
-      { value: 'jekyll-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Next: {
-    options: [
-      {
-        value: 'nextjs/next-13-static',
-        message: 'Next 13 - Static (export)',
-        mode: 'deliver',
-      },
-      {
-        value: 'nextjs/edge-app-13-5-6',
-        message: 'Next 13 - Edge Runtime (App Router) ',
-        mode: 'compute',
-      },
-      {
-        value: 'nextjs/edge-pages-13-5-6',
-        message: 'Next 13 - Edge Runtime (Pages Router)',
-        mode: 'compute',
-      },
-      {
-        value: 'nextjs/node-pages-12-3-1',
-        message: 'Next 12 - Node Runtime (Edge compatible with polyfills)',
-        mode: 'compute',
-      },
-    ],
-  },
-  React: {
-    options: [
-      { value: 'react-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Svelte: {
-    options: [
-      { value: 'svelte-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Vue: {
-    options: [
-      { value: 'vue-static', message: 'static supported', mode: 'deliver' },
-    ],
-  },
-  Vite: {
-    options: [
-      {
-        value: 'vue3-vite-static',
-        message: 'static supported',
-        mode: 'deliver',
-      },
-    ],
-  },
-  Emscripten: {
-    options: [{ value: 'emscripten-wasm', mode: 'compute' }],
-  },
-  Rustwasm: {
-    options: [{ value: 'rust-wasm-yew-ssr', mode: 'compute' }],
-  },
-  Eleventy: {
-    options: [
-      {
-        value: 'eleventy-static',
-        message: 'static supported',
-        mode: 'deliver',
-      },
-    ],
-  },
-};
-
-const TemplatesInitializer = {
-  JavaScript: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'JavaScript', false, false);
-  },
-  TypeScript: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'TypeScript', false, false);
-  },
-  Rustwasm: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'RustWasm', false, false);
-  },
-  Emscripten: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Emscripten', false, false);
-  },
-  Angular: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Angular', false, false);
-  },
-  Astro: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Astro', false, false);
-  },
-  Gatsby: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Gatsby', false, false);
-  },
-  Hexo: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Hexo', false, false);
-  },
-  Jekyll: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Jekyll', false, false);
-  },
-  Next: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Next', false, false);
-  },
-  React: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'React', false, false);
-  },
-  Svelte: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Svelte', false, false);
-  },
-  Vue: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Vue', false, false);
-  },
-  Vite: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Vite', false, false);
-  },
-  Eleventy: async (projectName, subdirectory) => {
-    const cloneCommands = generateCloneCommand(projectName, subdirectory);
-    await exec(cloneCommands, 'Eleventy', false, false);
-  },
-};
-
-export { TemplatesInitializer, TemplatesOptions };

package/lib/constants/messages/init.messages.js

@@ -1,17 +0,0 @@
-/**
-Init command messages object.
-@property {object} success - Success messages.
-@property {object} info - Information messages.
-@property {object} errors - Error messages.
- */
-const init = {
-  success: {
-    ready: 'All ready. The template has been initialized.',
-  },
-  info: {
-    preparing: 'Preparing everything. Wait a moment...',
-  },
-  errors: {},
-};
-
-export default init;