Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated markers.ts to employ the '⚡️' prefix for component styles, enhancing consistency with the Qwik Framework. #7247

Closed
wants to merge 2 commits into from
Closed

Updated markers.ts to employ the '⚡️' prefix for component styles, enhancing consistency with the Qwik Framework. #7247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f99562
Update scoped-stylesheet.unit.ts
sreeisalso Jan 12, 2025
f56c2f8
Update markers.ts
sreeisalso Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 83 additions & 82 deletions packages/qwik/src/core/style/scoped-stylesheet.unit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,117 +1,118 @@
import { assert, test } from 'vitest';
import { scopeStylesheet } from './scoped-stylesheet';
import { ComponentStylesPrefixContent as prefix } from 'packages/qwik/src/core/util/markers';

test('selectors', () => {
assert.equal(scopeStylesheet('div {}', '_'), 'div.⭐️_ {}');
assert.equal(scopeStylesheet('div {}div{} div {}', '_'), 'div.⭐️_ {}div.⭐️_{} div.⭐️_ {}');
assert.equal(scopeStylesheet('div, p {}', '_'), 'div.⭐️_, p.⭐️_ {}');
assert.equal(scopeStylesheet('div {}', '_'), `div.${prefix}_ {}`);
assert.equal(scopeStylesheet('div {}div{} div {}', '_'), `div.${prefix}_ {}div.${prefix}_{} div.${prefix}_ {}`);
assert.equal(scopeStylesheet('div, p {}', '_'), `div.${prefix}_, p.${prefix}_ {}`);

assert.equal(scopeStylesheet('div p {}', '_'), 'div.⭐️_ p.⭐️_ {}');
assert.equal(scopeStylesheet('div > p {}', '_'), 'div.⭐️_ > p.⭐️_ {}');
assert.equal(scopeStylesheet('div + p {}', '_'), 'div.⭐️_ + p.⭐️_ {}');
assert.equal(scopeStylesheet('div ~ p {}', '_'), 'div.⭐️_ ~ p.⭐️_ {}');
assert.equal(scopeStylesheet('div p {}', '_'), `div.${prefix}_ p.${prefix}_ {}`);
assert.equal(scopeStylesheet('div > p {}', '_'), `div.${prefix}_ > p.${prefix}_ {}`);
assert.equal(scopeStylesheet('div + p {}', '_'), `div.${prefix}_ + p.${prefix}_ {}`);
assert.equal(scopeStylesheet('div ~ p {}', '_'), `div.${prefix}_ ~ p.${prefix}_ {}`);

assert.equal(scopeStylesheet('.red {}', '_'), '.red.⭐️_ {}');
assert.equal(scopeStylesheet('div.red {}', '_'), 'div.red.⭐️_ {}');
assert.equal(scopeStylesheet('.red {}', '_'), `.red.${prefix}_ {}`);
assert.equal(scopeStylesheet('div.red {}', '_'), `div.red.${prefix}_ {}`);
});
test('unicode', () => {
assert.equal(scopeStylesheet('.miško{}', '_'), '.miško.⭐️_{}');
assert.equal(scopeStylesheet('.miško{}', '_'), `.miško.${prefix}_{}`);
});
test('selectors with *', () => {
assert.equal(scopeStylesheet('* {}', '_'), '.⭐️_ {}');
assert.equal(scopeStylesheet('.red * {}', '_'), '.red.⭐️_ .⭐️_ {}');
assert.equal(scopeStylesheet('#red * {}', '_'), '#red.⭐️_ .⭐️_ {}');
assert.equal(scopeStylesheet('* {}', '_'), `.${prefix}_ {}`);
assert.equal(scopeStylesheet('.red * {}', '_'), `.red.${prefix}_ .${prefix}_ {}`);
assert.equal(scopeStylesheet('#red * {}', '_'), `#red.${prefix}_ .${prefix}_ {}`);
});

