base or cwd option for import.meta.glob

[Rich-Harris]

Description

Today, import.meta.glob returns an object whose keys are relative paths (unless using an alias, in which case the behaviour is slightly unexpected — #12180):

const stuff = import.meta.glob('./path/to/my/stuff/**/*.md', {
  eager: true,
  query: '?url'
});

/*
{
  './path/to/my/stuff/a/b/c.md': {...},
  './path/to/my/stuff/d/e/f.md': {...}
}
*/

Working with this object is slightly cumbersome. If you want a specific module, you have to do this...

const abc = stuff[`./path/to/my/stuff/a/b/c.md`];

...and if you're iterating over the keys you have to do some ugly string manipulation:

for (const key in stuff) {
  const slug = key.slice('./path/to/my/stuff/'.length, -'.md'.length);
  // ...
}

If you're trying to make that logic reusable, you have to pass around a prefix — this is brittle, because you could easily change the argument to glob (because you moved some files) but forget to update base:

const index = createIndex(stuff, {
  base: './path/to/my/stuff'
});

Suggested solution

A straightforward solution that would result in cleaner code and that could (I think?) be implemented without a breaking change could be to add a base option to the glob arguments:

const stuff = import.meta.glob('**/*.md', {
  base: './path/to/my/stuff',
  eager: true,
  query: '?url'
});

/*
{
  'a/b/c.md': {...},
  'd/e/f.md': {...}
}
*/

const abc = stuff[`a/b/c.md`];

for (const key in stuff) {
  const slug = key.slice(0, -'.md'.length);
  // ...
}

const index = createIndex(stuff);

Every globbing library (including fast-glob which Vite uses IIUC) has some version of this — the option is usually called cwd, and as such there's an argument for calling it cwd rather than base. The counterargument is that cwd is always resolved relative to the actual cwd, rather than the file in which it's used, and so maybe there's a slight conceptual mismatch. I think either would be fine.

Alternative

Taking the idea further, it could be prefix and suffix (i.e. allowing you to automatically remove suffixes like .md), though I suspect that's unnecessary complexity.

Additional context

No response

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.