@content-collections/vite 0.1.1 → 0.2.0

package/.turbo/turbo-build.log

@@ -1,14 +1,15 @@
-
-> @content-collections/vite@0.1.0 build /Users/sdorra/Projects/sdorra/content-collections/packages/vite
-> tsup src/index.ts --format esm --dts -d dist
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v7.2.0
-CLI Target: es2022
-ESM Build start
-ESM dist/index.js 1.56 KB
-ESM ⚡️ Build success in 24ms
-DTS Build start
-DTS ⚡️ Build success in 649ms
-DTS dist/index.d.ts 195.00 B
+
+
+> @content-collections/vite@0.2.0 build /Users/sdorra/Projects/sdorra/content-collections/packages/vite
+> tsup src/index.ts --format esm --dts -d dist
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.2.0
+CLI Target: es2022
+ESM Build start
+ESM dist/index.js 2.07 KB
+ESM ⚡️ Build success in 10ms
+DTS Build start
+DTS ⚡️ Build success in 479ms
+DTS dist/index.d.ts 274.00 B

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @content-collections/vite
 
+## 0.2.0
+
+### Minor Changes
+
+- [`fc22fa3`](https://github.com/sdorra/content-collections/commit/fc22fa384ae06ddd9f8a6ca52ced369f26f15d23) Thanks [@sdorra](https://github.com/sdorra)! - Add option to disable execution
+
+### Patch Changes
+
+- [`9de2ba8`](https://github.com/sdorra/content-collections/commit/9de2ba8b34a90d4e70a5f9a3dfd8bb2ced370adb) Thanks [@sdorra](https://github.com/sdorra)! - Add aliases to configuration, even if the plugin is disabled
+
+- Updated dependencies []:
+  - @content-collections/integrations@0.1.1
+
+## 0.1.2
+
+### Patch Changes
+
+- [`7e0b2d6`](https://github.com/sdorra/content-collections/commit/7e0b2d621f2ab9c1244558ce1c36fe94e08dfdff) Thanks [@sdorra](https://github.com/sdorra)! - Add generated directory to list of allowed files. This required if vite is running with server.fs.strict.
+
 ## 0.1.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-import { Plugin } from 'vite';
+import { UserConfig, Plugin } from 'vite';
 
 type Options = {
     configPath: string;
+    isEnabled?: (config: UserConfig) => boolean;
 };
-declare function contentCollectionsPlugin(options?: Options): Plugin;
+declare function contentCollectionsPlugin(options?: Partial<Options>): Plugin;
 
-export { contentCollectionsPlugin as default };
+export { Options, contentCollectionsPlugin as default };

package/dist/index.js

@@ -2,40 +2,55 @@
 import { createBuilder } from "@content-collections/core";
 import path from "path";
 import { configureLogging } from "@content-collections/integrations";
-function resolveConfig(root, configPath) {
+var defaultOptions = {
+  configPath: "content-collections.ts"
+};
+function resolveConfigPath(root, configPath) {
   if (!path.isAbsolute(configPath)) {
     configPath = path.resolve(root, configPath);
   }
   return configPath;
 }
-function contentCollectionsPlugin(options = {
-  configPath: "content-collections.ts"
-}) {
+function contentCollectionsPlugin(options = {}) {
+  const pluginOptions = { ...defaultOptions, ...options };
   let builder;
+  let isEnabled = false;
   return {
     name: "content-collections",
     config(config) {
-      let configPath = resolveConfig(
+      isEnabled = options.isEnabled ? options.isEnabled(config) : true;
+      let configPath = resolveConfigPath(
         config.root || process.cwd(),
-        options.configPath
+        pluginOptions.configPath
       );
-      const directory = path.dirname(configPath);
-      return {
+      const directory = path.resolve(
+        path.dirname(configPath),
+        "./.content-collections/generated"
+      );
+      const configPatch = {
         optimizeDeps: {
           exclude: ["content-collections"]
         },
         resolve: {
           alias: {
-            "content-collections": path.resolve(
-              directory,
-              "./.content-collections/generated/index.js"
-            )
+            "content-collections": directory
           }
         }
       };
+      if ((config.server?.fs?.allow || []).length > 0) {
+        configPatch.server = {
+          fs: {
+            allow: [directory]
+          }
+        };
+      }
+      return configPatch;
     },
     async configResolved(config) {
-      let configPath = resolveConfig(config.root, options.configPath);
+      if (!isEnabled) {
+        return;
+      }
+      let configPath = resolveConfigPath(config.root, pluginOptions.configPath);
       console.log(
         "Starting content-collections with config",
         path.relative(process.cwd(), configPath)
@@ -45,11 +60,17 @@ function contentCollectionsPlugin(options = {
       return;
     },
     async buildStart() {
+      if (!isEnabled) {
+        return;
+      }
       console.log("Start initial build");
       await builder.build();
       return;
     },
     async configureServer() {
+      if (!isEnabled) {
+        return;
+      }
       console.log("Start watching");
       builder.watch();
       return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@content-collections/vite",
   "description": "Use content-collections with Vite",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,7 +20,7 @@
     "tsup": "^7.2.0",
     "typescript": "^5.3.2",
     "vite": "^5",
-    "@content-collections/core": "0.2.0"
+    "@content-collections/core": "0.3.0"
   },
   "peerDependencies": {
     "vite": "^5",

package/src/index.ts

@@ -1,13 +1,18 @@
 import { Builder, createBuilder } from "@content-collections/core";
-import { Plugin } from "vite";
+import { Plugin, UserConfig } from "vite";
 import path from "node:path";
 import { configureLogging } from "@content-collections/integrations";
 
-type Options = {
+export type Options = {
   configPath: string;
+  isEnabled?: (config: UserConfig) => boolean;
 };
 
-function resolveConfig(root: string, configPath: string) {
+const defaultOptions = {
+  configPath: "content-collections.ts",
+};
+
+function resolveConfigPath(root: string, configPath: string) {
   if (!path.isAbsolute(configPath)) {
     configPath = path.resolve(root, configPath);
   }
@@ -15,37 +20,61 @@ function resolveConfig(root: string, configPath: string) {
 }
 
 export default function contentCollectionsPlugin(
-  options: Options = {
-    configPath: "content-collections.ts",
-  }
+  options: Partial<Options> = {}
 ): Plugin {
+  const pluginOptions = { ...defaultOptions, ...options };
+
   let builder: Builder;
+  let isEnabled = false;
+
   return {
     name: "content-collections",
 
     config(config) {
-      let configPath = resolveConfig(
+      isEnabled = options.isEnabled ? options.isEnabled(config) : true;
+
+      // even if the plugin is disabled, we need to configure the alias
+      // vite is often executed multiple time and the plugin should only
+      // run once, but the aliases must be available for all runs
+
+      let configPath = resolveConfigPath(
         config.root || process.cwd(),
-        options.configPath
+        pluginOptions.configPath
       );
-      const directory = path.dirname(configPath);
-      return {
+
+      const directory = path.resolve(
+        path.dirname(configPath),
+        "./.content-collections/generated"
+      );
+
+      const configPatch: Partial<UserConfig> = {
         optimizeDeps: {
           exclude: ["content-collections"],
         },
         resolve: {
           alias: {
-            "content-collections": path.resolve(
-              directory,
-              "./.content-collections/generated/index.js"
-            ),
+            "content-collections": directory,
           },
         },
       };
+
+      if ((config.server?.fs?.allow || []).length > 0) {
+        // required for Svelte Kit
+        configPatch.server = {
+          fs: {
+            allow: [directory],
+          },
+        };
+      }
+
+      return configPatch;
     },
 
     async configResolved(config: any) {
-      let configPath = resolveConfig(config.root, options.configPath);
+      if (!isEnabled) {
+        return;
+      }
+      let configPath = resolveConfigPath(config.root, pluginOptions.configPath);
       console.log(
         "Starting content-collections with config",
         path.relative(process.cwd(), configPath)
@@ -58,12 +87,18 @@ export default function contentCollectionsPlugin(
     },
 
     async buildStart() {
+      if (!isEnabled) {
+        return;
+      }
       console.log("Start initial build");
       await builder.build();
       return;
     },
 
     async configureServer() {
+      if (!isEnabled) {
+        return;
+      }
       console.log("Start watching");
       builder.watch();
       return;