test('selectors with chains', () => {
assert.equal(scopeStylesheet('.red.text {}', '_'), '.red.text.⭐️_ {}');
assert.equal(scopeStylesheet('.red.text {}', '_'), `.red.text.${prefix}_ {}`);

assert.equal(scopeStylesheet('#red {}', '_'), '#red.⭐️_ {}');
assert.equal(scopeStylesheet('div#red {}', '_'), 'div#red.⭐️_ {}');
assert.equal(scopeStylesheet('#red {}', '_'), `#red.${prefix}_ {}`);
assert.equal(scopeStylesheet('div#red {}', '_'), `div#red.${prefix}_ {}`);

assert.equal(scopeStylesheet('div { }', '_'), 'div.⭐️_ { }');
assert.equal(scopeStylesheet('div {}', '_'), 'div.⭐️_ {}');
assert.equal(scopeStylesheet('div { }', '_'), `div.${prefix}_ { }`);
assert.equal(scopeStylesheet('div {}', '_'), `div.${prefix}_ {}`);
assert.equal(
scopeStylesheet('div {background-color: blue; }', '_'),
'div.⭐️_ {background-color: blue; }'
`div.${prefix}_ {background-color: blue; }`
);
assert.equal(
scopeStylesheet('div { color: red !important; }', '_'),
'div.⭐️_ { color: red !important; }'
`div.${prefix}_ { color: red !important; }`
);
assert.equal(scopeStylesheet('div{color:red;}', '_'), 'div.⭐️_{color:red;}');
assert.equal(scopeStylesheet('div { content: "}"; }', '_'), 'div.⭐️_ { content: "}"; }');
assert.equal(scopeStylesheet("div { content: '}'; }", '_'), "div.⭐️_ { content: '}'; }");
assert.equal(scopeStylesheet('div{color:red;}', '_'), `div.${prefix}_{color:red;}`);
assert.equal(scopeStylesheet('div { content: "}"; }', '_'), `div.${prefix}_ { content: "}"; }`);
assert.equal(scopeStylesheet("div { content: '}'; }", '_'), `div.${prefix}_ { content: '}'; }`);
});

test('attribute selectors', () => {
assert.equal(scopeStylesheet('*[a]{}', '_'), '[a].⭐️_{}');
assert.equal(scopeStylesheet('*[a] {}', '_'), '[a].⭐️_ {}');
assert.equal(scopeStylesheet('*[target] span {}', '_'), '[target].⭐️_ span.⭐️_ {}');

assert.equal(scopeStylesheet('a[target] {}', '_'), 'a[target].⭐️_ {}');
assert.equal(scopeStylesheet('a[target="_blank"] {}', '_'), 'a[target="_blank"].⭐️_ {}');
assert.equal(scopeStylesheet('input[type="button"] {}', '_'), 'input[type="button"].⭐️_ {}');

assert.equal(scopeStylesheet('a[title~="red"] {}', '_'), 'a[title~="red"].⭐️_ {}');
assert.equal(scopeStylesheet('a[class^="red"] {}', '_'), 'a[class^="red"].⭐️_ {}');
assert.equal(scopeStylesheet('a[class|="red"] {}', '_'), 'a[class|="red"].⭐️_ {}');
assert.equal(scopeStylesheet('a[class*="red"] {}', '_'), 'a[class*="red"].⭐️_ {}');
assert.equal(scopeStylesheet('a[class$="red"] {}', '_'), 'a[class$="red"].⭐️_ {}');
assert.equal(scopeStylesheet('*[a]{}', '_'), `[a].${prefix}_{}`);
assert.equal(scopeStylesheet('*[a] {}', '_'), `[a].${prefix}_ {}`);
assert.equal(scopeStylesheet('*[target] span {}', '_'), `[target].${prefix}_ span.${prefix}_ {}`);

assert.equal(scopeStylesheet('a[target] {}', '_'), `a[target].${prefix}_ {}`);
assert.equal(scopeStylesheet('a[target="_blank"] {}', '_'), `a[target="_blank"].${prefix}_ {}`);
assert.equal(scopeStylesheet('input[type="button"] {}', '_'), `input[type="button"].${prefix}_ {}`);

assert.equal(scopeStylesheet('a[title~="red"] {}', '_'), `a[title~="red"].${prefix}_ {}`);
assert.equal(scopeStylesheet('a[class^="red"] {}', '_'), `a[class^="red"].${prefix}_ {}`);
assert.equal(scopeStylesheet('a[class|="red"] {}', '_'), `a[class|="red"].${prefix}_ {}`);
assert.equal(scopeStylesheet('a[class*="red"] {}', '_'), `a[class*="red"].${prefix}_ {}`);
assert.equal(scopeStylesheet('a[class$="red"] {}', '_'), `a[class$="red"].${prefix}_ {}`);
});

