Skip to content

Document the problem_specifications_slug key - #600

Open
keiravillekode wants to merge 1 commit into
exercism:mainfrom
keiravillekode:specification
Open

keiravillekode wants to merge 1 commit into
exercism:mainfrom
keiravillekode:specification

Conversation

@keiravillekode

Copy link
Copy Markdown
Contributor

A track sometimes needs a different slug from the problem-specifications exercise it implements, for example to avoid a name collision in the track's language.

See exercism/configlet#936

A track sometimes needs a different slug from the problem-specifications
exercise it implements, for example to avoid a name collision in the
track's language.

See exercism/configlet#936
@keiravillekode

Copy link
Copy Markdown
Contributor Author

I used Claude for this docs change.

@IsaacG

IsaacG commented Nov 11, 2026

Copy link
Copy Markdown
Member

@keiravillekode Is this ready for review?

@keiravillekode
keiravillekode marked this pull request as ready for review November 11, 2026 07:35
@glennj

glennj commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

Something occurred to me while reviewing: at what point does the exercise author know there is a name conflict. Presumably after using configlet create, while testing we see the errors. Then the author can rename the directory, etc, and edit config.json to add the problem_specifications_slug key.

What if the name conflict is already known? Is it worthwhile thinking about adding some functionality to configlet create ?

@keiravillekode

Copy link
Copy Markdown
Contributor Author

We have 4 known use cases: factor binary-search, haskell binary-search matrix say

We did not know about the conflict until after the exercises had been merged. Users noticed that the tests were either not being run (factor) or were timing out when run through the web app even though they passed locally (haskell).

@IsaacG

IsaacG commented Nov 11, 2026

Copy link
Copy Markdown
Member

Given that these are edge cases and this route should only be used as a last resort, I think it's fine to not expose it via the create command.

@glennj

glennj commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

I'm considering using this for say on moonscript. What's the way forward: create the new exercise and deprecate the existing one?

@keiravillekode

Copy link
Copy Markdown
Contributor Author

I'm considering using this for say on moonscript. What's the way forward: create the new exercise and deprecate the existing one?

Yes. If we rename the existing exercise, students can end up with their old solution file plus the new stub file, and it isn't obvious how to get rid of the old solution file.

Example deprecating the existing one: Haskell PR 1320

Note than bin/fetch-configlet still downloads the old configlet 4.0.2, so either wait for the release or you will need to build configlet locally in order to

  • sync with configlet sync -u
  • preserve the new problem_specifications_slug entry when configlet fmt -u is run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants