npmpackage.info

Gathering detailed insights and metrics for @quickbaseoss/babel-plugin-styled-components-css-namespace

Other packages similar to @quickbaseoss/babel-plugin-styled-components-css-namespace

styled-jsx

5.1.6

Full CSS support for JSX without compromises

babel-plugin-styled-components

2.1.4

Improve the debugging experience and add server-side rendering support to styled-components

@emotion/babel-plugin

11.13.5

A recommended babel preprocessing plugin for emotion, The Next Generation of CSS-in-JS.

@babel/plugin-transform-export-namespace-from

7.25.9

Compile export namespace to ES2015

Gathering detailed insights and metrics for @quickbaseoss/babel-plugin-styled-components-css-namespace

@quickbaseoss/babel-plugin-styled-components-css-namespace

A babel plugin to add css namespaces (and increase specificity) of styled-component classes.

1.0.1

118

MIT

JavaScript

2,512,016 3.2

Installations

npm install @quickbaseoss/babel-plugin-styled-components-css-namespace

Score

Supply Chain

88.2

Quality

74.6

Maintenance

Vulnerability

99.6

License

Pull Requests

Open

19

Total

62

Closed

8

Merged

35

Issues

Open

20

Total

37

Closed

17

Releases

Unable to fetch releases

Developer

QuickBase

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=8.0.0

Typescript Support

No

Node Version

12.18.0

NPM Version

6.14.4 Statistics

118 Stars

58 Commits

32 Forks

28 Watching

17 Branches

14 Contributors

Updated on 04 Jul 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

2,512,016

Last day

10.3%

962

Compared to previous day

Last week

4.3%

5,477

Compared to previous week

Last month

-4.1%

22,445

Compared to previous month

Last year

2.4%

508,422

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

@quickbaseoss/babel-plugin-styled-components-css-namespace

Getting Started

Add the plugin with yarn add @quickbaseoss/babel-plugin-styled-components-css-namespace or npm install @quickbaseoss/babel-plugin-styled-components-css-namespace
Include the plugin in your babel configuration.

1"babel": {
2  "plugins": [
3    "@quickbaseoss/babel-plugin-styled-components-css-namespace"
4  ]
5}

If you are also using babel-plugin-styled-components, you must place styled-components-css-namespace before babel-plugin-styled-components.

1"babel": {
2  "plugins": [
3    "@quickbaseoss/babel-plugin-styled-components-css-namespace",
4    "babel-plugin-styled-components"
5  ]
6}

Options

Default

Without adding options, this plugin will duplicate the class name generated by styled-components as suggested in this issue.

1/* output */
2.c0.c0 {
3  background-color: blue;
4}

Increasing Specificity

A common scenario when integrating styled-components into existing projects is fighting against extremely specific legacy CSS selectors such as #someId .grossly .nested section input {/* styles */}.

To increase the specificity that this plugin adds, you can leverage the recommended approach from the styled-components docs. Add the appropriate number of & selectors equal to the desired selector duplication as the cssNamespace option (the default behavior is x2 {"cssNamespace": "&&"}).

1{
2  "plugins": [
3    [
4      "@quickbaseoss/babel-plugin-styled-components-css-namespace",
5      {"cssNamespace": "&&&"}
6    ],
7    "babel-plugin-styled-components"
8  ]
9}

1/* output */
2.c0.c0.c0 {
3  background-color: blue;
4}

Custom Namespace

You can provide a cssNamespace to use instead of duplicating the class name. Remember to include a DOM element with that class that wraps the styled-component. The cssNamespace takes the form of the selector you want to use to wrap all of your styles with.

1"babel": {
2  "plugins": [
3    ["@quickbaseoss/babel-plugin-styled-components-css-namespace", {"cssNamespace": ".specific .moreSpecific .reallySpecific"}],
4    "styled-components"
5  ]
6}

1/* output */
2.specific .moreSpecific .reallySpecific .c0 {
3  background-color: blue;
4}

where .c0 is the class added by styled-components to the element

Notes

Media Query String Interpolation

While an uncommon use-case, it can often be useful to interpolate media query at-rules in your css template string. Compared to the method for creating media queries from the styled-component docs, this method reduces the overhead of multiple calls of css while still allowing queries to be constructed without requiring nested template literals.

