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

feat(arco): add iconPrefix option for arco resolver #516

Merged
merged 2 commits into from
Sep 26, 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
47 changes: 41 additions & 6 deletions src/core/resolvers/arco.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import Debug from 'debug'
import type { ComponentInfo, ComponentResolver } from '../../types'
import { kebabCase } from '../utils'
import { kebabCase, pascalCase } from '../utils'
const debug = Debug('unplugin-vue-components:resolvers:arco')

const matchComponents = [
{
Expand Down Expand Up @@ -139,6 +141,31 @@ function getComponentStyleDir(importName: string, importStyle: boolean | 'css' |
return `@arco-design/web-vue/es/${componentDir}/style/css.js`
}

function canResolveIcons(options?: ResolveIconsOption): options is AllowResolveIconOption {
if (options === undefined)
return false
if (typeof options === 'boolean')
return options
else
return options.enable
}

function getResolveIconPrefix(options?: ResolveIconsOption) {
if (canResolveIcons(options)) {
if (typeof options === 'boolean' && options)
return ''
else if (options.enable)
return options.iconPrefix ?? ''
else
return ''
}
return ''
}

export type DisallowResolveIconOption = undefined | false | { enable: false }
export type AllowResolveIconOption = true | { enable: true; iconPrefix?: string }
export type ResolveIconsOption = DisallowResolveIconOption | AllowResolveIconOption

export interface ArcoResolverOptions {
/**
* import style css or less with components
Expand All @@ -151,7 +178,7 @@ export interface ArcoResolverOptions {
*
* @default false
*/
resolveIcons?: boolean
resolveIcons?: ResolveIconsOption
/**
* Control style automatic import
*
Expand All @@ -175,10 +202,18 @@ export function ArcoResolver(
return {
type: 'component',
resolve: (name: string) => {
if (options.resolveIcons && name.match(/^Icon/)) {
return {
name,
from: '@arco-design/web-vue/es/icon',
if (canResolveIcons(options.resolveIcons)) {
const iconPrefix = pascalCase(getResolveIconPrefix(options.resolveIcons))
const newNameRegexp = new RegExp(`^${iconPrefix}Icon`)
if (newNameRegexp.test(name)) {
debug('found icon component name %s', name)
const rawComponentName = name.slice(iconPrefix.length)
debug('found icon component raw name %s', rawComponentName)
return {
name: rawComponentName,
as: name,
from: '@arco-design/web-vue/es/icon',
}
}
}
if (name.match(/^A[A-Z]/)) {
Expand Down
41 changes: 41 additions & 0 deletions test/resolvers/arco.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { describe, expect, test } from 'vitest'
import { ArcoResolver } from '../../src/resolvers'

import type { ComponentResolveResult, ComponentResolverObject } from '../../src'

function testNoIconComponentResolve(resolver: ComponentResolverObject) {
expect(resolver.resolve('AButton')).toEqual<ComponentResolveResult>({
name: 'Button',
from: '@arco-design/web-vue',
sideEffects: '@arco-design/web-vue/es/button/style/css.js',
})
}

describe('ArcoResolver', () => {
test('Resolve component except icon', async () => {
const resolver = ArcoResolver() as ComponentResolverObject
expect(typeof resolver).toEqual('object')
testNoIconComponentResolve(resolver)
expect(resolver.resolve('IconStar')).toBeFalsy()
})

test('Can resolve icon component', () => {
const resolver = ArcoResolver({ resolveIcons: true }) as ComponentResolverObject
testNoIconComponentResolve(resolver)
expect(resolver.resolve('IconStar')).toEqual<ComponentResolveResult>({
name: 'IconStar',
from: '@arco-design/web-vue/es/icon',
as: 'IconStar',
})
})

test('Can resolve icon component with custom icon prefix', () => {
const resolver = ArcoResolver({ resolveIcons: { enable: true, iconPrefix: 'arco' } }) as ComponentResolverObject
testNoIconComponentResolve(resolver)
expect(resolver.resolve('ArcoIconStar')).toEqual<ComponentResolveResult>({
name: 'IconStar',
from: '@arco-design/web-vue/es/icon',
as: 'ArcoIconStar',
})
})
})