Possible adjustments for renovate-config

[OrbisK]

I think we need to make some minor changes to improve a possible renovate-presets (proof of concept https://github.com/OrbisK/renovate-config-e18e).

https://e18e.dev/docs/replacements/<pgk>

We should consider using the same doc path as the module name. Or, at the very least, we should implement redirects to cover the original name. This is because the renovate presets have templating that can use the depName. Having to map it to a doc path means writing a package rule for each doc path.

      prBodyNotes: [
        `{{#unless (includes prBodyColumns "Community Notes")}}> [!WARNING]
> **This package has a recommended replacement.** Check the [e18e replacement guide for \`{{{depName}}}\`](https://e18e.dev/docs/replacements/{{{depName}}}) to find modern, lighter alternatives.{{/unless}}`,
      ],

Each replacement should have one preferred/optionated default replacement.

In order for Renovate to open a replacement PR, one package is needed to replace it. (We need to make some changes to package.json to open a replacement PR.)

Publish the docs md

We should publish the MD docs to embed them in Renovate if necessary.

To make this work, we must remove all VitePress-only markdown flavour (e.g. `//--code? ) and use normal markdown diffs.

[43081j]

Each replacement should have one preferred/optionated default replacement

currently the order of replacements and the engine constraints determine this.

its basically:

for each replacement:
  if replacement has matching engines:
    return replacement

i.e. the first matching one is the "preferred" one.

does that work?

We should consider using the same doc path as the module name

maybe we can automatically set redirects up 🤔 when we sync the replacements. quite a few replacements will have the same doc, so we can't name the file after each one.

[OrbisK]

maybe we can automatically set redirects up 🤔 when we sync the replacements. quite a few replacements will have the same doc, so we can't name the file after each one.

Ah, okay, so we might need to map it in the config because we also have to match the MD file to display the migration guide. I think i can solve this in renovate config. Ill group the package rules by the docpath. (Ill try and add it like this)

currently the order of replacements and the engine constraints determine this.

its basically:

for each replacement:
if replacement has matching engines:
return replacement
i.e. the first matching one is the "preferred" one.

does that work?

I think we cant check the (node ?) engine in renvoate (maybe this should be a renovate feature to add/collab). What we can do is:

axios < 1        -> ky
axios >= 1      -> ofetch

We only need the prefferd package to open a PR. The migration guide can recommend depending on environment.

What we cant do is open a pr and remove a dependency when its nativly available (I guess, let me check)

[OrbisK]

Ah, okay, so we might need to map it in the config because we also have to match the MD file to display the migration guide. I think i can solve this in renovate config. Ill group the package rules by the docpath. (Ill try and add it like this)

https://github.com/OrbisK/renovate-config-e18e/blob/main/recommendations.json

Done

[OrbisK]

I think we cant check the (node ?) engine in renvoate

there is matchJsonata, but this cant compare semver i guess. we can only tell if someone has exact strings as node engine + it can only check package.json engines not the node version of pipelines, dockerfiles etc

[OrbisK]

currently the order of replacements and the engine constraints determine this.

this is not part of import { preferredReplacements } from "module-replacements"; right?

[43081j]

You need the pre release (@next). Each mappings entry has an array of replacements. Each is a key of one of the objects in the root replacements object.

[OrbisK]

You need the pre release (@next). Each mappings entry has an array of replacements. Each is a key of one of the objects in the root replacements object.

Done OrbisK/renovate-config-e18e@b581163#diff-fefbbfc7ff66fae66581bec368540ca31b7f5dfca81e2ae4c68248fb6ab3afa1

Now I "only " need the docs and it should be mostly done 😅