@remix-run/fs-routes 0.0.0-experimental-eab1c4d1e

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Remix Software Inc. 2020-2021
+Copyright (c) Shopify Inc. 2022-2024
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# Welcome to Remix!
+
+[Remix](https://remix.run) is a web framework that helps you build better websites with React.
+
+To get started, open a new shell and run:
+
+```sh
+npx create-remix@latest
+```
+
+Then follow the prompts you see in your terminal.
+
+For more information about Remix, [visit remix.run](https://remix.run)!

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { type RouteConfigEntry } from "@remix-run/route-config";
+/**
+ * Creates route config from the file system that matches [Remix's default file
+ * conventions](https://remix.run/docs/en/v2/file-conventions/routes), for
+ * use within `routes.ts`.
+ */
+export declare function flatRoutes(options?: {
+    /**
+     * An array of [minimatch](https://www.npmjs.com/package/minimatch) globs that match files to ignore.
+     * Defaults to `[]`.
+     */
+    ignoredRouteFiles?: string[];
+    /**
+     * The directory containing file system routes, relative to the app directory.
+     * Defaults to `"./routes"`.
+     */
+    rootDirectory?: string;
+}): Promise<RouteConfigEntry[]>;

package/dist/index.js

@@ -0,0 +1,46 @@
+/**
+ * @remix-run/fs-routes v0.0.0-experimental-eab1c4d1e
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fs = require('node:fs');
+var path = require('node:path');
+var dev = require('@remix-run/dev');
+var routeConfig = require('@remix-run/route-config');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+
+/**
+ * Creates route config from the file system that matches [Remix's default file
+ * conventions](https://remix.run/docs/en/v2/file-conventions/routes), for
+ * use within `routes.ts`.
+ */
+async function flatRoutes(options = {}) {
+  let {
+    ignoredRouteFiles = [],
+    rootDirectory: userRootDirectory = "routes"
+  } = options;
+  let appDirectory = routeConfig.getAppDirectory();
+  let rootDirectory = path__default["default"].resolve(appDirectory, userRootDirectory);
+  let relativeRootDirectory = path__default["default"].relative(appDirectory, rootDirectory);
+  let prefix = normalizeSlashes(relativeRootDirectory);
+  let routes = fs__default["default"].existsSync(rootDirectory) ? dev.UNSAFE_flatRoutes(appDirectory, ignoredRouteFiles, prefix) : {};
+  return dev.UNSAFE_routeManifestToRouteConfig(routes);
+}
+function normalizeSlashes(file) {
+  return file.split(path__default["default"].win32.sep).join("/");
+}
+
+exports.flatRoutes = flatRoutes;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@remix-run/fs-routes",
+  "version": "0.0.0-experimental-eab1c4d1e",
+  "description": "Config-based file system routing conventions, for use within routes.ts",
+  "bugs": {
+    "url": "https://github.com/remix-run/remix/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/remix-run/remix",
+    "directory": "packages/remix-fs-routes"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "devDependencies": {
+    "@remix-run/dev": "0.0.0-experimental-eab1c4d1e",
+    "@remix-run/route-config": "0.0.0-experimental-eab1c4d1e",
+    "typescript": "^5.1.6"
+  },
+  "peerDependencies": {
+    "@remix-run/dev": "^0.0.0-experimental-eab1c4d1e",
+    "@remix-run/route-config": "^0.0.0-experimental-eab1c4d1e",
+    "typescript": "^5.1.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist/",
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "scripts": {
+    "tsc": "tsc"
+  }
+}