test('pseudo classes', () => {
assert.equal(scopeStylesheet('p:lang(en) {}', '_'), 'p:lang(en).⭐️_ {}');
assert.equal(scopeStylesheet('a:link {}', '_'), 'a:link.⭐️_ {}');
assert.equal(scopeStylesheet('p:nth-child(2) {}', '_'), 'p:nth-child(2).⭐️_ {}');
assert.equal(scopeStylesheet('p:nth-child(3n+1) {}', '_'), 'p:nth-child(3n+1).⭐️_ {}');
assert.equal(scopeStylesheet('p:lang(en) {}', '_'), `p:lang(en).${prefix}_ {}`);
assert.equal(scopeStylesheet('a:link {}', '_'), `a:link.${prefix}_ {}`);
assert.equal(scopeStylesheet('p:nth-child(2) {}', '_'), `p:nth-child(2).${prefix}_ {}`);
assert.equal(scopeStylesheet('p:nth-child(3n+1) {}', '_'), `p:nth-child(3n+1).${prefix}_ {}`);
});
test('pseudo classes without selector', () => {
assert.equal(scopeStylesheet(':root {}', '_'), ':root.⭐️_ {}');
assert.equal(scopeStylesheet(':root {}', '_'), `:root.${prefix}_ {}`);
});
test('pseudo selector with negation', () => {
assert.equal(scopeStylesheet('p:not(.blue) {}', '_'), 'p:not(.blue.⭐️_).⭐️_ {}');
assert.equal(scopeStylesheet('p:not(.blue) {}', '_'), `p:not(.blue.${prefix}_).${prefix}_ {}`);
});
test('pseudo selector with :nth', () => {
assert.equal(
scopeStylesheet('p:nth-child(3n+1):hover {}', '_'),
'p:nth-child(3n+1):hover.⭐️_ {}'
`p:nth-child(3n+1):hover.${prefix}_ {}`
);
assert.equal(
scopeStylesheet('p:nth-child(3n+1) div {}', '_'),
'p:nth-child(3n+1).⭐️_ div.⭐️_ {}'
`p:nth-child(3n+1).${prefix}_ div.${prefix}_ {}`
);
});

