Isolated React component development environment with a living style guide

Last update: Jan 1, 2023

Overview

Isolated React component development environment with a living style guide

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component propTypes and shows live, editable usage examples based on Markdown files. Check out the demo style guide.

Usage

Getting Started: install and run Styleguidist
Documenting components: how to write documentation
Locating components: point Styleguidist to your React components
Configuring webpack: tell Styleguidist how to load your code
Cookbook: how to solve common tasks with Styleguidist

Advanced documentation

Examples

Basic style guide, source
Style guide with sections, source
Style guide with customized styles, source
Style guide with custom express endpoints, source
Create React App integration, source

Showcase

Real projects using React Styleguidist:

Integration with other tools

Create React App — supported out of the box, see the Getting Started guide
Vue, see Vue Styleguidist

Third-party tools

snapguidist: snapshot testing for React Styleguidist
react-styleguidist-visual: automated visual testing for React Styleguidist, using Puppeteer and pixelmatch
styleguidist-scrapper: scrapper script for documentation generated by React Styleguidist

Resources

The Dream of Styleguide Driven Development talk by Sara Vieira
Building React Components Library talk by Robert Haritonov
Say Cheese: Snapshots and Visual Testing
Interview with Artem Sapegin about React Styleguidist.

Change log

The change log can be found on the Releases page.

Contributing

Everyone is welcome to contribute. Please take a moment to read the contributing guidelines and the developer guide.

Sponsoring

Become a sponsor and get your logo on our Readme on GitHub with a link to your site.

Become a backer get your image on our Readme on GitHub with a link to your site.

Authors and license

Artem Sapegin and contributors.

Logo by Sara Vieira and Andrey Okonetchnikov.

MIT License, see the included License.md file.

Comments

Logo

I’m going to make a proper site for Styleguidist after 5.x release, so a proper logo would a very nice addition.

Unfortunately I have no ideas of my own ;-£

/cc @okonet
help wanted

opened by sapegin 81
Who uses React Styleguidist?

Do you use React Styleguidist in your project? Let us know about that! It’d be great if you can share some details: screenshot, link, number of components, etc.

We use it at Here for a component library that we use to develop internal tools. Right now we have 41 component and it’s growing:

question

opened by sapegin 44
WIP: Emulate responsive behavior
Hi!

This PR is related to #133.

It's still a WIP. But is this implementation good enough for passing down the configuration ?

Next, I'll have to do:

a bit of design

add some scaling behavior if the width is too big compared to the container

Cheers
opened by JulienPradet 42
Automated Visual Testing
We spoke about it once, I though it might be good to at least kick off the discussion here.

So the idea is that we can trigger visual snapshot testing which will essentially create graphics for each demo so that next time you run it it can compare and report mismatches.

I think react-styleguidist is a good place to do this because it already has lots of configured components if one uses it havily, so it would not cost much for the user to use this.

List of screenshot tools:

https://github.com/garris/BackstopJS

https://github.com/segmentio/niffy

wontfix request for comments
opened by kof 40
feat(editor): Passes all codeMirror options to editor

All you now pass inside codeMirrorOptions in your styleguide config will be passed to codeMirror. I left highlight theme out because I didn't want to cause a breaking change

closes #648

opened by SaraVieira 39
Plugin API first draft
[x] plugins config option

[x] Load plugins and pass to the style guide

[x] Convert slots to core plugins

[ ] Ability to modify style guide config from a plugin (?)

[x] Containers (similar to slow but wraps children in all passed wrappers)

[ ] Add validation

[ ] Add tests

[ ] Add docs

I have no idea how to do:

[ ] Store and change state for plugins (I suppose it should be separate state for style guide / component / example).

[ ] Change style guide in any way (for example something similar to the Wrapper component).

wontfix
opened by sapegin 39

You many need an appropriate loader to handle this file type

When starting the server I get the following error:

