Merge branch 'release-initial'

Author: chaance

.changeset/fast-bats-fold.md

@@ -0,0 +1,7 @@
+# `@remix-run/v1-meta`
+
+## 0.1.0
+
+### Minor Changes
+
+- Initial release ([`e15dfbb`](https://github.com/remix-run/v1-compat-utils/commit/e15dfbbe9d5f59e9200a3aa52ece65c024b2109f))

packages/v1-meta/CHANGELOG.md

@@ -1,17 +1,32 @@
 # V1 Meta
 
 ```tsx
-import { metaV1 } from "@remix-run/v1-meta";
+import { metaV1, getMatchesData } from "@remix-run/v1-meta";
 
-export function meta(args) {
+export const meta = (args) => {
+  // In the v1 API, `meta` received a `parentsData` argument, which is an
+  // object keyed by each parent route ID containing the data returned by
+  // that route's `loader` function. This argument is removed from the
+  // v2 API. `getMatchesData` will construct an object with the same
+  // signature, allowing you to easily refactor your code.
+  let matchesData = getMatchesData(args);
+  let rootData = matchesData["root"];
+
+  // This function will construct an array of `V2_MetaDescriptor` objects.
+  // It will use the same heuristics as Remix v1 to merge the parent
+  // route's meta values with the data you provide.
   return metaV1(args, {
     title: "My App",
     description: "My App Description",
   });
-  //   return [
-  //     { charSet: "utf-8" }, // inherited!
-  //     { title: "My App" },
-  //     { name: "description", content: "My App Description" },
-  //   ];
-}
+
+  // output:
+  return [
+    // This is inherited from the parent route!
+    { charSet: "utf-8" },
+    // If your parent has a title it will be overridden!
+    { title: "My App" },
+    { name: "description", content: "My App Description" },
+  ];
+};
 ```

packages/v1-meta/README.md

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/v1-meta",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "homepage": "https://remix.run",
   "bugs": {
     "url": "https://github.com/remix-run/v1-compat-utils/issues"
@@ -33,5 +33,12 @@
   "peerDependencies": {
     "@remix-run/react": "^1.15.0",
     "@remix-run/server-runtime": "^1.15.0"
-  }
+  },
+  "files": [
+    "dist",
+    "src",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ]
 }

packages/v1-meta/package.json

@@ -2,7 +2,7 @@ import type {
   V2_MetaArgs as MetaArgs,
   V2_MetaDescriptor as MetaDescriptor,
 } from "@remix-run/react";
-import type { LoaderFunction } from "@remix-run/server-runtime";
+import type { LoaderFunction, SerializeFrom } from "@remix-run/server-runtime";
 
 function metaV1<
   Loader extends LoaderFunction | unknown = unknown,
@@ -90,6 +90,38 @@ function fromMetaData(metaData: V1_MetaDescriptor): MetaDescriptor[] {
   return meta;
 }
 
+function getMatchesData<
+  Loader extends unknown = unknown,
+  MatchLoaders extends Record<string, unknown> = Record<string, unknown>
+>(args: MetaArgs<Loader, MatchLoaders>) {
+  let { matches } = args;
+  return matches.reduce(
+    (data, match) => {
+      return {
+        ...data,
+        [match.id]: match.data,
+      };
+    },
+    {} as {
+      [K in keyof MatchLoaders]: MatchLoaders[K] extends LoaderFunction
+        ? SerializeFrom<MatchLoaders[K]>
+        : unknown;
+    }
+  );
+}
+
+export interface V2_MetaMatch<
+  RouteId extends string = string,
+  Loader extends LoaderFunction | unknown = unknown
+> {
+  id: RouteId;
+  pathname: string;
+  data: Loader extends LoaderFunction ? SerializeFrom<Loader> : unknown;
+  handle?: unknown;
+  params: {};
+  meta: MetaDescriptor[];
+}
+
 function getMetaKey(metaDescriptor: MetaDescriptor) {
   if ("title" in metaDescriptor && metaDescriptor.title != null) {
     return "title";
@@ -155,5 +187,5 @@ interface V1_MetaDescriptor {
     | Array<Record<string, string> | string>;
 }
 
-export { fromMetaData, metaV1, mergeMeta };
+export { fromMetaData, getMatchesData, metaV1, mergeMeta };
 export type { V1_MetaDescriptor };

packages/v1-meta/src/index.ts

@@ -0,0 +1,7 @@
+# `@remix-run/v1-route-convention`
+
+## 0.1.0
+
+### Minor Changes
+
+- Initial release ([`e15dfbb`](https://github.com/remix-run/v1-compat-utils/commit/e15dfbbe9d5f59e9200a3aa52ece65c024b2109f))

packages/v1-route-convention/CHANGELOG.md

@@ -4,22 +4,19 @@
 // remix.config.js
 const { createRoutesFromFolders } = require("@remix-run/v1-route-convention");
 
-// tell Remix to ignore everything in the routes directory 
-// we'll let `createRoutesFromFolders` take care of that
-exports.ignoredRouteFiles = ["**/*"];
-exports.routes = (defineRoutes) => createRoutesFromFolders(defineRoutes);
-```
-
-> **Note**
-> If you're already using `ignoredRouteFiles` you can move that to the plugin to keep using it
-
-```diff
-// remix.config.js
-const { createRoutesFromFolders } = require("@remix-run/v1-route-convention");
-
-- exports.ignoredRouteFiles = ["**/.*"];
-+ exports.ignoredRouteFiles = ["**/*"];
-+ exports.routes = (defineRoutes) => createRoutesFromFolders(defineRoutes, { 
-+   ignoredFilePatterns: ["**/.*"] 
-+ });
+/** @type {import('@remix-run/dev').AppConfig} */
+module.exports = {
+  // Tell Remix to ignore everything in the routes directory.
+  // We'll let `createRoutesFromFolders` take care of that.
+  ignoredRouteFiles: ["**/*"],
+  routes: (defineRoutes) => {
+    // `createRoutesFromFolders` will create routes for all files in the
+    // routes directory using the same default conventions as Remix v1.
+    return createRoutesFromFolders(defineRoutes, {
+      // If you're already using `ignoredRouteFiles` in your Remix config,
+      // you can move them to `ignoredFilePatterns` in the plugin's options.
+      ignoredFilePatterns: ["**/.*", "**/*.css"],
+    });
+  },
+};
 ```

packages/v1-route-convention/README.md

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/v1-route-convention",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "homepage": "https://remix.run",
   "bugs": {
     "url": "https://github.com/remix-run/v1-compat-utils/issues"
@@ -31,5 +31,12 @@
   },
   "peerDependencies": {
     "@remix-run/dev": "^1.15.0"
-  }
+  },
+  "files": [
+    "dist",
+    "src",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ]
 }

packages/v1-route-convention/package.json

@@ -15,10 +15,10 @@ const STABLE_HEADING_REGEXP = /^\d+\.\d+\.\d+$/i;
 main();
 
 async function main() {
-  //   if (isPrereleaseMode()) {
-  //     console.log("🚫 Skipping changelog removal in prerelease mode");
-  //     return;
-  //   }
+  if (isPrereleaseMode()) {
+    console.log("🚫 Skipping changelog removal in prerelease mode");
+    return;
+  }
   await removePreReleaseChangelogs();
   console.log("✅ Removed pre-release changelogs");
 }