Example threads. These questions and answers were written by the SDODS team to document real problems and how to fix them. The people named are illustrative, not real users. Questions asked on this site are marked new.
The generated routes: map is full of keys like
routes:
id-publish-route-test: /api/intranet/pages/{id}/publish
pageid-edit-components-section-palette: /pages/{pageId}/edit/components/{sectionId}/palette
workspaceid-usage: /workspace/{workspaceId}/usageand the navigate step takes the key:
When I navigate to the "pageid-edit-components-section-palette" pageNobody on my team is going to type that correctly twice. Can the key be something else?
Accepted answer
Yes — rename them. The key is just a label; the path is the part that has to be right.
The generator builds the key by stripping braces and punctuation out of the whole path and joining the remains with hyphens, which is why you get workspaceid-usage rather than workspace-usage, and why the by- marker that is supposed to mark a parameter segment only appears when the parameter is not the first segment. There is an open issue for it; nothing has changed yet.
So after --apply, rewrite the left-hand side and leave the right-hand side alone:
routes:
section-palette: /pages/{pageId}/edit/components/{sectionId}/palette
workspace-usage: /workspace/{workspaceId}/usageDo it while the map is the only thing that references those keys. Once features exist, a rename is a find-and-replace across every feature file, and sdods lint will not tell you that a navigate step names a key that no longer exists in a way you will enjoy chasing.
While you are in there: id-publish-route-test is not a real route at all — that is the Pages-Router detector firing on a directory called pages and picking up a test file. Delete that row.
We make the rename pass part of accepting the proposal, same as tidying the module names. Roughly: module name plus the last static segment, collision-suffixed if two collide. Takes twenty minutes on a hundred routes and it is the difference between feature files people can read and feature files people copy-paste from each other.
Wrap commands and output in triple backticks and they will render as a code block.
Checking whether you’re signed in…
Have a different question? Ask it.