storyblok 3.31.1 → 3.32.0

package/README.md

@@ -96,12 +96,14 @@ $ storyblok pull-languages --space <SPACE_ID>
 
 Download your space's components schema as json. By default this command will download 2 files: 1 for the components and 1 for the presets; But if you pass a flag `--separate-files or --sf` the command will create file for each component and presets. And also you could pass a path `--path or -p` to save your components and presets.
 
+It's highly recommended to use also the `--prefix-presets-names` or `-ppn` parameter if you use `--separate-files` because it will prefix the names of the individual files with the name of the component. This feature solves the issue of multiple presets from different components but with the same name, being written in the same file. In a future major version this will become the default behavior.
+
 ```sh
 $ storyblok pull-components --space <SPACE_ID> # Will save files like components-1234.json
 ```
 
 ```sh
-$ storyblok pull-components --space <SPACE_ID> --separate-files  --file-name production # Will save files like feature-production.json grid-production.json
+$ storyblok pull-components --space <SPACE_ID> --separate-files --prefix-presets-names --file-name production # Will save files like feature-production.json grid-production.json
 ```
 
 #### Options

package/dist/cli.mjs

@@ -782,16 +782,14 @@ const parserError = (responseError) => {
   };
 };
 
-const saveFileFactory = async (fileName, content, path = "./") => {
-  return new Promise((resolve, reject) => {
-    fs.writeFile(`${path}${fileName}`, content, (err) => {
-      if (err) {
-        Promise.reject(err);
-        return;
-      }
-      Promise.resolve(true);
-    });
-  });
+const saveFileFactory = (fileName, content, path = "./") => {
+  try {
+    fs.writeFileSync(`${path}${fileName}`, content);
+    return true;
+  } catch (err) {
+    console.log(err);
+    return false;
+  }
 };
 
 const buildFilterQuery = (keys, operations, values) => {
@@ -1823,7 +1821,7 @@ const getNameFromComponentGroups = (groups, uuid) => {
   return "";
 };
 const pullComponents = async (api, options) => {
-  const { fileName, separateFiles, path } = options;
+  const { fileName, separateFiles, path, prefixPresetsNames } = options;
   try {
     const componentGroups = await api.getComponentGroups();
     const components = await api.getComponents();
@@ -1845,7 +1843,7 @@ const pullComponents = async (api, options) => {
       if (presets.length === 0)
         return;
       for (const preset in presets) {
-        const presetFileName = `${presets[preset].name}-${fileName}.json`;
+        const presetFileName = `${prefixPresetsNames ? `${presets[preset].preset.component}-` : ""}${presets[preset].name}-${fileName}.json`;
         const data2 = JSON.stringify(presets[preset], null, 2);
         saveFileFactory(presetFileName, data2, path);
       }
@@ -3584,10 +3582,10 @@ program.command("pull-languages").description("Download your space's languages s
     process.exit(1);
   }
 });
-program.command(COMMANDS.PULL_COMPONENTS).option("--sf, --separate-files [value]", "Argument to create a single file for each component").option("-p, --path <path>", "Path to save the component files").option("-f, --file-name <fileName>", "custom name to be used in file(s) name instead of space id").description("Download your space's components schema as json").action(async (options) => {
+program.command(COMMANDS.PULL_COMPONENTS).option("--sf, --separate-files [value]", "Argument to create a single file for each component").option("-p, --path <path>", "Path to save the component files").option("-f, --file-name <fileName>", "custom name to be used in file(s) name instead of space id").option("-ppn, --prefix-presets-names", "Prefixes the names of presets with the name of the components").description("Download your space's components schema as json").action(async (options) => {
   console.log(`${chalk.blue("-")} Executing pull-components task`);
   const space = program.space;
-  const { separateFiles, path: path2 } = options;
+  const { separateFiles, path: path2, prefixPresetsNames } = options;
   if (!space) {
     console.log(chalk.red("X") + " Please provide the space as argument --space YOUR_SPACE_ID.");
     process.exit(0);
@@ -3598,7 +3596,7 @@ program.command(COMMANDS.PULL_COMPONENTS).option("--sf, --separate-files [value]
       await api.processLogin();
     }
     api.setSpaceId(space);
-    await tasks.pullComponents(api, { fileName, separateFiles, path: path2 });
+    await tasks.pullComponents(api, { fileName, separateFiles, path: path2, prefixPresetsNames });
   } catch (e) {
     errorHandler(e, COMMANDS.PULL_COMPONENTS);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storyblok",
-  "version": "3.31.1",
+  "version": "3.32.0",
   "description": "A simple CLI to start Storyblok from your command line.",
   "repository": {
     "type": "git",