This repository has been archived by the owner on Oct 27, 2020. It is now read-only.
Update dependency react-styleguidist to v11 #65
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.
This PR contains the following updates:
^7.1.0
->^11.0.0
Release Notes
styleguidist/react-styleguidist
v11.1.1
Compare Source
Bug Fixes
v11.1.0
Compare Source
Features
expand
option for sections and allow custom root section options (#1689) (3ab6f8d)v11.0.11
Compare Source
Bug Fixes
v11.0.10
Compare Source
Bug Fixes
v11.0.9
Compare Source
Bug Fixes
v11.0.8
Compare Source
Fix
v11.0.7
Compare Source
Fix
v11.0.6
Compare Source
chore
Chore
Docs
Fix
v11.0.5
Compare Source
fix
Fix
v11.0.4
Compare Source
Fix
v11.0.3
Compare Source
Fix
v11.0.2
Compare Source
Docs
Fix
v11.0.1
Compare Source
chore
Chore
Fix
v11.0.0
Compare Source
Breaking changes
TypeScript is supported out of the box
We’ve upgraded react-docgen to 5.0.0, which adds TypeScript support out of the box. The are some limitations, so you may still need react-docgen-typescript — see docs for more details.
(#1500, #1354 by @thecodejack)
Fenced code blocks in Markdown with tags
typescript
,ts
andtsx
are rendered as an interactive playground. Use thestatic
modifier to render only the source code.(#1543 by @mitsuruog)
Prefer default exports over named exports
When your component has both default and named exports, Styleguidist will use the default export. This is a bug fix but may break some style guides.
(#1504 by @Lazyuki)
Remove initialState/setState/state
Use React’s
useState
hook instead:(#1501 by @thecodejack)
Drop Node.js 8 support
The minimum supported version on Node.js is 10.
(#1545)
New features
v10.6.2
Compare Source
Fix
v10.6.1
Compare Source
Build
Fix
v10.6.0
Compare Source
New
v10.5.0
Compare Source
Docs
New
v10.4.2
Compare Source
Build
fix
Fix
v10.4.1
Compare Source
Fix
v10.4.0
Compare Source
Build
chore
Docs
New
v10.3.2
Compare Source
Fix
v10.3.1
Compare Source
Fix
v10.3.0
Compare Source
Bug fixes
New features
v10.2.1
Compare Source
Build
Chore
Docs
Fix
v10.2.0
Compare Source
New
--port
command line option to change the dev server port (#1460, fixes #936) (9e744d5), closes #936v10.1.0
Compare Source
New
Modifier to add whitespace between example components (#1456 by @apennell, fixes #841) (4e0bd70)
Let users to be able to add padding between example components without
adding manual styling to their example code. This adds the
padded
modifier optionto the Playground that adds padding between each example component in that block.
v10.0.1
Compare Source
Fix
v10.0.0
Compare Source
👋 Support Styleguidist on Open Collective 👋
Mostly code cleanup (use official React Context API, remove deprecated React APIs and patterns, etc.) and dependencies updates.
#1355 by @tienpham94, #1440 by @J-Kallunki, #1453 by @sapegin
Breaking changes
v9.2.0
Compare Source
New features
minimize
option to disable JavaScript compression (#1442, #1443 by @kopax)v9.1.16
Compare Source
v9.1.15
Compare Source
v9.1.14
Compare Source
Fixed: Single sections can contain only sections (#1414)
If a section contains only one subsection, Styleguidist will try to optimize. It will make the section disappear and show its components instead. If this section only contain sections, no components, it should optimize to sections and not to components.
v9.1.13
Compare Source
Fixed: Highlighting currently selected page on sidebar broken with sections (#1405)
Fixes #1375
v9.1.12
Compare Source
Fixed: Disable HTML minification (#1402)
Fixes #1189
v9.1.11
Compare Source
Fixed: Fix incorrect component name capitalization (#1388)
Fixes #1381
It is happening in a case when react-docgen (any propsParser) is failed and we are trying to guess displayName based on file path. We capitalized every case in the string instead of just words separated by
-
started with small letter. So, by mistakeButtonTS
in file name becomesButtonTs
display name for component when we expectButtonTS
Use [startCase]:(https://lodash.com/docs/4.17.11#startCase) and then remove spaces which covers most our cases likemy-buttonTS => MyButtonTSv9.1.10
Compare Source
Fixed: Encode sublinks in URLs to fix broken routes (#1389)
Follow up of #1332. This appears to have fixed the top level section link, but any sub-links within that section are still unencoded and result in "Page not found".
v9.1.9
Compare Source
Fixed: Add .wasm and .mjs to default extensions in webpack config (#1386)
Fixes #1385
v9.1.8
Compare Source
Fixed: Replace 'walkes' with 'estree-walker' (#1349)
Because walkes has LGPL-3 license.
Fixes #1210
v9.1.7
Compare Source
Fixed: Encode section pages URLs if a section name has special symbols (#1384)
Closes #1332
v9.1.6
Compare Source
Fixed: Fix named export for example components (#1380)
Closes #1281
v9.1.5
Compare Source
Fixed: to make async/await work by default (#1379)
Add transforms: { asyncAwait: false } for default compilerConfig to make async/await work by default. Bublé doesn't have transform for async/await so they raise an error if asyncAwait transformation in configuration is not false (true by default) since bublé v0.9.7.
Closes #1371
v9.1.4
Compare Source
Fixed: Add .ts and .tsx to default extensions in webpack config
#750
v9.1.3
Compare Source
v9.1.2
Compare Source
Fixed: A build should't break when assetsDir is an array (#1367)
copy-webpack-plugin is not allowed
from
to be as an array. If we still want to usefrom
and support array format for assetsDir, then we should pass array of objects{from: ...}
to the plugin.Closes #1320
v9.1.1
Compare Source
Fixed: Section anchors shouldn't conflict with component anchors (#1364)
Prefix section anchors with
section-
.Closes #1342
v9.1.0
Compare Source
New features
Support React Hooks in examples
You can now use hooks in the examples, like the
useState
hook:(#1353 by @eragon512)
Bug fixes
getExampleFilename
should use default example if file does not exist (#1362) by @mendrew, closes #1338v9.0.9
Compare Source
Fixed: Correctly render sections with href in sidebar (#1346)
Closes #1141
v9.0.8
Compare Source
Fixed: Allow code base color to be customized with theme config (#1335)
theme.color.codeBase
propertyv9.0.7
Compare Source
v9.0.6
Compare Source
Fixed: Add output.publicPath option to webpack config to make Create React App happy
Fix #1247
v9.0.5
Compare Source
v9.0.4
Compare Source
Fixed: Allow trailing comma in named imports in examples (#1296)
Fixes #1295
v9.0.3
Compare Source
Fixed: Resolve path of component files (#1305)
Closes #1246
v9.0.2
Compare Source
Fixed: Fix broken Node API
main
field in package.json should point to babelified scriptCloses #1291 #1293
Fixed: Correctly pass key/anchor to config error messages
message
and not passed as a separte field, otherwise the consumer will have to do extra work to show it.anchor
field on StyleguidistError class.Closes #1292 #1293
Fixed: Update clipboard-copy (#1302)
Closes #1290
v9.0.1
Compare Source
Fixed: Fix kleur is not a function error (#1285)
Closes #1284
v9.0.0
Compare Source
👋 Support Styleguidist on Open Collective 👋
New features and breaking changes
Do not put components into global namespace
Finally we’ve fixed one of the oldest and weirdest issues. Style guide components are no longer accessible on
window
. Only the current component is accessible in the example context (not onwindow
). You need to explicitly import any other component.Current component (like
Button
in this example) is always accessible by its name in the example code. If you want to use other components, you need to explicitly import them:Or you can explicitly import everything, to make examples easier to copy into your app code:
require()
statements are still supported.(#1116), #1075, #325 by @sapegin)
Import statements in the editor
You can also define aliases to make your imports more realistic:
In this example
rsg-example
is an alias defined with the moduleAliases config option.(#1142, #1076, #1109, #1074 by @sapegin)
New editor and syntax highlighting
We’ve replaced CodeMirror with react-simple-code-editor and now using Prism for code highlighting in static examples (instead of Highlight.js) and inside the editor. So code look the same everywhere in Styleguidist. We’ve also removed code splitting because react-simple-code-editor is so small and we can include it in the main bundle (8 KB vs 57 KB).
There are some breaking changes in the config:
editorConfig
andhighlightTheme
(already deprecated) options were removed.(#1054 #987 by @sapegin)
Drop React 15 support
React 16.3 is the minimum supported version.
Bug fixes
element
element
Changes since 9.0.0-beta4
Migrating from 8.x to 9.x
highlightTheme
oreditorConfig.theme
options withtheme
option:We don’t have predefined themes anymore, you can customize colors as you wish using the theme config option:
v8.0.6
Compare Source
Fixed: Allow custom styling for prop names and types (#1211)
Closes #1205
v8.0.5
Compare Source
Fixed: Upgrade react-docgen to 3.0.0-rc.2 (#1200)
Closes #1177
v8.0.4
Compare Source
v8.0.3
Compare Source
v8.0.2
Compare Source
Fixed: Support Component/index.js in the default getExampleFilename (#1185)
Fixes #1169
v8.0.1
Compare Source
Fixed: Upgrade markdown-to-jsx
Closes #1181
v8.0.0
Compare Source
👋 Support Styleguidist on Open Collective 👋
Breaking changes
Drop webpack 3 support
Webpack 3 is no longer supported, webpack 4 is the minimum required version.
As a side effect you shouldn’t see any webpack warnings when you run Styleguidist.
We’ve also replaced no longer maintainer uglify-es with Terser to minify production JavaScript bundle.
Renovate configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻️ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.