npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

styled-components-codemods

v1.1.0

Published

Automatic codemods to upgrade your styled-components code to newer versions.

Downloads

7

Readme

styled-components-codemods

Automatic codemods to upgrade your styled-components code to newer versions.

Installation

Thanks to npx no installation is needed, just run the command below!

Usage

Usage: npx styled-components-codemods [options] [command]

Options:

  -V, --version                                  output the version number
  -h, --help                                     output usage information

Commands:

  v4 [...files]                                  Run all v4 codemods
  v4-extendToStyled [...files]                   Run just the extendToStyled codemod
  v4-injectGlobalToCreateGlobalStyle [...files]  Run just the injectGlobalToCreateGlobalStyle codemod

Examples:

  $ styled-components-codemods v4-extendToStyled src/components/Box.js src/components/Button.js
  $ styled-components-codemods v4 src/**/*.js (this will only work if your terminal expands globs)

Codemods

v4

In version 4 of styled-components the Component.extends API will be removed in favor of only using styled(Component). This codemod replaces all .extends calls to equivalent styled() calls instead. Furthermore, the injectGlobal API has been upgraded to slot into React's lifecycle more naturally. It refactors all injectGlobal calls, and warns you where they are, so you can export them and include them when rendering.

Limitations

There is no way to distinguish whether .extend identifier is related to styled-components or any other library/prototype etc. If you know that there is another .extend function in your project that is not related to styled-components be aware and revert these instances manually.

Be aware that .extend used in combination with .withComponent can give you a different result than styled(WithComponentedComponent). Refer to this issue to understand the difference.

Example
StyledComponent.extend``;

StyledComponent.extend`
  color: red;
`;

StyledComponent.extend({ color: "red" });

StyledComponent.extend;

StyledComponent.extend``.extend;

StyledComponent.extend({ color: red }).extend;

styled.div``.extend``;

styled.div`
  color: red;
`.extend`color: blue;`;

styled.div({ color: "red" }).extend({ color: "blue" });

StyledComponent.withComponent("div").extend``;

StyledComponent.withComponent("div").extend`color: red;`;

StyledComponent.withComponent("div").extend();

StyledComponent.withComponent("div").extend({ color: red });

StyledComponent.extend()
  .extend()
  .extend().extend``;

StyledComponent.extend``.extend().extend``.extend``;
import styled, { css } from "styled-components";

styled(StyledComponent)``;

styled(StyledComponent)`
  color: red;
`;

styled(StyledComponent)({ color: "red" });

styled(StyledComponent);

styled(styled(StyledComponent)``);

styled(styled(StyledComponent)({ color: red }));

styled(styled.div``)``;

styled(
  styled.div`
    color: red;
  `
)`
  color: blue;
`;

styled(styled.div({ color: "red" }))({ color: "blue" });

styled(StyledComponent.withComponent("div"))``;

styled(StyledComponent.withComponent("div"))`
  color: red;
`;

styled(StyledComponent.withComponent("div"))();

styled(StyledComponent.withComponent("div"))({ color: red });

styled(styled(styled(styled(StyledComponent)())())())``;

styled(styled(styled(styled(StyledComponent)``)())``)``;