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.

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

Fix diff on unchanged #419

Merged
merged 5 commits into from
Aug 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"preact": "^10.0.0-beta.2",
"preact-render-to-json": "^3.6.6",
"prettier": "^2.3.2",
"pretty-format": "^27.5.1",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-is": "^17.0.2",
Expand Down
10 changes: 5 additions & 5 deletions src/styleSheetSerializer.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,15 @@ const getAtRules = (ast, filter) =>
return acc.concat(atRule);
}, []);

const getStyle = (classNames) => {
const getStyle = (classNames, config = {}) => {
const ast = getCSS();
const filter = filterRules(classNames);
const rules = ast.stylesheet.rules.filter(filter);
const atRules = getAtRules(ast, filter);

ast.stylesheet.rules = rules.concat(atRules);

return css.stringify(ast);
return css.stringify(ast, { indent: config.indent });
};

const getClassNamesFromSelectorsByHashes = (classNames, hashes) => {
Expand Down Expand Up @@ -137,7 +137,7 @@ module.exports = {
);
},

print(val, print) {
serialize(val, config, indentation, depth, refs, printer) {
const nodes = getNodes(val);
nodes.forEach(cache.add, cache);

Expand All @@ -149,9 +149,9 @@ module.exports = {
classNames = filterClassNames(classNames, hashes);
unreferencedClassNames = filterUnreferencedClassNames(unreferencedClassNames, hashes);

const style = getStyle(classNames);
const style = getStyle(classNames, config);
const classNamesToReplace = getClassNamesFromSelectorsByHashes(classNames, hashes);
const code = print(val);
const code = printer(val, config, indentation, depth, refs);

let result = serializerOptions.addStyles ? `${style}${style ? '\n\n' : ''}${code}` : code;
result = stripUnreferencedClassNames(result, unreferencedClassNames);
Expand Down
59 changes: 59 additions & 0 deletions test/styleSheetSerializer.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ import { mount, shallow } from 'enzyme';
import React from 'react';
import renderer from 'react-test-renderer';
import styled, { ThemeContext, ThemeProvider } from 'styled-components';
import prettyFormat, { plugins } from 'pretty-format';
import {setStyleSheetSerializerOptions} from '../serializer';
import styleSheetSerializer from '../src/styleSheetSerializer';

const toMatchSnapshot = (component) => {
expect(renderer.create(component).toJSON()).toMatchSnapshot('react-test-renderer');
Expand All @@ -19,6 +21,31 @@ const shallowWithTheme = (tree, theme) => {
return shallow(tree);
};

/**
* Serializes a value similarly to jest-snapshot
*
* Imitates the serialization logic inside jest-snapshot,
* so we can pass options, including indent, to it.
*
* @see https://github.com/facebook/jest/blob/615084195ae1ae61ddd56162c62bbdda17587569/packages/jest-snapshot/src/utils.ts#L155-L163
* @see https://github.com/facebook/jest/blob/615084195ae1ae61ddd56162c62bbdda17587569/packages/jest-snapshot/src/plugins.ts#L24-L32
*/
const serialize = (val, indent = 2) =>
prettyFormat(val, {
escapeRegex: true,
indent,
plugins: [
styleSheetSerializer,
plugins.ReactTestComponent,
plugins.ReactElement,
plugins.DOMElement,
plugins.DOMCollection,
plugins.Immutable,
plugins.AsymmetricMatcher,
],
printFunctionName: false,
});

it('null', () => {
expect(null).toMatchSnapshot();
});
Expand Down Expand Up @@ -346,3 +373,35 @@ it('allows to set a css classNameFormatter', () => {
</div>
);
});

it('responds to indent configuration', () => {
const Link = styled.a`
color: blue;
`;

const mounted = renderer.create(<Link>Styled, exciting Link</Link>);

expect(serialize(mounted)).toMatchInlineSnapshot(`
".styledComponent0 {
color: blue;
}

<a
className=\\"styledComponent0\\"
>
Styled, exciting Link
</a>"
`);

expect(serialize(mounted, 0)).toMatchInlineSnapshot(`
".styledComponent0 {
color: blue;
}

<a
className=\\"styledComponent0\\"
>
Styled, exciting Link
</a>"
`);
});
6 changes: 3 additions & 3 deletions typings/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Plugin, NewPlugin } from 'pretty-format'
import { NewPlugin } from 'pretty-format'
import { css } from 'styled-components'

declare global {
Expand Down Expand Up @@ -27,6 +27,6 @@ export interface StyledComponentsSerializerOptions {
classNameFormatter?: (index: number) => string
}

export declare const styleSheetSerializer: Exclude<Plugin, NewPlugin> & {
export declare const styleSheetSerializer: NewPlugin & {
setStyleSheetSerializerOptions: (options?: StyledComponentsSerializerOptions) => void
};
};
9 changes: 9 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6200,6 +6200,15 @@ pretty-format@^27.0.2, pretty-format@^27.3.1:
ansi-styles "^5.0.0"
react-is "^17.0.1"

pretty-format@^27.5.1:
version "27.5.1"
resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-27.5.1.tgz#2181879fdea51a7a5851fb39d920faa63f01d88e"
integrity sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==
dependencies:
ansi-regex "^5.0.1"
ansi-styles "^5.0.0"
react-is "^17.0.1"

process-nextick-args@~2.0.0:
version "2.0.1"
resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2"
Expand Down