Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Latest commit

 

History

History
389 lines (198 loc) · 15.7 KB

CHANGELOG.md

File metadata and controls

389 lines (198 loc) · 15.7 KB

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

8.2.3 (2022-08-18)

Bug Fixes

  • typo in cjs index file template (6dd34a7)

8.2.2 (2022-08-18)

Bug Fixes

  • add index file to cjs build (bd39232)

8.2.1 (2022-08-18)

Bug Fixes

  • dual package extensions (261950f)

8.2.0 (2022-04-12)

Features

  • add CSS files to side effects in order to tree-shake CSS imports (37c973d)

8.1.3 (2022-03-03)

Bug Fixes

  • enable ssr in dev mode and revert cjs index change (d15c375)

8.1.2 (2022-02-25)

8.1.1 (2022-02-25)

Bug Fixes

  • conditional exports (bb0076b)
  • replicate across all formats (1c5e19e)

8.1.0 (2022-02-03)

Features

  • run build tasks in parallel (ddb49c8)

8.0.0 (2021-12-22)

⚠ BREAKING CHANGES

  • drop IE11 support
  • Add rollup support, update configs, and dependencies
  • add .nvmrc with Node 14

Features

  • add prettier config support (03d4fb1)

Bug Fixes

  • do not install husky in CI pipeline (316e14f)
  • only run eslint and test during prepublish script (f0c5ac7)
  • update husky config to match v7 (387d0b8)

Build System

  • add .nvmrc with Node 14 (3c51977)
  • Add rollup support, update configs, and dependencies (87d7b59)
  • drop IE11 support (3704937)
  • move bin and lib to root and remove build process for CRS itself (3ec932b)

7.1.0 (2021-09-28)

Features

  • add support for --legacy-peer-deps when installing dependencies (22ee588)

7.0.1 (2021-06-08)

Bug Fixes

  • add eval-source-map to styleguidist webpack config to fix source maps (a9c37aa)

7.0.0 (2021-03-30)

⚠ BREAKING CHANGES

  • default coverageThreshold is now 100, default testEnvironment is now jsdom, clearMocks is now enabled by default

Features

  • update inline-styles template (83bcd8c)
  • createStyleguideConfig: add ie11ModuleTransforms option (5cd3c73)
  • update default jest config (96f6f20)
  • update styled-components template (786c253)

6.0.0 (2020-09-08)

⚠ BREAKING CHANGES

Build System

  • update outdated dependencies including prettier@^2 (5a91140)

5.2.0 (2020-02-14)

Features

5.1.0 (2019-10-23)

Bug Fixes

  • deps: Add direct acorn@6 dependency to match transitive peer (c2c09ab)
  • Avoid passing empty objects repeatedly to root config.sections (4dc6599)
  • Correct math on depth tracking via env var (04c1a8e)
  • Inject newline after child styleguide logging only (024111d)
  • Resolve linked styleguide section globs relative to CWD, same as top-level styleguide (9fdc25c)

Features

  • styleguidist: Configure serverPort when process.env.PORT is set (2ac88b4)
  • Bump dependencies (a319b26)
  • webpack: Add IE11 support to styleguidist-generated website (9961967)
  • webpack: Always resolve singleton packages to the root (55cfa8f)
  • webpack: Check for circular dependencies in local styleguide components (da4d70b)
  • Make createStyleguideConfig DEBUG output fancier (b48bf58)

Tests

  • Add fixture-based tests of section config generation (eee0c68)

5.0.0 (2019-07-03)

Bug Fixes

  • correctly interpret the --stable flag as a boolean (556b5a0)

Build System

Features

  • allow passing flags to npm scripts with -- (6e5b505)
  • update stable dependencies when bootstrapping a new project (a6e0c34)

BREAKING CHANGES

4.0.6 (2019-06-24)

Build System

  • npm: update outdated npm dependencies (acfed01)

4.0.5 (2019-06-18)

Build System

  • npm: update outdated npm dependencies (e507c16)

4.0.4 (2019-05-14)

Build System

  • npm: update outdated npm dependencies (5f98e7e)

4.0.3 (2019-04-08)

Bug Fixes

  • correctly resolve paths when sections defines an array of components globs (04e1ed9)

4.0.2 (2019-04-08)

