Make project.description optional #5
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fvsch
force-pushed
the
fvsch/make-project-description-optional
branch
from
5e6fa35 to
8d5e782
Compare
sylwiavargas
approved these changes
Mar 10, 2023
fvsch
force-pushed
the
fvsch/make-project-description-optional
branch
from
8d5e782 to
fb61bc9
Compare
fvsch
force-pushed
the
fvsch/make-project-description-optional
branch
from
fb61bc9 to
4615fe5
Compare
fvsch
commented
Mar 10, 2023
| @@ -2,7 +2,7 @@ import type { PROJECT_TEMPLATES } from './constants'; | |||
|
|
|||
| export interface Project { | |||
| title: string; | |||
| description: string; | |||
| description?: string; | |||
| form.appendChild(createHiddenInput('project[template]', project.template)); | ||
| addInput('project[title]', title); | ||
| if (typeof description === 'string' && description.length > 0) { | ||
| addInput('project[description]', description); |
There was a problem hiding this comment.
Did a bit of refactoring of the createProjectForm function, but the main functional change is here: conditionally creating an input to send the description in the POST request.
| @@ -5,7 +5,7 @@ exports[`createProjectFrameHTML > generates a HTML document string 1`] = ` | |||
| <html> | |||
| <head><title></title></head> | |||
| <body> | |||
| <form method=\\"POST\\" style=\\"display:none!important;\\" action=\\"https://stackblitz.com/run?embed=1\\" id=\\"sb_run\\"><input type=\\"hidden\\" name=\\"project[title]\\" value=\\"Test Project\\"><input type=\\"hidden\\" name=\\"project[description]\\" value=\\"This is a test\\"><input type=\\"hidden\\" name=\\"project[template]\\" value=\\"javascript\\"><input type=\\"hidden\\" name=\\"project[files][package.json]\\" value=\\"{ | |||
| <form method=\\"POST\\" style=\\"display:none!important;\\" action=\\"https://stackblitz.com/run?embed=1\\" id=\\"sb_run\\"><input type=\\"hidden\\" name=\\"project[title]\\" value=\\"Test Project\\"><input type=\\"hidden\\" name=\\"project[template]\\" value=\\"javascript\\"><input type=\\"hidden\\" name=\\"project[files][package.json]\\" value=\\"{ | |||
There was a problem hiding this comment.
Those snapshots are a bit hard to read, especially in GitHub diffs, but they're correct as far as I can tell.
| @@ -50,7 +50,7 @@ describe('createProjectForm', () => { | |||
|
|
|||
| // Check input values | |||
| expect(value('project[title]')).toBe('My Test Project'); | |||
| expect(value('project[description]')).toBe(project.description); | |||
| expect(value('project[description]')).toBe(undefined); | |||
There was a problem hiding this comment.
Removed the description from the default test project.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When using the SDK's
embedProjectandopenProjectmethods, which expect a project definition object, our TypeScript types require thedescriptionto be provided.Turns out that the StackBlitz backend doesn't actually require a description.
In my own tests, having to come up with a description for a simple example, test or reproduction is often a chore. I've definitely used
description: ''before as a workaround. I think we can get out of our users's way and make the description field optional.What do you think?