vite-plugin-decap-cms 0.4.0 → 0.5.1

package/README.md

@@ -1,70 +1,70 @@
-# vite-plugin-decap-cms
-
-> A Vite plugin to connect Decap CMS
-
-![NPM Version](https://img.shields.io/npm/v/vite-plugin-decap-cms)
-![NPM Downloads](https://img.shields.io/npm/dm/vite-plugin-decap-cms)
-![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/ghostrider-05/vite-plugin-decap-cms)
-
-> [!WARNING]
-> This plugin has not reached a stable version, 1.0.0, and can include breaking changes following the semver specification. This plugin is open for contributions, both for code, suggestions and (missing) documentation.
-
-## Install
-
-```sh
-pnpm add vite-plugin-decap-cms -D
-npm install vite-plugin-decap-cms -D
-yarn add vite-plugin-decap-cms -D
-```
-
-## Usage
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite'
-import decap, {
-    createFolderCollection,
-    createField,
-} from 'vite-plugin-decap-cms'
-
-export default defineConfig({
-    publicDir: 'public',
-    plugins: [
-        decap({
-            config: {
-                backend: {
-                    name: 'test-repo',
-                },
-                mediaFolder: '/src/public/',
-                collections: [
-                    createFolderCollection({
-                        name: 'test',
-                        label: 'Test collection',
-                        folder: 'test',
-                        fields: [
-                            createField('markdown', { name: 'body' }),
-                        ],
-                    }),
-                ]
-            }
-        })
-    ],
-})
-```
-
-For more options and guides, see [the documentation](https://vite-plugin-decap-cms.pages.dev)
-
-## Example
-
-See [the documentation CMS](https://vite-plugin-decap-cms.pages.dev/admin/index.html) for an example
-
-## Development
-
-```sh
-# in /docs/
-npm run docs:dev
-```
-
-## License
-
-[MIT](LICENSE)
+# vite-plugin-decap-cms
+
+> A Vite plugin to connect Decap CMS
+
+![NPM Version](https://img.shields.io/npm/v/vite-plugin-decap-cms)
+![NPM Downloads](https://img.shields.io/npm/dm/vite-plugin-decap-cms)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/ghostrider-05/vite-plugin-decap-cms)
+
+> [!WARNING]
+> This plugin has not reached a stable version, 1.0.0, and can include breaking changes following the semver specification. This plugin is open for contributions, both for code, suggestions and (missing) documentation.
+
+## Install
+
+```sh
+pnpm add vite-plugin-decap-cms -D
+npm install vite-plugin-decap-cms -D
+yarn add vite-plugin-decap-cms -D
+```
+
+## Usage
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite'
+import decap, {
+    createFolderCollection,
+    createField,
+} from 'vite-plugin-decap-cms'
+
+export default defineConfig({
+    publicDir: 'public',
+    plugins: [
+        decap({
+            config: {
+                backend: {
+                    name: 'test-repo',
+                },
+                mediaFolder: '/src/public/',
+                collections: [
+                    createFolderCollection({
+                        name: 'test',
+                        label: 'Test collection',
+                        folder: 'test',
+                        fields: [
+                            createField('markdown', { name: 'body' }),
+                        ],
+                    }),
+                ]
+            }
+        })
+    ],
+})
+```
+
+For more options and guides, see [the documentation](https://vite-plugin-decap-cms.pages.dev)
+
+## Example
+
+See [the documentation CMS](https://vite-plugin-decap-cms.pages.dev/admin/index.html) for an example
+
+## Development
+
+```sh
+# in /docs/
+npm run docs:dev
+```
+
+## License
+
+[MIT](LICENSE)

package/dist/index.cjs

@@ -55,24 +55,19 @@ __export(src_exports, {
   createFileCollection: () => createFileCollection,
   createFolderCollection: () => createFolderCollection,
   createOverwriteableField: () => createOverwriteableField,
-  createSharedCollectionOptions: () => createSharedCollectionOptions,
   default: () => VitePluginDecapCMS,
-  fieldToSnakeCase: () => fieldToSnakeCase,
   getGitData: () => getGitData
 });
 module.exports = __toCommonJS(src_exports);
-
-// src/update.ts
-var import_promises = require("fs/promises");
-var import_node_path = require("path");
+var import_child_process2 = require("child_process");
 var import_yaml = require("yaml");
 
-// src/utils/git.ts
-var import_node_child_process = require("child_process");
+// src/util.ts
+var import_child_process = require("child_process");
 function getGitData() {
   const executeGit = (command) => {
     try {
-      return (0, import_node_child_process.execSync)(command).toString("utf8").replace(/[\n\r\s]+$/, "");
+      return (0, import_child_process.execSync)(command).toString("utf8").replace(/[\n\r\s]+$/, "");
     } catch (e) {
     }
   };
@@ -85,8 +80,39 @@ function getGitData() {
     }
   };
 }
+function createField(widget, data) {
+  return __spreadProps(__spreadValues({}, data), {
+    widget
+  });
+}
+function createFolderCollection(data) {
+  return data;
+}
+function createFile(data) {
+  return data;
+}
+function createFileCollection(data) {
+  return data;
+}
+function createOverwriteableField(widget, data, overwrites) {
+  if (overwrites != void 0) {
+    const toAdd = (key) => {
+      if ((overwrites == null ? void 0 : overwrites[key]) != void 0 && data[key] !== overwrites[key]) data[key] = overwrites[key];
+    };
+    for (const key of Object.keys(overwrites)) {
+      if (key !== "hidden" && key !== "deleted") {
+        toAdd(key);
+      }
+    }
+  }
+  if (overwrites == null ? void 0 : overwrites.deleted) return void 0;
+  else if ((overwrites == null ? void 0 : overwrites.hidden) && widget !== "hidden") return createField("hidden", data);
+  else return __spreadProps(__spreadValues({}, data), {
+    widget
+  });
+}
 
-// src/utils/object.ts
+// src/files/config.ts
 var objToSnakeCase = (obj) => {
   const ignoredKeys = ["i18n"];
   const camelToSnakeCase = (str) => str.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
@@ -94,22 +120,6 @@ var objToSnakeCase = (obj) => {
     Object.entries(obj).map(([k, v]) => [ignoredKeys.includes(k) ? k : camelToSnakeCase(k), v])
   );
 };
-var keyof = (obj) => Object.keys(obj);
-function filterUndefined(item) {
-  return item != void 0;
-}
-function omit(obj, keys) {
-  if (!obj) return {};
-  const validEntries = Object.entries(obj).filter(([key]) => !keys.includes(key));
-  return Object.fromEntries(validEntries);
-}
-function pick(obj, keys) {
-  if (!obj) return {};
-  const validEntries = Object.entries(obj).filter(([key]) => keys.includes(key));
-  return Object.fromEntries(validEntries);
-}
-
-// src/files/config.ts
 function getBooleanFromEnv(value, command) {
   return value === "dev" ? command === "serve" : value === "prod" ? command === "build" : value != null ? value : false;
 }
@@ -127,7 +137,7 @@ function resolveBackend(options, command) {
   };
   return resolved;
 }
-function createConfigFile(config, command, log) {
+function createConfigFile(config, command) {
   const _a = config, { backend, collections } = _a, options = __objRest(_a, ["backend", "collections"]);
   return __spreadProps(__spreadValues(__spreadValues({}, resolveBackend(backend, command)), objToSnakeCase(options)), {
     collections: collections.map((col) => {
@@ -146,7 +156,7 @@ function createConfigFile(config, command, log) {
             });
           })
         });
-      } else log("config", "stderr", "Missing either fields or files property in collection");
+      } else throw new Error("Missing either fields or files property in collection");
     })
   });
 }
