`adapter-static` add option to output subpages in subfolders

[atjn]

I am using the default marko-run project with the adapter-static adapter..

When I create a route structure like this:

src/routes
├── foo
│   └── +page.marko
└── +page.marko

... and I run marko-run build, I get this output:

dist/public
├── foo.html
└── index.html

If I then copy these files to my file server and try to connect to my website, I cannot connect to the subpage. Connecting to example.com/foo or example.com/foo/ both return 404 errors. I must explicitly connect to example.com/foo.html to see the page.

I would prefer the output structure to look like this:

dist/public
├── foo
│   └── index.html
└── index.html

That would allow the server to correctly locate foo/index.html when connecting to either of example.com/foo or example.com/foo/. As far as I can tell, there is no option to enable this behavior. Is that something you could add?

[coderabbitai]

A summary of the changes CodeRabbit can apply:

• Implement the subfolderIndex boolean option (default false) for @marko/run-adapter-static to emit pages as subfolders with index.html (clean URLs), by adding the option to packages/adapters/static/src/index.ts (Options interface and passing to createCrawler), updating packages/adapters/static/src/crawler.ts (read option and change htmlFilePath logic), documenting it in packages/adapters/static/README.md, and adding a test fixture at packages/run/src/tests/fixtures/static-adapter-subfolder-index/.

• Add a new boolean option subfolderIndex to the static adapter (docs and code) that, when true, makes the crawler write pages as subfolder/index.html instead of page.html: update docs (.sed-tmp and packages/adapters/static/README.md), add subfolderIndex?: boolean to the adapter Options (packages/adapters/static/src/index.ts), thread subfolderIndex into the crawler and change file-path logic to produce either foo/index.html or foo.html accordingly (packages/adapters/static/src/crawler.ts), and add test fixture files and configs for the static-adapter-subfolder-index test case (new fixture files under packages/run/src/tests/fixtures/static-adapter-subfolder-index).

• ✅ Create PR with these edits
• 📋 Get copyable edits

[rturnq]

It isn't documented but this can be partially configured using the trailingSlashes: "RedirectWith" option on the Marko Run Vite-plugin. To configure this, create a Vite config file in your project and add the Marko Run plugin:

// vite.config.ts
import marko from "@marko/run/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [
    marko({
      trailingSlashes: "RedirectWithout",
    }),
  ],
});

Given your routes, this will produce:

dist/public
├── foo
│   └── index.html
├── foo.html <-- this will contain only a meta redirect to /foo/
└── index.html

It sounds like your server only serves html files named index.html so the foo.html will do nothing for you and trailing slashes will otherwise be handled by your server. Hopefully this works for your case.

I will add some documentation for this to the readme.

[atjn]

Hello @rturnq thank you for your answer.

I did consider that the trailingSlashes option might change the behavior, but I have tried configuring it with all the different options, including redirectWith, and none of them have any effect on the output.

I am using

"@marko/run-adapter-static": "2.0.3"
"marko": "6.0.0"
"@marko/run": "0.9.3"

[atjn]

One interesting thing I just noticed, is that if I rename foo to static-1 (or static-2 and so on..), then the output will use a folder as if it was configured with trailingSlashes: "RedirectWith", but only for that route, and it also is not affected by the actual setting of trailingSlashes.

[atjn]

✨New behavior unlocked✨: After adding a few extra routes, it now generates folders for each route, but the index file in the folder is always a redirect to the same route without a slash. On my server, that means infinite reload loops.

Once again, changing the tralinigSlashes option does not change the output. I am curious to hear if you can reproduce any of this?