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: add strict option for resolver #327

Merged
merged 3 commits into from
May 1, 2024
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
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,29 @@ export default defineNuxtConfig({
})
```

Or work with [unplugin-vue-components](https://github.com/unplugin/unplugin-vue-components) resolvers

```ts
import ViteComponents from 'unplugin-vue-components/vite'
import IconsResolver from 'unplugin-icons/resolver'

// nuxt.config.ts
export default defineNuxtConfig({
modules: [
'unplugin-icons/nuxt',
],
vite: {
plugins: [
ViteComponents({
resolvers: [
IconsResolver({/* options */}),
],
}),
],
},
})
```

See [the Nuxt example](examples/nuxt3) for a working example project.

<br></details>
Expand Down
3 changes: 3 additions & 0 deletions examples/nuxt3/app.vue
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,8 @@ import MdiAlarmOff from '~icons/mdi/alarm-off'
<MdiAlarmOff />
from <code>unplugin-icons</code>
</p>
<h1>Auto import Components</h1>
<Circle />
<LayoutFooter />
</div>
</template>
13 changes: 13 additions & 0 deletions examples/nuxt3/components.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/* eslint-disable */
/* prettier-ignore */
// @ts-nocheck
// Generated by unplugin-vue-components
// Read more: https://github.com/vuejs/core/pull/3399
export {}

declare module 'vue' {
export interface GlobalComponents {
RouterLink: typeof import('vue-router')['RouterLink']
RouterView: typeof import('vue-router')['RouterView']
}
}
3 changes: 3 additions & 0 deletions examples/nuxt3/components/Circle.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<template>
<h1>Hello Ts Setup Circle</h1>
</template>
3 changes: 3 additions & 0 deletions examples/nuxt3/components/LayoutHeader.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<template>
<h1>Hello Ts Header</h1>
</template>
16 changes: 16 additions & 0 deletions examples/nuxt3/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
import ViteComponents from 'unplugin-vue-components/vite'
import IconsResolver from 'unplugin-icons/resolver'

// https://v3.nuxtjs.org/api/configuration/nuxt.config
export default defineNuxtConfig({
modules: [
'unplugin-icons/nuxt',
],
vite: {
plugins: [
ViteComponents({
resolvers: [
IconsResolver({
prefix: '',
strict: true,
}),
],
dts: true,
}),
],
},
})
3 changes: 2 additions & 1 deletion examples/nuxt3/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"@iconify-json/logos": "^1.1.42",
"@iconify-json/mdi": "^1.1.66",
"nuxt": "^3.11.2",
"unplugin-icons": "link:../.."
"unplugin-icons": "link:../..",
"unplugin-vue-components": "^0.25.2"
},
"stackblitz": {
"installDependencies": false,
Expand Down
2 changes: 1 addition & 1 deletion src/core/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ function guessJSX(): ResolvedOptions['jsx'] {
async function getVueVersion() {
try {
const result = await getPackageInfo('vue')
if (!result)
if (!result || !result.version)
genffy marked this conversation as resolved.
Show resolved Hide resolved
return null
return result.version?.startsWith('2.') ? 'vue2' : 'vue3'
}
Expand Down
10 changes: 9 additions & 1 deletion src/resolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ export interface ComponentResolverOption {
* @deprecated renamed to `prefix`
*/
componentPrefix?: string

/**
* For collections strict matching.
* Default is `false`, not side effect.
* Set `true` to enable strict matching with `-` suffix for all collections.
*/
strict?: boolean
}

/**
Expand All @@ -59,6 +66,7 @@ export default function ComponentsResolver(options: ComponentResolverOption = {}
alias = {},
customCollections = [],
extension,
strict = false,
} = options

const prefix = rawPrefix ? `${camelToKebab(rawPrefix)}-` : ''
Expand Down Expand Up @@ -101,7 +109,7 @@ export default function ComponentsResolver(options: ComponentResolverOption = {}
return

const slice = kebab.slice(prefix.length)
const resolvedCollection = collections.find(i => slice.startsWith(`${i}-`)) || collections.find(i => slice.startsWith(i))
const resolvedCollection = collections.find(i => slice.startsWith(`${i}-`)) || (!strict && collections.find(i => slice.startsWith(i)))
if (!resolvedCollection)
return

Expand Down