Add ScastieModifier #59
Conversation
|
|
||
| class ScastieModifierSuite extends BaseMarkdownSuite { | ||
|
|
||
| private val debugClassSuffix = "test" |
There was a problem hiding this comment.
This is needed because I generate a random UUID for suffixing the CSS class of each snippet so diff wouldn't work.
| * ``` | ||
| * }}} | ||
| * ====Note==== | ||
| * The empty line in the block is relevant (md parser chokes otherwise) |
There was a problem hiding this comment.
Yes, on purpose.
The warning applies to both cases and I suspect people that jump through sections won't catch it unless repeated.
| @@ -0,0 +1,82 @@ | |||
| package mdoc.modifier | |||
There was a problem hiding this comment.
let's call this scastie.mods instead
There was a problem hiding this comment.
mdoc.mods? Anyway I'm sold on the plural (following https://softwareengineering.stackexchange.com/questions/75919/should-package-names-be-singular-or-plural/327653), but I'm not sold on the abbreviation, because you end up with Modifier for the class names, but mod for the package.
I would rather use Mod for the classes (ScastieMod), or use modifiers for the package name.
There was a problem hiding this comment.
I may eventually go with Mod instead of Modifier since it's quite long. I renamed the package to mdoc.modifiers for now since I agree with the stack exchange answer you linked about plural is nice when all members of the package have the same type.
| @@ -61,4 +61,23 @@ abstract class BaseMarkdownSuite extends org.scalatest.FunSuite with DiffAsserti | |||
| assertNoDiffOrPrintExpected(obtained, expected) | |||
| } | |||
| } | |||
|
|
|||
| def checkWithSettings( | |||
There was a problem hiding this comment.
I think this is unnecessary if you override val settings. Alternatively, can we reuse the check above by adding a paramter settings: Settings = this.setting?
There was a problem hiding this comment.
Overriding the settings doesn't allow to assign different settings to different tests.
Passing settings to check doesn't work because context has already been initialized at that point.
I can refactor the BaseMarkdownSuite to be more stateless, but that's a bigger change.
There was a problem hiding this comment.
I would have created a ScastieDarkSuite to work around the evil state 😜
I refactored BaseMarkdownSuite to be state-less so that it's possible to use different settings in the same suite, just for you 😘
|
Really cool! Can you add a note in the doc to about preferring the embedding with an ID. This way you don't need to re-run the snippet. |
|
This looks really cool. |
|
@MasseGuillaume it's already there, right below the inline snippet example. Or did you mean something different? |
| * ``` | ||
| * }}} | ||
| * ====Note==== | ||
| * This will be slower to run than embedding a snippet, since it's not cached |
- make BaseMarkdownSuite stateless to enable different settings in the same suite - s/mdoc.modifier/mdoc.modifiers/
| @@ -0,0 +1,82 @@ | |||
| package mdoc.modifier | |||
There was a problem hiding this comment.
I may eventually go with Mod instead of Modifier since it's quite long. I renamed the package to mdoc.modifiers for now since I agree with the stack exchange answer you linked about plural is nice when all members of the package have the same type.
| * ``` | ||
| * }}} | ||
| * ====Note==== | ||
| * The empty line in the block is relevant (md parser chokes otherwise) |
| @@ -61,4 +61,23 @@ abstract class BaseMarkdownSuite extends org.scalatest.FunSuite with DiffAsserti | |||
| assertNoDiffOrPrintExpected(obtained, expected) | |||
| } | |||
| } | |||
|
|
|||
| def checkWithSettings( | |||
There was a problem hiding this comment.
I would have created a ScastieDarkSuite to work around the evil state 😜
I refactored BaseMarkdownSuite to be state-less so that it's possible to use different settings in the same suite, just for you 😘
|
GitHub is funky so it's no picking up the push, guess I should hit bed then 😏 |
|
Forgot, can you please document this modifier in |
|
It's |
|
whoops should rename that module to docs for consistency! |
Demo: https://www.icloud.com/iclouddrive/0eP94JWoV-rINX0TdKjmGCsmw#mdoc-scastie.mov