@content-collections/core 0.4.0 → 0.5.0

package/README.md

@@ -22,35 +22,16 @@ Transform your content into type-safe data collections. Eliminate the need for m
 
 ## Installation
 
-1. Install required packages:
+Content Collections offers a variety of adapters that seamlessly integrate with popular web frameworks. The installation process depends on the chosen adapter:
 
-   ```bash
-   pnpm add -D @content-collections/core @content-collections/cli concurrently
-   ```
-
-1. Add path alias to your `tsconfig.json`:
-
-   ```json
-   {
-     "compilerOptions": {
-       // ...
-       "paths": {
-         "content-collections": ["./.content-collections/generated"]
-       }
-     }
-   }
-   ```
+- [Next.js](https://www.content-collections.dev/docs/quickstart/next)
+- [Qwik](https://www.content-collections.dev/docs/quickstart/qwik)
+- [Remix (Vite)](https://www.content-collections.dev/docs/quickstart/remix-vite)
+- [Solid Start](https://www.content-collections.dev/docs/quickstart/solid)
+- [Svelte Kit](https://www.content-collections.dev/docs/quickstart/svelte-kit)
+- [Vite](https://www.content-collections.dev/docs/quickstart/vite)
 
-1. Update your scripts in `package.json`:
-
-   ```json
-   {
-     "scripts": {
-       "dev": "concurrently 'content-collections watch' 'build-scripts dev'",
-       "build": "content-collections build && build-scripts build"
-     }
-   }
-   ```
+If your framework is not listed, you can still use Content Collections by using the [CLI](https://www.content-collections.dev/docs/quickstart/cli). Please open a ticket if you want to see your framework listed.
 
 ## Usage
 
@@ -108,7 +89,14 @@ Transform your content into type-safe data collections. Eliminate the need for m
    }
    ```
 
-For a more detailed guide, please refer to the [documentation](https://content-collections.dev/docs/guides/getting-started).
+   Please note that the example above shows only the very basics of Content Collections and it does not cover content transformation.
+   Content Collections does not transform content like markdown or mdx by default.
+   But it has packages which can do that for you:
+
+   - [@content-collections/markdown](https://www.content-collections.dev/docs/samples/markdown)
+   - [@content-collections/mdx](https://www.content-collections.dev/docs/samples/mdx)
+
+   If you want to see more examples and use cases, please refer to the [documentation](https://content-collections.dev/docs).
 
 ## Sponsors
 
@@ -119,6 +107,10 @@ For a more detailed guide, please refer to the [documentation](https://content-c
     <img alt="supastarter" src="./assets/sponsors/supastarter/light.svg" height="64">
   </picture>
 </a>
+&nbsp;&nbsp;
+<a href="https://cloudogu.com">
+  <img src="./assets/sponsors/cloudogu.png" alt="Cloudogu GmbH" height="64">
+</a>
 
 ### [Become a sponsor](https://github.com/sponsors/sdorra)
 

package/dist/index.d.ts

@@ -52,6 +52,10 @@ type Schema<TParser extends Parser | undefined, TShape extends ZodRawShape> = z$
 type Context = {
     documents<TCollection extends AnyCollection>(collection: TCollection): Array<Schema<TCollection["parser"], TCollection["schema"]>>;
     cache: CacheFn;
+    collection: {
+        name: string;
+        directory: string;
+    };
 };
 type Z = typeof z$1;
 type CollectionRequest<TName extends string, TShape extends ZodRawShape, TParser, TSchema, TTransformResult, TDocument> = {
@@ -62,6 +66,7 @@ type CollectionRequest<TName extends string, TShape extends ZodRawShape, TParser
     transform?: (data: TSchema, context: Context) => TTransformResult;
     directory: string;
     include: string | string[];
+    exclude?: string | string[];
     onSuccess?: (documents: Array<TDocument>) => void | Promise<void>;
 };
 type Collection<TName extends string, TShape extends ZodRawShape, TParser extends Parser, TSchema, TTransformResult, TDocument> = Omit<CollectionRequest<TName, TShape, TParser, TSchema, TTransformResult, TDocument>, "schema"> & {
@@ -86,6 +91,9 @@ type AnyConfiguration = Configuration<Array<AnyCollection>>;
 declare function defineConfig<TConfig extends AnyConfiguration>(config: TConfig): TConfig;
 
 type Modification = "create" | "update" | "delete";
+type Document = {
+    _meta: Meta;
+};
 type CollectionFile = {
     data: {
         content?: string;
@@ -192,4 +200,4 @@ declare function createBuilder(configurationPath: string, options?: Options): Pr
 }>;
 type Builder = Awaited<ReturnType<typeof createBuilder>>;
 
-export { AnyCollection, AnyConfiguration, Builder, BuilderEvents, CollectError, Collection, CollectionRequest, Configuration, ConfigurationError, Context, GetTypeByName, Meta, Modification, Schema, TransformError, createBuilder, defineCollection, defineConfig };
+export { AnyCollection, AnyConfiguration, Builder, BuilderEvents, CollectError, Collection, CollectionRequest, Configuration, ConfigurationError, Context, Document, GetTypeByName, Meta, Modification, Schema, TransformError, createBuilder, defineCollection, defineConfig };

package/dist/index.js

@@ -45,7 +45,7 @@ import path from "path";
 // package.json
 var package_default = {
   name: "@content-collections/core",
-  version: "0.4.0",
+  version: "0.5.0",
   type: "module",
   main: "dist/index.js",
   types: "./dist/index.d.ts",
@@ -68,25 +68,25 @@ var package_default = {
     postpack: "rm -f ./README.md"
   },
   devDependencies: {
-    "@types/micromatch": "^4.0.6",
+    "@types/micromatch": "^4.0.7",
     "@types/node": "^20.9.0",
     "@types/pluralize": "^0.0.33",
-    "@vitest/coverage-v8": "^1.1.0",
+    "@vitest/coverage-v8": "^1.5.0",
     tsup: "^7.2.0",
     tsx: "^4.1.1",
-    typescript: "^5.3.3",
-    vitest: "^1.1.0"
+    typescript: "^5.4.5",
+    vitest: "^1.5.0"
   },
   dependencies: {
-    "@parcel/watcher": "^2.3.0",
+    "@parcel/watcher": "^2.4.1",
     camelcase: "^8.0.0",
-    esbuild: "^0.19.5",
+    esbuild: "^0.20.2",
     "fast-glob": "^3.3.2",
     "gray-matter": "^4.0.3",
     micromatch: "^4.0.5",
     pluralize: "^8.0.0",
-    yaml: "^2.3.4",
-    zod: "^3.22.4"
+    yaml: "^2.4.1",
+    zod: "^3.22.5"
   }
 };
 
@@ -245,12 +245,23 @@ function createCollector(emitter, baseDirectory = ".") {
       return null;
     }
   }
+  function createIgnorePattern(collection) {
+    if (collection.exclude) {
+      if (Array.isArray(collection.exclude)) {
+        return collection.exclude;
+      } else {
+        return [collection.exclude];
+      }
+    }
+    return void 0;
+  }
   async function resolveCollection(collection) {
     const collectionDirectory = path2.join(baseDirectory, collection.directory);
     const filePaths = await fg(collection.include, {
       cwd: collectionDirectory,
       onlyFiles: true,
-      absolute: false
+      absolute: false,
+      ignore: createIgnorePattern(collection)
     });
     const promises = filePaths.map(
       (filePath) => collectFile(collection, filePath)
@@ -315,11 +326,18 @@ async function createJavaScriptFile(directory, configuration) {
   content += "export { " + collections.join(", ") + " };\n";
   await fs2.writeFile(path3.join(directory, "index.js"), content, "utf-8");
 }
+function createImportPath(directory, target) {
+  let importPath = path3.posix.join(...path3.relative(directory, target).split(path3.sep));
+  if (!importPath.startsWith(".")) {
+    importPath = "./" + importPath;
+  }
+  return importPath;
+}
 async function createTypeDefinitionFile(directory, configuration) {
   if (!configuration.generateTypes) {
     return;
   }
-  const importPath = path3.relative(directory, configuration.path);
+  const importPath = createImportPath(directory, configuration.path);
   let content = `import configuration from "${importPath}";
 import { GetTypeByName } from "@content-collections/core";
 `;
@@ -431,18 +449,22 @@ function createTransformer(emitter, cacheManager) {
       documents: (await Promise.all(promises)).filter(isDefined)
     };
   }
-  function createContext(collections, cache) {
+  function createContext(collections, collection, cache) {
     return {
-      documents: (collection) => {
-        const resolved = collections.find((c) => c.name === collection.name);
+      documents: (collection2) => {
+        const resolved = collections.find((c) => c.name === collection2.name);
         if (!resolved) {
           throw new TransformError(
             "Configuration",
-            `Collection ${collection.name} not found, do you have registered it in your configuration?`
+            `Collection ${collection2.name} not found, do you have registered it in your configuration?`
           );
         }
         return resolved.documents.map((doc) => doc.document);
       },
+      collection: {
+        name: collection.name,
+        directory: collection.directory
+      },
       cache: cache.cacheFn
     };
   }
@@ -454,7 +476,7 @@ function createTransformer(emitter, cacheManager) {
           collection.name,
           doc.document._meta.path
         );
-        const context = createContext(collections, cache);
+        const context = createContext(collections, collection, cache);
         try {
           const document = await collection.transform(doc.document, context);
           docs.push({
@@ -540,7 +562,9 @@ function createSynchronizer(readCollectionFile, collections, baseDirectory = "."
         relativePath
       };
     }).filter(({ collection, relativePath }) => {
-      return micromatch.isMatch(relativePath, collection.include);
+      return micromatch.isMatch(relativePath, collection.include, {
+        ignore: collection.exclude
+      });
     });
   }
   function deleted(filePath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@content-collections/core",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",
@@ -16,25 +16,25 @@
     "README.md"
   ],
   "devDependencies": {
-    "@types/micromatch": "^4.0.6",
+    "@types/micromatch": "^4.0.7",
     "@types/node": "^20.9.0",
     "@types/pluralize": "^0.0.33",
-    "@vitest/coverage-v8": "^1.1.0",
+    "@vitest/coverage-v8": "^1.5.0",
     "tsup": "^7.2.0",
     "tsx": "^4.1.1",
-    "typescript": "^5.3.3",
-    "vitest": "^1.1.0"
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.0"
   },
   "dependencies": {
-    "@parcel/watcher": "^2.3.0",
+    "@parcel/watcher": "^2.4.1",
     "camelcase": "^8.0.0",
-    "esbuild": "^0.19.5",
+    "esbuild": "^0.20.2",
     "fast-glob": "^3.3.2",
     "gray-matter": "^4.0.3",
     "micromatch": "^4.0.5",
     "pluralize": "^8.0.0",
-    "yaml": "^2.3.4",
-    "zod": "^3.22.4"
+    "yaml": "^2.4.1",
+    "zod": "^3.22.5"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts -d dist",