@@ -296,167 +306,48 @@ span[class*='CustomIconWrapper'] {
 </style>` : ""}`;
 }
 
-// src/proxy.ts
-var import_node_child_process2 = require("child_process");
-function runProxy(options, log) {
-  var _a, _b, _c, _d, _e;
-  const port = ((_a = options == null ? void 0 : options.port) != null ? _a : 8081).toString();
-  log("proxy", "debug", `Starting decap-server on port ${port}`);
-  const proxy = (0, import_node_child_process2.exec)("npx decap-server", __spreadProps(__spreadValues({}, (_b = options == null ? void 0 : options.process) != null ? _b : {}), {
-    env: __spreadValues({
-      PORT: port,
-      MODE: options == null ? void 0 : options.mode,
-      LOG_LEVEL: options == null ? void 0 : options.logLevel,
-      GIT_REPO_DIRECTORY: options == null ? void 0 : options.gitRepoDirectory
-    }, (_d = (_c = options == null ? void 0 : options.process) == null ? void 0 : _c.env) != null ? _d : {})
-  }));
-  if (log("proxy", "stdout")) (_e = proxy.stdout) == null ? void 0 : _e.pipe(process.stdout);
-  proxy.on("error", (err) => {
-    if ("code" in err && err.code === "EADDRINUSE") {
-      log("proxy", "stderr", `Port ${port} for decap-server is already used by another process`);
-    } else throw err;
-  });
-  process.on("beforeExit", () => proxy.kill());
-}
-
-// src/update.ts
+// src/files.ts
+var import_promises = require("fs/promises");
+var import_path = require("path");
 function resolveDir(publicDir, dir) {
-  return dir ? (0, import_node_path.isAbsolute)(dir) ? dir : (0, import_node_path.resolve)(dir) : publicDir;
+  return dir ? (0, import_path.isAbsolute)(dir) ? dir : (0, import_path.resolve)(dir) : publicDir;
 }
 async function writeToFolder(folder, options) {
-  const dir = folder + (options.subfolder ? import_node_path.sep + options.subfolder : "");
+  const dir = folder + (options.subfolder ? import_path.sep + options.subfolder : "");
   await (0, import_promises.mkdir)(dir, { recursive: true });
   for (const file of options.files.filter((f) => !f.skip)) {
-    await (0, import_promises.writeFile)(dir + import_node_path.sep + file.name, file.content, {
+    await (0, import_promises.writeFile)(dir + import_path.sep + file.name, file.content, {
       encoding: "utf-8"
     });
   }
 }
-function validateLoadOptions(options, log) {
-  var _a;
-  const valid = ["npm", "cdn"].includes((_a = options == null ? void 0 : options.method) != null ? _a : "cdn");
-  if (!valid) log("config", "stderr", "Invalid load options for decap-cms provided");
-}
-async function updateConfig(options, config, log) {
-  var _a, _b, _c, _d, _e, _f, _g, _h;
-  validateLoadOptions(options.load, log);
-  const configFile = createConfigFile(options.config, config.command, log);
-  await writeToFolder(
-    resolveDir(config.publicDir, options.dir),
-    {
-      subfolder: "admin",
-      files: [
-        { name: "index.html", content: createIndexFile(options) },
-        { name: "config.yml", content: (0, import_yaml.stringify)(configFile, (_a = options.yml) == null ? void 0 : _a.replacer, (_b = options.yml) == null ? void 0 : _b.options) }
-        // { name: 'npm.js', content: createCustomScript(), skip: options.load?.method !== 'npm' },
-      ]
-    }
-  );
-  if (config.command === "serve" && configFile.local_backend !== false && ((_d = (_c = options.proxy) == null ? void 0 : _c.enabled) != null ? _d : true)) {
-    runProxy(options.proxy, log);
-  }
-  await ((_f = (_e = options.script) == null ? void 0 : _e.onConfigUpdated) == null ? void 0 : _f.call(_e));
-  if (config.command === "build") {
-    await ((_h = (_g = options.script) == null ? void 0 : _g.onGenerated) == null ? void 0 : _h.call(_g));
-  }
-}
 
-// src/utils/log.ts
+// src/log.ts
 function createLogger(options) {
   return function(type, pipe, ...data) {
-    if (options == void 0 || options === false) {
-      if (!data.length) return false;
-      else return;
-    }
-    if (!data.length) return true;
+    if (options == void 0 || options === false) return;
     const fn = pipe === "stderr" ? "error" : pipe === "debug" ? "debug" : "log";
     const pipeDefined = ["debug", "stdout", "stderr"].includes(pipe);
     for (const msg of pipeDefined ? data : [pipe, ...data]) {
-      console[fn](`[Vite Decap] - [${type.toUpperCase()}] ` + msg);
+      console[fn](`[${type.toUpperCase()}] ` + msg);
     }
   };
 }
 
-// src/utils/collection.ts
-function createField(widget, data) {
-  return __spreadProps(__spreadValues({}, data), {
-    widget
-  });
-}
-function createFolderCollection(data) {
-  return data;
-}
-function createFile(data) {
-  return data;
-}
-function createFileCollection(data) {
-  return data;
-}
-function fieldToSnakeCase(field) {
-  return objToSnakeCase(field);
+// src/vitepress.ts
+function filterUndefined(item) {
+  return item != void 0;
 }
-function createSharedCollectionOptions(shared, options) {
-  return function(collection) {
-    const isSharedOptions = (value) => {
-      return value != void 0 && typeof value === "object" && "value" in value && !("field" in value);
-    };
-    const combinedWithShared = keyof(collection).reduce((output, key) => {
-      var _a, _b;
-      const collectionValue = collection[key];
-      const sharedValue = shared[key];
-      if (sharedValue != void 0) {
-        if (isSharedOptions(sharedValue)) {
-          const sharedOptions = sharedValue;
-          const action = (_b = (_a = sharedOptions.action) != null ? _a : options == null ? void 0 : options.action) != null ? _b : "overwrite";
-          if (action === "overwrite") {
-            output[key] = collectionValue;
-            return output;
-          } else if (action === "append") {
-            if (typeof collectionValue === "string") {
-              output[key] = sharedOptions.value + collectionValue;
-            } else if (Array.isArray(collectionValue)) {
-              output[key] = sharedOptions.value.concat(collectionValue);
-            }
-            return output;
-          }
-        }
-      }
-      output[key] = collectionValue;
-      return output;
-    }, {});
-    const sharedRaw = keyof(shared).reduce((output, key) => {
-      const value = shared[key];
-      if (isSharedOptions(value)) {
-        output[key] = value.value;
-      } else {
-        output[key] = value;
-      }
-      return output;
-    }, {});
-    return __spreadValues(__spreadValues({}, sharedRaw), combinedWithShared);
-  };
+function omit(obj, keys) {
+  if (!obj) return {};
+  const validEntries = Object.entries(obj).filter(([key]) => !keys.includes(key));
+  return Object.fromEntries(validEntries);
 }
-
-// src/utils/overwrites.ts
-function createOverwriteableField(widget, data, overwrites) {
-  if (overwrites != void 0) {
-    const toAdd = (key) => {
-      if ((overwrites == null ? void 0 : overwrites[key]) != void 0 && data[key] !== overwrites[key]) data[key] = overwrites[key];
-    };
-    for (const key of Object.keys(overwrites)) {
-      if (key !== "hidden" && key !== "deleted") {
-        toAdd(key);
-      }
-    }
-  }
-  if (overwrites == null ? void 0 : overwrites.deleted) return void 0;
-  else if ((overwrites == null ? void 0 : overwrites.hidden) && widget !== "hidden") return createField("hidden", data);
-  else return __spreadProps(__spreadValues({}, data), {
-    widget
-  });
+function pick(obj, keys) {
+  if (!obj) return {};
+  const validEntries = Object.entries(obj).filter(([key]) => keys.includes(key));
+  return Object.fromEntries(validEntries);
 }
-
-// src/vitepress.ts
 var overwriteKeys = [
   "comment",
   "deleted",
@@ -557,12 +448,11 @@ var VitePress = class {
    * - titleTemplate
    * - description
    * - head
-   * - body (field for writing the markdown in the file)
    * @param options.overwrites Overwrite data, such as labels, for the fields
    * @see https://vitepress.dev/reference/frontmatter-config
    */
   static createDefaultPageFields(options) {
-    var _a, _b, _c;
+    var _a, _b;
     const { additionalFields, overwrites } = options != null ? options : {};
     const fields = [
       createOverwriteableField("string", {
@@ -584,10 +474,10 @@ var VitePress = class {
         label: "Head"
       }, mergeOverwrites(overwrites == null ? void 0 : overwrites.head, overwrites))
     ].filter(filterUndefined);
-    return fields.concat((_a = additionalFields == null ? void 0 : additionalFields.map(fieldToSnakeCase)) != null ? _a : []).concat((_c = createOverwriteableField("markdown", __spreadProps(__spreadValues({}, (_b = options == null ? void 0 : options.markdownOptions) != null ? _b : {}), {
+    return fields.concat(additionalFields != null ? additionalFields : []).concat((_b = createOverwriteableField("markdown", __spreadProps(__spreadValues({}, (_a = options == null ? void 0 : options.markdownOptions) != null ? _a : {}), {
       name: "body",
       label: "Page content"
-    }), mergeOverwrites(overwrites == null ? void 0 : overwrites.body, overwrites))) != null ? _c : []).filter(filterUndefined);
+    }), mergeOverwrites(overwrites == null ? void 0 : overwrites.body, overwrites))) != null ? _b : []).filter(filterUndefined);
   }
   /**
    * Create fields for:
@@ -603,7 +493,7 @@ var VitePress = class {
     const keys = ["hidden", "deleted"];
     function addAdditionalFields(fields) {
       var _a2;
-      return (_a2 = fields == null ? void 0 : fields.map(fieldToSnakeCase)) != null ? _a2 : [];
+      return (_a2 = fields == null ? void 0 : fields.map((f) => objToSnakeCase(f))) != null ? _a2 : [];
     }
     return [
       createField("hidden", {
@@ -707,7 +597,7 @@ var VitePress = class {
           ...addAdditionalFields((_a = options == null ? void 0 : options.additionalFeatureFields) != null ? _a : [])
         ].filter(filterUndefined)
       }, omit(mergeOverwrites(overwrites == null ? void 0 : overwrites.features, overwrites), keys))
-    ].filter(filterUndefined);
+    ];
   }
   static createDefaultPageFolderCollection(name, folder, options) {
     const _a = options != null ? options : {}, { collection } = _a, fieldsOptions = __objRest(_a, ["collection"]);
@@ -743,19 +633,65 @@ var VitePress = class {
 };
 
 // src/index.ts
+function validateLoadOptions(options, log) {
+  var _a;
+  const valid = ["npm", "cdn"].includes((_a = options == null ? void 0 : options.method) != null ? _a : "cdn");
+  if (!valid) log("config", "stderr", "Invalid load options for decap-cms provided");
+}
+function runProxy(options, log) {
+  var _a, _b, _c, _d, _e;
+  const port = ((_a = options == null ? void 0 : options.port) != null ? _a : 8081).toString();
+  log("proxy", "debug", `Starting decap-server on port ${port}`);
+  const proxy = (0, import_child_process2.exec)("npx decap-server", __spreadProps(__spreadValues({}, (_b = options == null ? void 0 : options.process) != null ? _b : {}), {
+    env: __spreadProps(__spreadValues({}, (_d = (_c = options == null ? void 0 : options.process) == null ? void 0 : _c.env) != null ? _d : {}), {
+      PORT: port
+    })
+  }));
+  (_e = proxy.stdout) == null ? void 0 : _e.pipe(process.stdout);
+  proxy.on("error", (err) => {
+    if ("code" in err && err.code === "EADDRINUSE") {
+      log("proxy", "stderr", `Port ${port} for decap-server is already used by another process`);
+    } else throw err;
+  });
+  process.on("beforeExit", () => proxy.kill());
+}
+async function updateConfig(options, config, log) {
+  var _a, _b, _c, _d, _e, _f, _g, _h;
+  validateLoadOptions(options.load, log);
+  const loginFile = createIndexFile(options);
+  const configFile = createConfigFile(options.config, config.command);
+  await writeToFolder(
+    resolveDir(config.publicDir, options.dir),
+    {
+      subfolder: "admin",
+      files: [
+        { name: "index.html", content: loginFile },
+        { name: "config.yml", content: (0, import_yaml.stringify)(configFile, (_a = options.yml) == null ? void 0 : _a.replacer, (_b = options.yml) == null ? void 0 : _b.options) }
+        // { name: 'npm.js', content: createCustomScript(), skip: options.load?.method !== 'npm' },
+      ]
+    }
+  );
+  if (config.command === "serve" && configFile.local_backend !== false && ((_d = (_c = options.proxy) == null ? void 0 : _c.enabled) != null ? _d : true)) {
+    runProxy(options.proxy, log);
+  }
+  await ((_f = (_e = options.script) == null ? void 0 : _e.onConfigUpdated) == null ? void 0 : _f.call(_e));
+  if (config.command === "build") {
+    await ((_h = (_g = options.script) == null ? void 0 : _g.onGenerated) == null ? void 0 : _h.call(_g));
+  }
+}
 function VitePluginDecapCMS(options) {
   let stored = null;
   return {
     name: "vite-plugin-decap-cms",
     async configResolved(config) {
-      const needsUpdate = stored != null ? stored.command !== config.command || stored.publicDir !== config.publicDir : true;
+      const isUpdated = stored != null ? stored.command !== config.command || stored.publicDir !== config.publicDir : true;
       const log = createLogger(options.debug);
-      if (needsUpdate) {
+      if (isUpdated) {
         await updateConfig(options, config, log);
         stored = config;
-        log("config", "debug", "Updated Decap CMS configuration files");
+        log("config", "debug", "Updated Decap CMS configuration");
       } else {
-        log("config", "debug", "Skipped updating Decap CMS configuration files");
+        log("config", "debug", "Skipped updating Decap CMS");
       }
     }
   };
@@ -768,7 +704,5 @@ function VitePluginDecapCMS(options) {
   createFileCollection,
   createFolderCollection,
   createOverwriteableField,
-  createSharedCollectionOptions,
-  fieldToSnakeCase,
   getGitData
 });