Skip to content

feat(tags): introduce tagSource for processors #1188

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

Merged
Anber merged 1 commit into from
Jan 15, 2023
Merged

feat(tags): introduce tagSource for processors #1188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions .changeset/itchy-eggs-impress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@linaria/babel-preset': patch
'@linaria/tags': patch
'@linaria/testkit': patch
---

Add the tagSource property for processors, indicating the package and name of the imported processor.
36 changes: 21 additions & 15 deletions packages/babel/src/utils/getTagProcessor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import type {
Params,
IFileContext,
ExpressionValue,
TagSource,
} from '@linaria/tags';
import type { IImport, StrictOptions } from '@linaria/utils';
import {
Expand All @@ -34,6 +35,7 @@ import getSource from './getSource';

type BuilderArgs = ConstructorParameters<typeof BaseProcessor> extends [
Params,
TagSource,
typeof t,
SourceLocation | null,
(replacement: Expression, isPure: boolean) => void,
Expand Down Expand Up @@ -164,11 +166,13 @@ function getProcessorForIdentifier(
StrictOptions,
'classNameSlug' | 'displayName' | 'evaluate' | 'tagResolver'
>
): [ProcessorClass, NodePath<Identifier | MemberExpression>] | [null, null] {
):
| [ProcessorClass, TagSource, NodePath<Identifier | MemberExpression>]
| [null, null, null] {
const pathBinding = path.scope.getBinding(path.node.name);
if (!pathBinding) {
// It's not a binding, so it's not a tag
return [null, null];
return [null, null, null];
}

const tagResolver = options.tagResolver ?? (() => null);
Expand Down Expand Up @@ -203,28 +207,29 @@ function getProcessorForIdentifier(
.filter((i) => i[1] === null || i[1].isExpression());

if (relatedImports.length === 0) {
return [null, null];
return [null, null, null];
}

const [Processor = null, tagPath = null] =
const [Processor = null, tagSource = null, tagPath = null] =
relatedImports
.map(
([imp, p]): [
([{ imported, source }, p]): [
ProcessorClass | null,
TagSource,
NodePath<Identifier | MemberExpression> | null
] => {
const source = tagResolver(imp.source, imp.imported);
const processor = source
? getProcessorFromFile(source)
: getProcessorFromPackage(imp.source, imp.imported, filename);
return [processor, p];
const customFile = tagResolver(source, imported);
const processor = customFile
? getProcessorFromFile(customFile)
: getProcessorFromPackage(source, imported, filename);
return [processor, { imported, source }, p];
}
)
.find(([proc]) => proc) ?? [];

return Processor === null || tagPath === null
? [null, null]
: [Processor, tagPath];
return Processor === null || tagSource === null || tagPath === null
? [null, null, null]
: [Processor, tagSource, tagPath];
}

function getBuilderForIdentifier(
Expand All @@ -236,14 +241,14 @@ function getBuilderForIdentifier(
'classNameSlug' | 'displayName' | 'evaluate' | 'tagResolver'
>
): Builder | null {
const [Processor, tagPath] = getProcessorForIdentifier(
const [Processor, tagSource, tagPath] = getProcessorForIdentifier(
path,
imports,
filename,
options
);

if (!Processor || !tagPath) {
if (!Processor || !tagSource || !tagPath) {
return null;
}

Expand Down Expand Up @@ -345,6 +350,7 @@ function getBuilderForIdentifier(
return (...args: BuilderArgs) =>
new Processor(
params,
tagSource,
astService,
tagPath.node.loc ?? null,
replacer,
Expand Down
6 changes: 6 additions & 0 deletions packages/tags/src/BaseProcessor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ export type TailProcessorParams = ProcessorParams extends [Params, ...infer T]
? T
: never;

export type TagSource = {
imported: string;
source: string;
};

export default abstract class BaseProcessor {
public static SKIP = Symbol('skip');

Expand All @@ -50,6 +55,7 @@ export default abstract class BaseProcessor {

public constructor(
params: Params,
public tagSource: TagSource,
protected readonly astService: typeof t & {
addDefaultImport: (source: string, nameHint?: string) => Identifier;
addNamedImport: (
Expand Down
66 changes: 47 additions & 19 deletions packages/testkit/src/utils/getTagProcessor.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const run = (code: string): BaseProcessor | null => {
return result;
};

function tagSource(processor: BaseProcessor | null): string | undefined {
function tagToString(processor: BaseProcessor | null): string | undefined {
if (!processor) return undefined;
return processor.toString();
}
Expand All @@ -50,7 +50,11 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('renamedStyled(Cmp)`…`');
expect(tagToString(result)).toBe('renamedStyled(Cmp)`…`');
expect(result?.tagSource).toEqual({
imported: 'styled',
source: '@linaria/atomic',
});
});

it('imported component', () => {
Expand All @@ -63,7 +67,11 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('styled(Layout)`…`');
expect(tagToString(result)).toBe('styled(Layout)`…`');
expect(result?.tagSource).toEqual({
imported: 'styled',
source: '@linaria/react',
});
});

it('renamedStyled(Cmp)``', () => {
Expand All @@ -77,7 +85,11 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('renamedStyled(Cmp)`…`');
expect(tagToString(result)).toBe('renamedStyled(Cmp)`…`');
expect(result?.tagSource).toEqual({
imported: 'styled',
source: '@linaria/react',
});
});

it('(0, react_1.styled)(Cmp)``', () => {
Expand All @@ -91,7 +103,11 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('react_1.styled(Cmp)`…`');
expect(tagToString(result)).toBe('react_1.styled(Cmp)`…`');
expect(result?.tagSource).toEqual({
imported: 'styled',
source: '@linaria/react',
});
});

it('styled(Cmp)``', () => {
Expand All @@ -105,7 +121,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('styled(Cmp)`…`');
expect(tagToString(result)).toBe('styled(Cmp)`…`');
});

it('styled(hoc(Title))``', () => {
Expand All @@ -126,7 +142,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('styled(hoc(Title))`…`');
expect(tagToString(result)).toBe('styled(hoc(Title))`…`');
});

it('styled(() => { someLogic(); })``', () => {
Expand All @@ -143,7 +159,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('styled(() => {…})`…`');
expect(tagToString(result)).toBe('styled(() => {…})`…`');
});

it('renamedStyled.div``', () => {
Expand All @@ -155,7 +171,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe("renamedStyled('div')`…`");
expect(tagToString(result)).toBe("renamedStyled('div')`…`");
});

it('(0, react_1.styled.div)``', () => {
Expand All @@ -167,7 +183,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe("react_1.styled('div')`…`");
expect(tagToString(result)).toBe("react_1.styled('div')`…`");
});

it('styled.div``', () => {
Expand All @@ -179,7 +195,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe("styled('div')`…`");
expect(tagToString(result)).toBe("styled('div')`…`");
});

it('styled("div")``', () => {
Expand All @@ -191,7 +207,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe("styled('div')`…`");
expect(tagToString(result)).toBe("styled('div')`…`");
});

it('(0, core_1.css)``', () => {
Expand All @@ -203,7 +219,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('core_1.css`…`');
expect(tagToString(result)).toBe('core_1.css`…`');
});

it('css``', () => {
Expand All @@ -215,7 +231,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('css`…`');
expect(tagToString(result)).toBe('css`…`');
});

it('atomic css``', () => {
Expand All @@ -227,7 +243,11 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('css`…`');
expect(tagToString(result)).toBe('css`…`');
expect(result?.tagSource).toEqual({
imported: 'css',
source: '@linaria/atomic',
});
});

it('re-imported css', () => {
Expand All @@ -239,7 +259,11 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe('css`…`');
expect(tagToString(result)).toBe('css`…`');
expect(result?.tagSource).toEqual({
imported: 'css',
source: 'linaria',
});
});

it('re-imported styled', () => {
Expand All @@ -251,7 +275,11 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe("styled('div')`…`");
expect(tagToString(result)).toBe("styled('div')`…`");
expect(result?.tagSource).toEqual({
imported: 'styled',
source: 'linaria/react',
});
});

it('import from unknown package', () => {
Expand All @@ -274,7 +302,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe("renamedStyled('div')`…`");
expect(tagToString(result)).toBe("renamedStyled('div')`…`");
});

it('require and destructing', () => {
Expand All @@ -285,7 +313,7 @@ describe('getTagProcessor', () => {
`
);

expect(tagSource(result)).toBe("styled('div')`…`");
expect(tagToString(result)).toBe("styled('div')`…`");
});

describe('invalid usage', () => {
Expand Down