test('pseudo elements', () => {
assert.equal(scopeStylesheet('::selection {}', '_'), '.⭐️_::selection {}');
assert.equal(scopeStylesheet(' ::space {}', '_'), ' .⭐️_::space {}');
assert.equal(scopeStylesheet('::selection {}', '_'), `.${prefix}_::selection {}`);
assert.equal(scopeStylesheet(' ::space {}', '_'), ` .${prefix}_::space {}`);

assert.equal(scopeStylesheet('a::before {}', '_'), 'a.⭐️_::before {}');
assert.equal(scopeStylesheet('a::after {}', '_'), 'a.⭐️_::after {}');
assert.equal(scopeStylesheet('a::before {}', '_'), `a.${prefix}_::before {}`);
assert.equal(scopeStylesheet('a::after {}', '_'), `a.${prefix}_::after {}`);

assert.equal(scopeStylesheet('a::first-line {}', '_'), 'a.⭐️_::first-line {}');
assert.equal(scopeStylesheet('a::first-line {}', '_'), `a.${prefix}_::first-line {}`);

assert.equal(scopeStylesheet('a.red::before {}', '_'), 'a.red.⭐️_::before {}');
assert.equal(scopeStylesheet('a.red span::before {}', '_'), 'a.red.⭐️_ span.⭐️_::before {}');
assert.equal(scopeStylesheet('a.red::before {}', '_'), `a.red.${prefix}_::before {}`);
assert.equal(scopeStylesheet('a.red span::before {}', '_'), `a.red.${prefix}_ span.${prefix}_::before {}`);
['before', 'after', 'first-letter', 'first-line'].forEach((selector) => {
assert.equal(scopeStylesheet(`:${selector} {}`, '_'), `.⭐️_:${selector} {}`);
assert.equal(scopeStylesheet(`a:${selector} {}`, '_'), `a.⭐️_:${selector} {}`);
assert.equal(scopeStylesheet(`:${selector} {}`, '_'), `.${prefix}_:${selector} {}`);
assert.equal(scopeStylesheet(`a:${selector} {}`, '_'), `a.${prefix}_:${selector} {}`);
});
});

test('complex properties', () => {
assert.equal(
scopeStylesheet('div { background: #D0E4F5 url("./bg.jpg") no-repeat scroll 0 0; }', '_'),
'div.⭐️_ { background: #D0E4F5 url("./bg.jpg") no-repeat scroll 0 0; }'
`div.${prefix}_ { background: #D0E4F5 url("./bg.jpg") no-repeat scroll 0 0; }`
);

assert.equal(
scopeStylesheet(
'div { background: -webkit-linear-gradient(left, #1C6EA4 0%, #2388CB 50%, #144E75 100%); }',
'_'
),
'div.⭐️_ { background: -webkit-linear-gradient(left, #1C6EA4 0%, #2388CB 50%, #144E75 100%); }'
`div.${prefix}_ { background: -webkit-linear-gradient(left, #1C6EA4 0%, #2388CB 50%, #144E75 100%); }`
);
});

Expand All @@ -127,11 +128,11 @@ test('@keyframe', () => {
});

test('animation-name', () => {
assert.equal(scopeStylesheet('p{animation-name: x}', '_'), 'p.⭐️_{animation-name: x}');
assert.equal(scopeStylesheet('p{animation-name: x}', '_'), `p.${prefix}_{animation-name: x}`);
});

test('animation', () => {
assert.equal(scopeStylesheet('p{animation: a b c }', '_'), 'p.⭐️_{animation: a b c }');
assert.equal(scopeStylesheet('p{animation: a b c }', '_'), `p.${prefix}_{animation: a b c }`);
});