4.0.1 (2019-04-08)

Bug Fixes

  • do not link the styleguides of a linked styleguide (ea42ea8)

4.0.0 (2019-04-05)

Migrating to 4.x

  • Update your markdown examples for the 9.x release of react-styleguidist: https://github.com/styleguidist/react-styleguidist/releases/tag/v9.0.0
  • Move the styleguidist folder into src (clean up referenced paths)
    • The babel configuration has been simplified such that there is no longer a separate include path for the styleguidist folder.
  • Move styleguides configuration option from crs.config.js to styleguide.config.js, and delete the crs.config.js file
    • crs.config.js has been removed in favor of API options on createStyleguideConfig.
  • Move STYLEGUIDE.md to a docs folder at the root of the project and add sections configuration to styleguide.config.js
    • The behavior around STYLEGUIDE.md was a little too magical. 4.x now supports your own sections configuration in styleguide.config.js, so we should leverage React Styleguidist customization options directly. Read more about sections configuration here: https://react-styleguidist.js.org/docs/components.html#sections
  • Remove "STYLEGUIDE.md" from the files array of package.json and add "docs" and "styleguide.config.js"
    • Published libraries need to include the docs folder and styleguide.config.js in order to be linked in other libraries
  • Add setupFilesAfterEnv: ['<rootDir>/jest.setup.js'] to your jest.config.js
    • The jest.setup.js file is not a built-in feature of jest, and was a little too magical. If you want to continue to use this convention, you can add the configuration to your own config.
  • Update babel-preset-zillow to latest and remove any configuration for babel-plugin-styled-components
    • babel-preset-zillow now includes babel-plugin-styled-components by default.

Bug Fixes

  • update stable versions of eslint-plugin-zillow and babel-preset-zillow (2be7b6c)

build

  • update project dependency, including a major bump of react-styleguidist (0361ba3)

Features

  • createJestConfig now accepts a config object as its only argument which will be shallowly merged with its own config (657a347)
  • createStyleguideConfig now supports custom sections (c306725)
  • update template generation for new configuration APIs (1f585fc)

BREAKING CHANGES

  • [email protected] has breaking changes to how examples are loaded, read more here: https://github.com/styleguidist/react-styleguidist/releases/tag/v9.0.0. Also note, react-styleguidist is hard pinned to 9.0.4 due to the following issue: styleguidist/react-styleguidist#1321.
  • crs.config.js has been removed in favor of passing options directly to createStyleguideConfig. createStyleguideConfig now takes two params, the first is a config object that will be shallowly merged, the second is an options object that takes the old styleguides option for the removed crs.config.js. A few other options have been added for customizing how sections are displayed, and this also works with the DEBUG=true environmental variable.

3.1.1 (2019-03-25)

Bug Fixes

  • narrow "components" subdirectory change to only the styleguidist folder (d60a644)

3.1.0 (2019-03-25)

Features

  • update component glob to support component subdirectories and other file extensions (b4dfbee)

3.0.1 (2019-03-14)

Bug Fixes

  • jest: Migrate setup to new config field (57a4c59)
  • convert jest config into function declaration (3d87118)

3.0.0 (2019-01-30)

Bug Fixes

  • linked styleguides will now run with the project's babel config (b1e21bb)

build

  • update project dependencies (bc7998e)

Features

  • add crs.config.js and STYLEGUIDE.md template files for ease-of-use/discoverability (b282765)
  • ask for author and homepage when bootstrapping a new project (3362f52)

BREAKING CHANGES

  • Update to Jest 24

2.0.0 (2018-11-12)

Major changes

  • Update to babel 7
  • Swap enzyme for react-test-renderer in test template
  • Drop support for bootstrapping with emotion styles

Migration notes for existing projects

  • Install the latest babel preset

    npm i babel-preset-zillow@latest

  • Install the latest eslint plugin

    npm i eslint-plugin-zillow@latest

  • Update .eslintrc

    {
+  "extends": ["plugin:zillow/recommended", "plugin:zillow/jest"]
-  "extends": "plugin:zillow/recommended",
-  "overrides": [{
-    "files": [ "**/*.test.js"],
-    "env": {
-      "jest": true,
-      "jest/globals": true
-    },
-    "plugins": ["jest"]
-  }]
}