/react-styleguidist/src/index.js Line 1: Unexpected token
You may need an appropriate loader to handle this file type.
| import React from 'react';
| import ReactDOM from 'react-dom';
| import { setComponentsNames, globalizeComponents } from './utils/utils';```

Wondering if babel isn't transpiling the import.

opened by withgallantry 36

UI improvements proposal (UI 2.0)
We keep adding new function and new “buttons” to the UI and right now it’s inconsistent and far from perfect. Adding more features (and there are plans and wishes to do that) will most likely destroy user experience completely. I was thinking about that for a long time and here are my thoughts.

Goals I want to solve in this issue:

Improve developer experience (component development process);

Simplify and streamline the UI;

Add UI extension points for plugins.

Styleguidist UI consists of these three “levels” (and actions you can do on each level, with some future plans):

Global (toggle sidebar, toggle props/description, switch background, close isolation = go home);

Component / section (get anchor link, open in isolation);

Example (open in isolation, toggle code visibility, show snapshots).

As a possible solution I see something like this:

Sorry for my drawing skills but basically we’ll have toolbars for each “level” that could be possible to extend from plugins plus (also extendable) tab bar for each example (this was already discussed in a relation to the plugin API).

Related issues: #354, #333, #327, #424, #421, #235.

Any feedback? Some design help would be very useful here ;-)
wontfix request for comments
opened by sapegin 33
ci: Use a monorepo to host styleguidist
Objective: enable splitting react-styleguidist into multiple packages without losing any developer experience.

[x] Move all code into packages/react-styleguidist

[x] Use yarn workspaces to manage dependencies

[x] Make compile + jest tests pass

[x] Make sure all scripts are still working the same

[x] Fix dangerfile

[x] cypress should pass green

[x] Review ci to use lerna

[x] Adapt documentation for change of log convention

NOTA: I voluntarily left out all the changes regarding extracting the core of styleguidist from the rest. I feel they would confuse proofreading.
wontfix
opened by elevatebart 29
Suggestions
I wasn't sure where to post this so I'm just putting it in an issue. After having worked with this awesome tool a bit over the weekend here are some suggestions which I think would make it more extensible for larger projects:

[x] Set path to styleguide.config.js

[x] Set path to template for output

[x] Set a different syntax highlighter

[x] If a type is "union" list out the possible types within it

[x] Ability to toggle showing/hiding code examples

[x] Ability to somehow group components with a navigation so you can show/hide only what section you want to see

As for the last item, I think this is pretty important for larger codebases where there are lots of components to be shown. It would be fantastic to have something that functions similar to this:

http://spothero.com/uniform/#ui/css

What do you think about these?
enhancement help wanted
opened by reintroducing 29
Font color in examples being overwritten in Safari

I'm noticing that since v6.1.0 font colors inside of component examples are being overwritten by theme.color.base. From what I can tell it only seems to be an issue in Safari (tested in 11.0.2)

Code editor is being overwritten as well.

https://github.com/corygibbons/styleguidist-example/tree/font-color

Chrome (working):

Safari (broken):
bug

opened by corygibbons 28
Build(deps): Bump json5, babel-loader, react-styleguidist and webpack in /examples/styled-components
Bumps json5 to 2.2.3 and updates ancestor dependencies json5, babel-loader, react-styleguidist and webpack. These dependencies need to be updated together.

Updates json5 from 2.1.0 to 2.2.3

Release notes

Sourced from json5's releases.

v2.2.3

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2

Fix: Bump minimist to v1.2.5. (#222)

v2.1.1

New: package.json and package.json5 include a module property so bundlers like webpack, rollup and parcel can take advantage of the ES Module build. (#208)

Fix: stringify outputs \0 as \\x00 when followed by a digit. (#210)

Fix: Spelling mistakes have been fixed. (#196)

Changelog

Sourced from json5's changelog.

v2.2.3 [code, diff]

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2 [code, diff]

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1 [code, diff]

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0 [code, diff]

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2 [code, diff]

Fix: Bump minimist to v1.2.5. (#222)

v2.1.1 [code, [diff][d2.1.1]]

... (truncated)

Commits

c3a7524 2.2.3

94fd06d docs: update CHANGELOG for v2.2.3

3b8cebf docs(security): use GitHub security advisories

f0fd9e1 docs: publish a security policy

6a91a05 docs(template): bug -> bug report

14f8cb1 2.2.2

10cc7ca docs: update CHANGELOG for v2.2.2

7774c10 fix: add proto to objects and arrays

edde30a Readme: slight tweak to intro

97286f8 Improve example in readme

Additional commits viewable in compare view

Updates babel-loader from 8.0.5 to 8.3.0

Release notes

Sourced from babel-loader's releases.

v8.3.0

New features

Pass external dependencies from Babel to Webpack by @nicolo-ribaudo in babel/babel-loader#971

Full Changelog: https://github.com/babel/babel-loader/compare/v8.2.5...v8.3.0

v8.2.5

What's Changed

fix: respect inputSourceMap loader option by @alan-agius4 in babel/babel-loader#896

New Contributors

@alan-agius4 made their first contribution in babel/babel-loader#896

Full Changelog: https://github.com/babel/babel-loader/compare/v8.2.4...v8.2.5

v8.2.4

What's Changed

doc(README.md): fix a broken markdown link by @loveDstyle in babel/babel-loader#919

Bump loader-utils to 2.x by @stianjensen in babel/babel-loader#931

Use md5 hashing for OpenSSL 3 by @pathmapper in babel/babel-loader#924

Thanks @loveDstyle, @stianjensen and @pathmapper for your first PRs!

8.2.3

This release fixes compatibility with Node.js 17

Use md5 hash for caching on node v17 (babel/babel-loader#918)

Thanks @Reptarsrage!

8.2.1

Move @ava/babel to devDependencies #881 (@jvasseur)

8.2.0

Replace mkdirp with make-dir 47958ca3857e489e450b27c6f3266375015cba82 (@JLHwung)

Use async config loading when available d8cff97ff387ded0fc9b5cbc489228c96c5ab14a (@the-spyke)

8.1.0

docs(readme): fix typo #818 (@frederickfogerty)

docs(contributing): fix typo #821 (@PatNeedham)

Add schema validation #822 (@ogonkov)

Add supportsTopLevelAwait to caller #814 (@nicolo-ribaudo)

feat: expose webpack target via babel caller #826 (@DylanPiercey)

Bump deps for audit #834 (@existentialism)

8.0.6

Migrate to pify (#785)

Reduced memory usage (#781)

Commits

9bf5652 8.3.0

80ab7d0 Update @babel/ dependencies

493ac6c Pass external dependencies from Babel to Webpack (#971)

df28fe3 Fix broken main test (#950)

0b338e4 update hash method so it doesn't fail on a fips enabled machine (#939)

1f98d3c 8.2.5

c622868 fix: respect inputSourceMap loader option (#896)

f7982c1 8.2.4

4bb9e21 Use md5 hashing for OpenSSL 3 (#924)

247c94b Bump loader-utils to 2.x (#931)

Additional commits viewable in compare view

Maintainer changes

This version was pushed to npm by nicolo-ribaudo, a new releaser for babel-loader since your current version.

Updates react-styleguidist from 9.0.8 to 13.0.0

Release notes

Sourced from react-styleguidist's releases.

v13.0.0

13.0.0 (2022-10-14)

Upgrade to React 17 (#2037) (374acc5), closes #2037

BREAKING CHANGES

React 16 no longer supported

v12.0.1

12.0.1 (2022-10-06)

Bug Fixes

ensure devserver client options are configurable (#2034) (f1a0c21)

v12.0.0

12.0.0 (2022-09-05)

Features

Upgrade to Webpack 5 (#1996) (a460fcc), closes #1932

BREAKING CHANGES

Webpack 4 is no longer supported.

v12.0.0-alpha9.9

fix: Move sucrase back to dependencies 05825f79

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.8...v12.0.0-alpha9.9

v12.0.0-alpha9.8

Polyfill process for webpack 5 925b40de

Avoid errors about imports without extension in webpack 5 70a06179

Fix pagePerSection, improve types, simplify 13898771

Fix isolation for the first (index = 0) example faf749c3

Refactor inline Markdown 3dffa2e1

v12.0.0-alpha9.7

Use // to instead of / for target index in the URL to avoid conflicts d563606e

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.6...v12.0.0-alpha9.7

... (truncated)

Commits

374acc5 Upgrade to React 17 (#2037)

f1a0c21 fix: ensure devserver client options are configurable (#2034)

80b5e84 chore: Try to remove Netlify config to fix the site build

cfd8458 chore: Update lock files

51db5e1 docs: Move ads to the top of the sidebar, fix refreshing on navigation 📢

a460fcc feat: Upgrade to Webpack 5 (#1996)

4c55077 Build(deps): Bump ua-parser-js in /examples/webpack (#1928)

e630725 Build(deps): Bump browserslist in /examples/webpack (#1927)

2c855fa Build(deps): Bump follow-redirects in /examples/react-native (#1924)

7f4d1fa Build(deps): Bump follow-redirects in /examples/preact (#1921)

Additional commits viewable in compare view

Updates webpack from 4.30.0 to 5.75.0

Release notes

Sourced from webpack's releases.

v5.75.0

Bugfixes

experiments.* normalize to false when opt-out

avoid NaN%

show the correct error when using a conflicting chunk name in code

HMR code tests existance of window before trying to access it

fix eval-nosources-* actually exclude sources

fix race condition where no module is returned from processing module

fix position of standalong semicolon in runtime code

Features

add support for @import to extenal CSS when using experimental CSS in node

add i64 support to the deprecated WASM implementation

Developer Experience

expose EnableWasmLoadingPlugin

add more typings

generate getters instead of readonly properties in typings to allow overriding them

v5.74.0

Features

add resolve.extensionAlias option which allows to alias extensions

This is useful when you are forced to add the .js extension to imports when the file really has a .ts extension (typescript + "type": "module")

add support for ES2022 features like static blocks

add Tree Shaking support for ProvidePlugin

Bugfixes

fix persistent cache when some build dependencies are on a different windows drive

make order of evaluation of side-effect-free modules deterministic between concatenated and non-concatenated modules

remove left-over from debugging in TLA/async modules runtime code

remove unneeded extra 1s timestamp offset during watching when files are actually untouched

This sometimes caused an additional second build which are not really needed

fix shareScope option for ModuleFederationPlugin

set "use-credentials" also for same origin scripts

Performance

Improve memory usage and performance of aggregating needed files/directories for watching

This affects rebuild performance

Extensibility

export HarmonyImportDependency for plugins

v5.73.0

... (truncated)

Commits

8241da7 5.75.0

a91d923 Merge pull request #16458 from webpack/bugfix/semi

4608b11 Merge pull request #16457 from webpack/tooling/update

dfdd0b0 Merge pull request #16122 from AnmolBansalDEV/bug/compilationCallback

23b9a1c Merge pull request #16167 from exposir/fixts

6f2c5e8 Merge pull request #16257 from alexzhang1030/calc_deterministic_verbose

f7f36ad Merge pull request #16339 from Liamolucko/wasm-i64

761a542 fix semicolon position

2403a36 Merge pull request #16345 from ahabhgk/fix-eval-nosources

c18203c update tooling

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Build(deps): Bump json5 from 1.0.1 to 2.2.3 in /examples/basic
Bumps json5 from 1.0.1 to 2.2.3.

Release notes

Sourced from json5's releases.

v2.2.3

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2

Fix: Bump minimist to v1.2.5. (#222)

v2.1.1

New: package.json and package.json5 include a module property so bundlers like webpack, rollup and parcel can take advantage of the ES Module build. (#208)

Fix: stringify outputs \0 as \\x00 when followed by a digit. (#210)

Fix: Spelling mistakes have been fixed. (#196)

v2.1.0

New: The index.mjs and index.min.mjs browser builds in the dist directory support ES6 modules. (#187)

v2.0.1

Fix: The browser builds in the dist directory support ES5. (#182)

v2.0.0

Major: JSON5 officially supports Node.js v6 and later. Support for Node.js v4 has been dropped. Since Node.js v6 supports ES5 features, the code has been rewritten in native ES5, and the dependence on Babel has been eliminated.

New: Support for Unicode 10 has been added.

New: The test framework has been migrated from Mocha to Tap.

New: The browser build at dist/index.js is no longer minified by default. A minified version is available at dist/index.min.js. (#181)

Fix: The warning has been made clearer when line and paragraph separators are

... (truncated)

Changelog

Sourced from json5's changelog.

v2.2.3 [code, diff]

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2 [code, diff]

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1 [code, diff]

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0 [code, diff]

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2 [code, diff]

Fix: Bump minimist to v1.2.5. (#222)

v2.1.1 [code, [diff][d2.1.1]]

... (truncated)

Commits

c3a7524 2.2.3

94fd06d docs: update CHANGELOG for v2.2.3

3b8cebf docs(security): use GitHub security advisories

f0fd9e1 docs: publish a security policy

6a91a05 docs(template): bug -> bug report

14f8cb1 2.2.2

10cc7ca docs: update CHANGELOG for v2.2.2

7774c10 fix: add proto to objects and arrays

edde30a Readme: slight tweak to intro

97286f8 Improve example in readme

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Build(deps): Bump json5 and tsconfig-paths
Bumps json5, json5, json5 and tsconfig-paths. These dependencies needed to be updated together. Updates json5 from 2.1.1 to 2.2.3

Release notes

Sourced from json5's releases.

v2.2.3

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2

Fix: Bump minimist to v1.2.5. (#222)

Changelog

Sourced from json5's changelog.

v2.2.3 [code, diff]

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2 [code, diff]

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1 [code, diff]

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0 [code, diff]

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2 [code, diff]

Fix: Bump minimist to v1.2.5. (#222)

Commits

c3a7524 2.2.3

94fd06d docs: update CHANGELOG for v2.2.3

3b8cebf docs(security): use GitHub security advisories

f0fd9e1 docs: publish a security policy

6a91a05 docs(template): bug -> bug report

14f8cb1 2.2.2

10cc7ca docs: update CHANGELOG for v2.2.2

7774c10 fix: add proto to objects and arrays

edde30a Readme: slight tweak to intro

97286f8 Improve example in readme

Additional commits viewable in compare view

Updates json5 from 2.1.2 to 2.2.3

Release notes

Sourced from json5's releases.

v2.2.3

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2

Fix: Bump minimist to v1.2.5. (#222)

Changelog

Sourced from json5's changelog.

v2.2.3 [code, diff]

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2 [code, diff]

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1 [code, diff]

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0 [code, diff]

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2 [code, diff]

Fix: Bump minimist to v1.2.5. (#222)

Commits

c3a7524 2.2.3

94fd06d docs: update CHANGELOG for v2.2.3

3b8cebf docs(security): use GitHub security advisories

f0fd9e1 docs: publish a security policy

6a91a05 docs(template): bug -> bug report

14f8cb1 2.2.2

10cc7ca docs: update CHANGELOG for v2.2.2

7774c10 fix: add proto to objects and arrays

edde30a Readme: slight tweak to intro

97286f8 Improve example in readme

Additional commits viewable in compare view

Updates json5 from 2.1.3 to 2.2.3

Release notes

Sourced from json5's releases.

v2.2.3

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2

Fix: Bump minimist to v1.2.5. (#222)

Changelog

Sourced from json5's changelog.

v2.2.3 [code, diff]

Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299)

v2.2.2 [code, diff]

Fix: Properties with the name __proto__ are added to objects and arrays. (#199) This also fixes a prototype pollution vulnerability reported by Jonathan Gregson! (#295).

v2.2.1 [code, diff]

Fix: Removed dependence on minimist to patch CVE-2021-44906. (#266)

v2.2.0 [code, diff]

New: Accurate and documented TypeScript declarations are now included. There is no need to install @types/json5. (#236, #244)

v2.1.3 [code, diff]

Fix: An out of memory bug when parsing numbers has been fixed. (#228, #229)

v2.1.2 [code, diff]

Fix: Bump minimist to v1.2.5. (#222)

Commits

c3a7524 2.2.3

94fd06d docs: update CHANGELOG for v2.2.3

3b8cebf docs(security): use GitHub security advisories

f0fd9e1 docs: publish a security policy

6a91a05 docs(template): bug -> bug report

14f8cb1 2.2.2

10cc7ca docs: update CHANGELOG for v2.2.2

7774c10 fix: add proto to objects and arrays

edde30a Readme: slight tweak to intro

97286f8 Improve example in readme

Additional commits viewable in compare view

Updates tsconfig-paths from 3.9.0 to 3.10.1

Changelog

Sourced from tsconfig-paths's changelog.

[3.10.1] - 2021-07-06

Fixed

Add register.js to published files

[3.10.0] - 2021-07-06

Added

feat(tsconfig-loader): extends config from node_modules (#106). Thanks to @zorji for this PR!

Fixed

Update CHANGELOG.md (#96). Thanks to @OliverJAsh for this PR!

Fix "bootstraping" typo (#111). Thanks to @KRMisha for this PR!

Update Readme fixes #116 (#123). Thanks to @benwinding for this PR!

Fixed typo (#144). Thanks to @mprinc for this PR!

[TYPO] src/mapping-entry.ts (#145). Thanks to @mprinc for this PR!

docs(README): fix typos (#156). Thanks to @PiDelport for this PR!

deps: bump json5 to use type definition provided officially (#158). Thanks to @koba04 for this PR!

Update tsconfig-loader.ts (#161). Thanks to @fecqs for this PR!

fix typo (#165). Thanks to @wonda-tea-coffee for this PR!

Add file extenstion to typings property value (#151). Thanks to @dangrussell for this PR!

Commits

80bc810 v3.10.1

beb9a47 Add changelog for 3.10.1

893b76d Add register.js to published files

9327fa1 v3.10.0

766a0e8 Update changelog for 3.10.0

2cf8b21 Categorize changelog

fb67ba2 Update changelog with unreleased PRs

079285a Add file extenstion to typings property value (#151)

c49386c feat(tsconfig-loader): extends config from node_modules without './node_modul...

f289c99 fix typo (#165)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Build(deps): Bump fast-json-patch from 3.0.0-1 to 3.1.1
Bumps fast-json-patch from 3.0.0-1 to 3.1.1.

Release notes

Sourced from fast-json-patch's releases.

3.1.1

Security Fix for Prototype Pollution - huntr.dev #262

Bug fixes and ES6 modules

Use ES6 Modules

package now exports non-bundled ES module Starcounter-Jack/JSON-Patch#232

main still points to CommonJS module for backward compatibility

README recommends use of named ES imports

List of changes https://github.com/Starcounter-Jack/JSON-Patch/compare/v2.2.1...3.0.0-0

Commits

9d313ac fix(tests): Updated tests to reflect new error message

e4f4eb3 3.1.1

d7903fb fix: typescript codegen changes

5f04488 Bumping version number

7e9fe13 Typescript provided

097864a Documentation updated

51964ed feat: Cleaned up vars vs consts

8a6a360 New build

adeb422 Update .gitignore

59336fe Merge pull request #292 from Starcounter-Jack/dependabot/npm_and_yarn/ajv-6.12.6

Additional commits viewable in compare view

Maintainer changes

This version was pushed to npm by mountain-jack, a new releaser for fast-json-patch since your current version.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0

how to create a Markdown table?

When I use the following two methods to create a table in .md file:

|A|B|C|
|-|-|-|
|a|b|c|
|a|b|c|
// or
<table>
  <tr>
    <th>A</th>
    <th>B</th>
    <th>C</th>
  </tr>
  <tr>
    <td>a</td>
    <td>b</td>
    <td>c</td>
  </tr>  
</table>

the PROPS & METHODS table was broken like this:

opened by stephenliu1944 1

Releases(v13.0.0)

v13.0.0(Oct 14, 2022)
13.0.0 (2022-10-14)

Upgrade to React 17 (#2037) (374acc5), closes #2037

BREAKING CHANGES

React 16 no longer supported

Source code(tar.gz)
Source code(zip)
v12.0.1(Oct 6, 2022)
12.0.1 (2022-10-06)

Bug Fixes

ensure devserver client options are configurable (#2034) (f1a0c21)

Source code(tar.gz)
Source code(zip)
v12.0.0(Sep 5, 2022)
12.0.0 (2022-09-05)

Features

Upgrade to Webpack 5 (#1996) (a460fcc), closes #1932

BREAKING CHANGES

Webpack 4 is no longer supported.

Source code(tar.gz)
Source code(zip)
v11.2.0(Jan 27, 2022)
11.2.0 (2022-01-27)

Features

Webpack 5 support (#1903) (92518df), closes #1703 #1864 #1740 #1822 #1786

Source code(tar.gz)
Source code(zip)
v11.1.8(Jan 10, 2022)
11.1.8 (2022-01-10)

Bug Fixes

Remove is-directory, use fs module directly (#1897) (77a2a2e)

Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.9(Jul 17, 2021)
fix: Move sucrase back to dependencies 05825f79

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.8...v12.0.0-alpha9.9
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.8(Jul 16, 2021)
Polyfill process for webpack 5 925b40de

Avoid errors about imports without extension in webpack 5 70a06179

Fix pagePerSection, improve types, simplify 13898771

Fix isolation for the first (index = 0) example faf749c3

Refactor inline Markdown 3dffa2e1

Source code(tar.gz)
Source code(zip)
v11.1.7(Jun 2, 2021)
11.1.7 (2021-06-02)

Bug Fixes

Bump ast-types version (#1823) (83a5de8), closes #1704

Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.7(May 26, 2021)
Use // to instead of / for target index in the URL to avoid conflicts d563606e

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.6...v12.0.0-alpha9.7
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.6(May 20, 2021)
Fix path to Storybook components 3cbe042b

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.5...v12.0.0-alpha9.6
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.5(May 18, 2021)
Add a shortcut for Storybook components e3cc6bb4

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.4...v12.0.0-alpha9.5
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.4(May 11, 2021)
Fix exampleMode d06cb34f

Isolation mode for CSF stories 2c9eade6

Correct unindentation of code examples 599b7557

Fix wrong cursor position in the editor when there’s a tab in the line d7455266

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.3...v12.0.0-alpha9.4
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.3(Apr 14, 2021)
:fire::fire::fire: Hot reload of CSF files :fire::fire::fire: f13de0ee

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.2...v12.0.0-alpha9.3
Source code(tar.gz)
Source code(zip)
v11.1.6(Mar 18, 2021)
11.1.6 (2021-03-18)

Bug Fixes

generate typings directly in lib instead of lib/src (#1756) (c3cd564)

Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.2(Mar 17, 2021)
Use @babel/parser to parse example code in loaders 7e9a6a22

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.1...v12.0.0-alpha9.2
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.1(Feb 26, 2021)
Update deps, initial TypeScript and ECMAScript Next support in CSF files c638814a

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9.0...v12.0.0-alpha9.1
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9.0(Feb 26, 2021)
Error handling for Story component b0cd03e6

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha9...v12.0.0-alpha9.0
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha9(Feb 23, 2021)
Support CSF stories exported in pascal case 4abad8a2

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha8...v12.0.0-alpha9
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha8(Feb 23, 2021)
Fix skipping current component imports, clearer names 7d91a03b

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha7...v12.0.0-alpha8
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha7(Feb 20, 2021)
Don't prepend the current component import if it's the only import b8df411f

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha6...v12.0.0-alpha7
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha6(Feb 19, 2021)
Ensure that we have a semicolon (;) at the end: we must put a semicolon in front of JSX in generated code 9de0dfaa

Make errors in examples more readable 90fef0dc

Support wildcard imports 2cb959b4

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha5...v12.0.0-alpha6
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha4(Jan 28, 2021)
Storybook stubs 59f91790

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha3...v12.0.0-alpha4
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha3(Jan 27, 2021)
CSF support, second attempt 66ae48c9

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha2...v12.0.0-alpha3
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha2(Jan 20, 2021)
Initial CSF support 995f5e33

https://github.com/styleguidist/react-styleguidist/compare/v12.0.0-alpha1...v12.0.0-alpha2
Source code(tar.gz)
Source code(zip)
v12.0.0-alpha1(Jan 11, 2021)

https://github.com/styleguidist/react-styleguidist/issues?q=is%3Aopen+is%3Aissue+milestone%3A%2212.0.0%3A+Customizable+compiler%22
Source code(tar.gz)
Source code(zip)
v11.1.5(Dec 4, 2020)
11.1.5 (2020-12-04)

Bug Fixes

Fix type description tooltip spacing in Firefox (#1724) (512091d), closes #1723

Source code(tar.gz)
Source code(zip)
v11.1.4(Nov 24, 2020)
11.1.4 (2020-11-24)

Bug Fixes

Fix dev server crash (#1718) (c39b42f), closes #1714 #1705

Paragraphs should use text font size from the theme (#1717) (9c2ca5b)

Source code(tar.gz)
Source code(zip)
v11.1.3(Nov 17, 2020)
11.1.3 (2020-11-17)

Bug Fixes

Fix links withpagePerSection (#1715) (3e2ff01), closes #1702

Source code(tar.gz)
Source code(zip)
v11.1.2(Nov 10, 2020)
11.1.2 (2020-11-10)

Bug Fixes

[CVE-2020-7753] Update remark to 13.0.0 (#1710) (2b7bfe2)

Source code(tar.gz)
Source code(zip)
v11.1.1(Oct 23, 2020)
11.1.1 (2020-10-23)

Bug Fixes

Add missing lang attribute on HTML element (85c627d), closes #879 #1668

Source code(tar.gz)
Source code(zip)