test('@font-face', () => {
Expand All @@ -147,14 +148,14 @@ test('@font-face', () => {
test('@media', () => {
assert.equal(
scopeStylesheet('@media screen and (min-width: 900px) { div {} }', '_'),
'@media screen and (min-width: 900px) { div.⭐️_ {} }'
`@media screen and (min-width: 900px) { div.${prefix}_ {} }`
);
});

test('@container', () => {
assert.equal(
scopeStylesheet('@container (min-width: 1px) { div {} span {} }', '_'),
'@container (min-width: 1px) { div.⭐️_ {} span.⭐️_ {} }'
`@container (min-width: 1px) { div.${prefix}_ {} span.${prefix}_ {} }`
);
});

Expand All @@ -164,62 +165,62 @@ test('@supports', () => {
'@supports (display: flex) { @media screen and (min-width: 900px) { div {} } }',
'_'
),
'@supports (display: flex) { @media screen and (min-width: 900px) { div.⭐️_ {} } }'
`@supports (display: flex) { @media screen and (min-width: 900px) { div.${prefix}_ {} } }`
);
});

test('@supports nested', () => {
assert.equal(scopeStylesheet('@media screen(a:1){}div{}', '_'), '@media screen(a:1){}div.⭐️_{}');
assert.equal(scopeStylesheet('@media screen(a:1){}div{}', '_'), `@media screen(a:1){}div.${prefix}_{}`);

assert.equal(
scopeStylesheet('@supports(d:b){div{}@media screen(a:1){div{}}div{}}', '_'),
'@supports(d:b){div.⭐️_{}@media screen(a:1){div.⭐️_{}}div.⭐️_{}}'
`@supports(d:b){div.${prefix}_{}@media screen(a:1){div.${prefix}_{}}div.${prefix}_{}}`
);

assert.equal(
scopeStylesheet('@supports not (not (transform-origin: 2px)) { div {} }', '_'),
'@supports not (not (transform-origin: 2px)) { div.⭐️_ {} }'
`@supports not (not (transform-origin: 2px)) { div.${prefix}_ {} }`
);
assert.equal(
scopeStylesheet('@supports (display: grid) and (not (display: inline-grid)) { div {} }', '_'),
'@supports (display: grid) and (not (display: inline-grid)) { div.⭐️_ {} }'
`@supports (display: grid) and (not (display: inline-grid)) { div.${prefix}_ {} }`
);

assert.equal(
scopeStylesheet(
'@supports ((perspective: 10px) or (-moz-perspective: 10px) or (-webkit-perspective: 10px) or (-ms-perspective: 10px) or (-o-perspective: 10px)) { div {} }',
'_'
),
'@supports ((perspective: 10px) or (-moz-perspective: 10px) or (-webkit-perspective: 10px) or (-ms-perspective: 10px) or (-o-perspective: 10px)) { div.⭐️_ {} }'
`@supports ((perspective: 10px) or (-moz-perspective: 10px) or (-webkit-perspective: 10px) or (-ms-perspective: 10px) or (-o-perspective: 10px)) { div.${prefix}_ {} }`
);
});

test('comments', () => {
assert.equal(scopeStylesheet('div {} /* comment */', '_'), 'div.⭐️_ {} /* comment */');
assert.equal(scopeStylesheet('div { /**/ }', '_'), 'div.⭐️_ { /**/ }');
assert.equal(scopeStylesheet('div /* comment */ {}', '_'), 'div.⭐️_ /* comment */ {}');
assert.equal(scopeStylesheet('div/* comment */ {}', '_'), 'div.⭐️_/* comment */ {}');
assert.equal(scopeStylesheet('/* comment */div {}', '_'), '/* comment */div.⭐️_ {}');
assert.equal(scopeStylesheet('div {} /* comment */', '_'), `div.${prefix}_ {} /* comment */`);
assert.equal(scopeStylesheet('div { /**/ }', '_'), `div.${prefix}_ { /**/ }`);
assert.equal(scopeStylesheet('div /* comment */ {}', '_'), `div.${prefix}_ /* comment */ {}`);
assert.equal(scopeStylesheet('div/* comment */ {}', '_'), `div.${prefix}_/* comment */ {}`);
assert.equal(scopeStylesheet('/* comment */div {}', '_'), `/* comment */div.${prefix}_ {}`);
assert.equal(
scopeStylesheet('div /* comment */ > span {}', '_'),
'div.⭐️_ /* comment */ > span.⭐️_ {}'
`div.${prefix}_ /* comment */ > span.${prefix}_ {}`
);
});

test('global selector', () => {
assert.equal(scopeStylesheet(':global(*) {}', '_'), '* {}');
});
test('global selector with attribute', () => {
assert.equal(scopeStylesheet(':global([t="("]) {}', '_'), '[t="("] {}');
assert.equal(scopeStylesheet(':global([t="("]) {}', '_'), `[t="("] {}`);

assert.equal(scopeStylesheet(':global(div) {}', '_'), 'div {}');
assert.equal(scopeStylesheet(':global(div), p {}', '_'), 'div, p.⭐️_ {}');
assert.equal(scopeStylesheet(':global(div), p {}', '_'), `div, p.${prefix}_ {}`);

assert.equal(scopeStylesheet('div :global(p) {}', '_'), 'div.⭐️_ p {}');
assert.equal(scopeStylesheet(':global(div) > p {}', '_'), 'div > p.⭐️_ {}');
assert.equal(scopeStylesheet('div :global(p) {}', '_'), `div.${prefix}_ p {}`);
assert.equal(scopeStylesheet(':global(div) > p {}', '_'), `div > p.${prefix}_ {}`);

assert.equal(scopeStylesheet(':global(.red) {}', '_'), '.red {}');
assert.equal(scopeStylesheet(':global(div).red {}', '_'), 'div.red.⭐️_ {}');
assert.equal(scopeStylesheet(':global(div).red {}', '_'), `div.red.${prefix}_ {}`);
assert.equal(scopeStylesheet(':global(div.red) {}', '_'), 'div.red {}');

assert.equal(scopeStylesheet(':global(#red) {}', '_'), '#red {}');
Expand All @@ -229,10 +230,10 @@ test('global selector with attribute', () => {
assert.equal(scopeStylesheet(':global(div){color:red;}', '_'), 'div{color:red;}');

assert.equal(scopeStylesheet(':global(*[target]) {}', '_'), '*[target] {}');
assert.equal(scopeStylesheet(':global(*[target]) span {}', '_'), '*[target] span.⭐️_ {}');
assert.equal(scopeStylesheet('*[target] :global(span) {}', '_'), '[target].⭐️_ span {}');
assert.equal(scopeStylesheet(':global(*[target]) span {}', '_'), `*[target] span.${prefix}_ {}`);
assert.equal(scopeStylesheet('*[target] :global(span) {}', '_'), `[target].${prefix}_ span {}`);

assert.equal(scopeStylesheet(':global(a):link {}', '_'), 'a:link.⭐️_ {}');
assert.equal(scopeStylesheet(':global(a):link {}', '_'), `a:link.${prefix}_ {}`);
assert.equal(scopeStylesheet(':global(a:link) {}', '_'), 'a:link {}');
assert.equal(scopeStylesheet(':global(p:lang(en)) {}', '_'), 'p:lang(en) {}');
assert.equal(scopeStylesheet(':global(p:nth-child(2)) {}', '_'), 'p:nth-child(2) {}');
Expand All @@ -241,7 +242,7 @@ test('global selector with attribute', () => {
});

test('nested global inside not', () => {
assert.equal(scopeStylesheet('p:not(:global(.red)){}', '_'), 'p:not(.red).⭐️_{}');
assert.equal(scopeStylesheet('p:not(:global(.red)){}', '_'), `p:not(.red).${prefix}_{}`);

assert.equal(
scopeStylesheet(':global(p:nth-child(3n+1):hover) {}', '_'),
Expand All @@ -258,10 +259,10 @@ test('global with pseudo element', () => {
assert.equal(scopeStylesheet(':global(a::after){}', '_'), 'a::after{}');
// assert.equal(scopeStylesheet(':global(a)::before{}', '_'), 'a::before{}');

assert.equal(scopeStylesheet(':global(a).red::before {}', '_'), 'a.red.⭐️_::before {}');
assert.equal(scopeStylesheet(':global(a).red::before {}', '_'), `a.red.${prefix}_::before {}`);
assert.equal(
scopeStylesheet(':global(a.red) span::before {}', '_'),
'a.red span.⭐️_::before {}'
`a.red span.${prefix}_::before {}`
);
});

Expand Down
2 changes: 1 addition & 1 deletion packages/qwik/src/core/util/markers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export const OnRenderProp = 'q:renderFn';
export const ComponentStylesPrefixHost = '💎';

/** Component style content prefix */
export const ComponentStylesPrefixContent = '⭐️';
export const ComponentStylesPrefixContent = '⚡️';

/** Prefix used to identify on listeners. */
export const EventPrefix = 'on:';
Expand Down
Loading