Add code regions#48
Conversation
|
🌐 Preview URL: https://pr-48.frcsoftware.pages.dev |
0588aeb to
4908a5d
Compare
| | `pnpm dev` | Start local dev server at `localhost:4321` | | ||
| | `pnpm build` | Build production site to `./dist/` | | ||
| | `pnpm preview` | Preview build locally before deploying | | ||
| | `pnpm format` | Run the formatter | |
There was a problem hiding this comment.
Should format:check be listed here too?
roboteer5291
left a comment
There was a problem hiding this comment.
Mostly good, see one comment + general disagreement with stg0, keep it simple and make it stage 0
DylanB5402
left a comment
There was a problem hiding this comment.
Code generally looks good, a couple higher level questions, but nothing holding back approval:
- Is there an example of what RLIs actually look like in use somewhere on the PR preview?
- Any reason we're writing our own plugin here? Not sure if there's already something out there that does what we need
Nothing out there that suits our purposes that's actually maintained. I implemented the RLIs for the Java fundamentals, so you can just peek at that. |
pnpm lint is now a meta-command that runs lint:eslint, lint:md, lint:regions, and typecheck. Update README.md, styleguide.mdx, and methodsOfContributing.mdx to reflect the new standalone sub-commands and remove redundant step instructions.
|
I think that it would be better for the snippets to be in a separate folder than the code solutions. People are probably going to be forking the entire repo to look at solutions. Other than that, though, looks great |
We need to compile the entirety of the code to validate the snippets. That would mean maintaining two copies of the solutions, and I don't think that's viable. IMO, the snippets are easily ignorable, but if we must we can take the same strategy we'll be using with the templates and strip the snippets via copybara to a separate repo. |
|
Additionally, most snippets will be in the solution code, which won't need to be cloned as part of the course. |
Code regions will allow us to reference code from a file utilizing specific tags embedded in the file. This is superior to referencing by line, as is common with RLI's, as this is resistant to changes.
Usage is by adding a comment with the region name in square-brackets. See below for an example.