@uniflowed/config 0.0.0-alpha.35 → 0.0.0-alpha.39

package/internal/schema.js

@@ -161,8 +161,10 @@ export type PackageManagerSpec = string;
  * because it is the binary that is running. `"bun"` is `bun test`, on the Bun
  * it names — so it also decides the test runtime when `test.runtime` is
  * absent, and a `test.runtime` naming anything else is an error. The version
- * follows the same grammar as a runtime's. `uf test` refuses a Bun runner until
- * ubugeeei-prod/uf#942 lands, rather than running its own suite in its place.
+ * follows the same grammar as a runtime's. Under a Bun runner `uf test` hands
+ * the files its discovery found to `bun test`, with uf's Flow preload, and
+ * `@uniflowed/test` resolves to `bun:test`; what Bun has no equivalent for
+ * raises `UnsupportedError` by name. See guide/testing, "Choosing a runner".
  *
  * The type of `test.runner`.
  */
@@ -196,6 +198,64 @@ export type PluginEntry =
       readonly apply?: "build" | "serve" | "always",
     };
 
+// # `app.router`'s three lists
+//
+// Next.js's `redirects`, `rewrites` and `headers`, written as data rather than
+// as async functions, because this file is read without being run. A `source`
+// is a path in the route table's own grammar — a literal segment, `:name` for
+// one segment, and a trailing `:name*` for the rest — and each rule is an exact
+// object, so a misspelled field is an error here and where `uf` reads the file.
+
+/**
+ * One redirect: a request for `source` is answered with a redirect to
+ * `destination`, before anything else answers — a file included.
+ *
+ * `destination` is a path of this application or an absolute `http(s)` URL,
+ * and may use the `:name` and `:name*` segments `source` declared. The
+ * request's query is passed through. `permanent: true` is a `308`, `false` a
+ * `307`; both keep the method.
+ */
+export type RouteRedirect = {
+  readonly source: string,
+  readonly destination: string,
+  readonly permanent: boolean,
+};
+
+/**
+ * One rewrite: a request for `source` is answered by the route at
+ * `destination`, and the address bar keeps `source`.
+ *
+ * `destination` is a path of this application — never another origin, which
+ * is a route handler that fetches — and may use `source`'s segments. Applied
+ * after the build's own files and before middleware, so the middleware that
+ * runs is the destination's.
+ */
+export type RouteRewrite = {
+  readonly source: string,
+  readonly destination: string,
+};
+
+/**
+ * Response headers for every request whose path matches `source`, files
+ * included. Every matching rule applies, in order, and a later one setting the
+ * same name wins — over the response's own header of that name, too.
+ */
+export type RouteHeaders = {
+  readonly source: string,
+  readonly headers: { readonly [name: string]: string },
+};
+
+/**
+ * Which spelling of a path is the page.
+ *
+ * `"never"` answers `/about/` with a `308` to `/about` and writes the page as
+ * `about.html`; `"always"` answers `/about` with a `308` to `/about/` and
+ * writes `about/index.html`; `"ignore"`, the default, answers both and writes
+ * `about/index.html`. `next.config.js`'s `trailingSlash: false`, `true` and
+ * `skipTrailingSlashRedirect: true`.
+ */
+export type RouterTrailingSlash = "never" | "always" | "ignore";
+
 /**
  * A ceiling `uf build` fails over, and what it is measured on.
  *
@@ -453,6 +513,37 @@ export type UniflowedConfig = {
       // **library** rather than an application, and `uf build` reads it: see
       // `build.lib` below and docs/app/reference/config.
       readonly enabled?: boolean,
+      /**
+       * Redirects answered before anything else, in order; the first whose
+       * `source` matches wins. `next.config.js`'s `redirects()`. See
+       * `RouteRedirect` and docs/app/guide/routing.
+       */
+      readonly redirects?: $ReadOnlyArray<RouteRedirect>,
+      /**
+       * Routes served at another path, in order; the first whose `source`
+       * matches wins. `next.config.js`'s `rewrites()`, without proxying. See
+       * `RouteRewrite` and docs/app/guide/routing.
+       */
+      readonly rewrites?: $ReadOnlyArray<RouteRewrite>,
+      /**
+       * Response headers by path; every matching rule applies.
+       * `next.config.js`'s `headers()`. See `RouteHeaders` and
+       * docs/app/guide/routing.
+       */
+      readonly headers?: $ReadOnlyArray<RouteHeaders>,
+      /**
+       * The path the whole application is served under — `"/docs"` — with no
+       * trailing slash. Every link, redirect, asset URL, payload URL and
+       * sitemap entry carries it, and a request outside it is a `404`. The
+       * sources of the three lists above are written without it.
+       * `next.config.js`'s `basePath`.
+       */
+      readonly basePath?: string,
+      /**
+       * Which spelling of a path is the page; see `RouterTrailingSlash`.
+       * `"ignore"` when absent.
+       */
+      readonly trailingSlash?: RouterTrailingSlash,
     },
     readonly rendering?: {
       // `"csr"` is the one value that cannot share the list: it renders every
@@ -467,6 +558,12 @@ export type UniflowedConfig = {
       // request — the client router is not installed and `Link` renders an
       // ordinary anchor. See docs/app/guide/routing/navigation.
       readonly navigation?: "client" | "document",
+      // How long, in whole seconds, the client router shows a route it already
+      // fetched or prefetched without asking the server again: a click on a
+      // prefetched link, a second visit and the back button all read it. `0`,
+      // the default, keeps nothing. `router.refresh()` and every server action
+      // clear it. See docs/app/guide/routing and docs/app/guide/cache.
+      readonly staleTime?: number,
       readonly cache?: {
         readonly actions?: boolean,
         readonly data?: boolean,
@@ -916,6 +1013,29 @@ export type UniflowedConfig = {
     },
   },
   readonly tasks?: { readonly [string]: TaskDefinition },
+  /**
+   * Tasks `uf prepare` runs before a commit, keyed by a glob over the staged
+   * files.
+   *
+   * A glob with no `/` matches a file's name wherever it is; one with a `/`
+   * matches its path from the project root. Each task named runs once, with
+   * every staged file its glob matches appended to its command, over what is
+   * staged rather than what is on disk. A fix to a fully staged file is staged
+   * with it; a fix to a half-staged one is not kept, and stops the commit.
+   */
+  readonly staged?: { readonly [string]: string | $ReadOnlyArray<string> },
+  /**
+   * Where `uf ui add` writes the components a project owns, and where
+   * `uf ui list` and `uf ui diff` look for them.
+   *
+   * `directory` is relative to the project root, and `app/components/ui` when
+   * absent. Every component goes in the one directory, because each imports
+   * the ones it builds on as siblings (`./button.js`). A path that leaves the
+   * project is refused before anything is written.
+   */
+  readonly ui?: {
+    readonly directory?: string,
+  },
   /**
    * Vite's own configuration, merged over the one uf generates.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniflowed/config",
-  "version": "0.0.0-alpha.35",
+  "version": "0.0.0-alpha.39",
   "description": "Flow declarations for @uniflowed/config, part of the Unified Toolchain for Flow.",
   "type": "module",
   "license": "MIT",