1const mediaQuery = '@media only screen and (min-width: 426px)'
2
3const StyledComponent = styled.div`
4  background-color: red;
5  ${mediaQuery} {
6    background-color: blue;
7  }
8`

Unfortunately, this syntax is identical to the syntax used to refer to other components and this plugin cannot distinguish between the two and will produce broken CSS rules. Since referring to other components is more common, the below method of formatting @media inline can be used as a workaround.

1const mediaQuery = 'only screen and (min-width: 426px)';
2
3const StyledComponent = styled.div`
4  background-color: red;
5  @media ${mediaQuery} {
6    background-color: blue;
7  }
8`;

Upgrade to version 1.0.0

Note that rawCssNamespace was dropped in favor of the single cssNamespace option. Additionally, support for an array of selectors was dropped as well. Update any references to rawCssNamespace with cssNamespace.

If you were already using cssNamespace, update your configuration to use a css selector rather than an array of classes. E.g., cssNamespace: 'moreSpecific' should be cssNamespace: '.moreSpecific' and cssNamespace: ['specific', 'verySpecific'] should be cssNamespace: '.specific .verySpecific'.

The Problem

styled-components is an awesome library for css-in-js and feels like a natural combination of React and CSS. It is easy to use and produces css instead of inline styles.

However, if you are trying to gradually introduce styled-components into a legacy website that might not have the best CSS, the legacy styles may bleed into your styled-components because they have more specificity than the single class styled-components.

The Solution

This plugin will automatically add additional css namespaces or duplicated classes to the selectors produced by styled components effectively creating a wall between the legacy css code and your new shiny styled components.

monty-python-castle

Styling frameworks

This plugin was built for Styled Components; however, since initially creating it, we at Quick Base have switched to Emotion. It works as an alternative to the stylis extra scope plugin which requires creating your own instance of stylis.

Developing

Clone the repo with git clone https://github.com/QuickBase/babel-plugin-styled-components-css-namespace.git
yarn install (prefer yarn although npm should work as well)
yarn test to run the tests

Publishing

When we are ready to release a new version, one of the admins needs to run the following commands to publish the new version to npm. We probably need to invest in a better deploy and semver management system. Interested? See this issue.

If needed, open a new PR to update the version in the package.json
Copy the commit hash from the commit log
Run git tag -a {version} {commit_hash}. For example: git tag -a 0.0.9 abf3123
In the editor, add a message about the changes in this version and save
Push the tag to GitHub with git push --follow-tags
Travis CI will build and publish the new version to npm

Acknowledgements

Open source software is a group effort. This version of the plugin was heavily inspired by a fork of the original plugin from @TrevorBurnham.

We also would like to thank some of our contributors who helped solve some tough issues with the previous iteration of this plugin:

@daniloster
@dan-kez
@prevostc
@danielhusar

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

55 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-6fw4-hr69-g3rv
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-3f95-r44v-8mrg
Warn: Project is vulnerable to: GHSA-28xr-mwxg-3qc8
Warn: Project is vulnerable to: GHSA-9p95-fxvg-qgq2
Warn: Project is vulnerable to: GHSA-9w5j-4mwv-2wj8
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

3.2

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @quickbaseoss/babel-plugin-styled-components-css-namespace

Other packages similar to @quickbaseoss/babel-plugin-styled-components-css-namespace

@quickbaseoss/babel-plugin-styled-components-css-namespace

Installations

Score

Pull Requests

19

62

8

35

Issues

20

37

17

Releases

Unable to fetch releases

Developer

QuickBase

Developer Guide

CommonJS

>=8.0.0

No

12.18.0

6.14.4

Statistics

Languages

Total Downloads

2,512,016

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

@quickbaseoss/babel-plugin-styled-components-css-namespace

Getting Started

Options

Default

Increasing Specificity

Custom Namespace

Notes

Media Query String Interpolation

Upgrade to version 1.0.0

The Problem

The Solution

Styling frameworks

Developing

Publishing

Acknowledgements

10

10

8

0

0

0

0

0

0

3.2

/10