Skip to content

Conversation

@fvsch
Copy link
Contributor

@fvsch fvsch commented Nov 10, 2022

We (well, I) introduced a regression in version 1.7.0 of the SDK by renaming the hidedevtools and devtoolsheight URL query parameters to hideDevTools and devToolsHeight.

See: 5e89b03#diff-4db4b7030103b2f5677a33713b8c50bc15c70c96aafdf68adcd25f6f6a141a62L54-L65

While stackblitz.com does handle query parameters insensitive of case, StackBlitz EE may not (depending on the deployed version).

For backwards compatibility, those parameters should keep their original case.

@fvsch fvsch requested review from sulco and ykmsd November 10, 2022 08:25
@fvsch fvsch force-pushed the florens/sdk-query-params-backwards-compat branch from 1f6901a to b447158 Compare November 10, 2022 08:26
- TypeScript: improved the precision and inline documentation of types such as `Project`, `EmbedOptions`, `OpenOptions` and `VM`. Made those types directly importable with `import type { Project } from '@stackblitz/sdk'`. (#1775, #1779, #1837)
- Added support for opening multiple files in an embedded projects with the `vm.editor.openFile` method. (#1810)
- Added new methods to the `VM` class for controlling the embedded editor’s UI: `vm.editor.setCurrentFile`, `vm.editor.setTheme`, `vm.editor.setView`, `vm.editor.showSidebar`, `vm.preview.getUrl`, `vm.preview.setUrl`. (#1810, #1837)
- Added new `showSidebar` option. (#1837)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just changing the punctuation for PR references in the changelog, to make it consistent in the whole changelog.

"bundles",
"typings"
"typings",
"CHANGELOG.md",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The license and readme files are included by default in npm packages, but the changelog is not. Listing all three files explicitly to make our intent clear.

const generators: Record<keyof Options, (value: any) => string> = {
clickToLoad: (value: Options['clickToLoad']) => trueParam('ctl', value),
devToolsHeight: (value: Options['devToolsHeight']) => percentParam('devToolsHeight', value),
devToolsHeight: (value: Options['devToolsHeight']) => percentParam('devtoolsheight', value),
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⭐ The fix.

Copy link

@ykmsd ykmsd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for detailed PR as always 👍

@fvsch fvsch merged commit 51fa940 into main Nov 10, 2022
@fvsch fvsch deleted the florens/sdk-query-params-backwards-compat branch February 24, 2023 17:06
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