Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Open
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 .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
2 changes: 2 additions & 0 deletions examples/vite-vue3/components.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ declare module 'vue' {
ComponentAsync: typeof import('./src/components/ComponentAsync.vue')['default']
ComponentB: typeof import('./src/components/ComponentB.vue')['default']
ComponentC: typeof import('./src/components/component-c.vue')['default']
ComponentCollision: typeof import('./src/layer-components/sort-b/ComponentCollision.vue')['default']
ComponentD: typeof import('./src/components/ComponentD.vue')['default']
IFaSolidDiceFive: typeof import('~icons/fa-solid/dice-five')['default']
IHeroiconsOutlineMenuAlt2: typeof import('~icons/heroicons-outline/menu-alt2')['default']
Expand All @@ -33,6 +34,7 @@ declare module 'vue' {
Recursive: typeof import('./src/components/Recursive.vue')['default']
RouterLink: typeof import('vue-router')['RouterLink']
RouterView: typeof import('vue-router')['RouterView']
SortComponent: typeof import('./src/components/sort/Component.vue')['default']
UiButton: typeof import('./src/components/ui/button.vue')['default']
UiNestedCheckbox: typeof import('./src/components/ui/nested/checkbox.vue')['default']
VanRadio: typeof import('vant/es')['Radio']
Expand Down
4 changes: 4 additions & 0 deletions examples/vite-vue3/src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ const radio = ref('1')
<i-mdi:dice-d12 />
<i-mdi-light-alarm />
</div>

<div class="block">
<SortComponent />
</div>
</template>

<style scoped>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<template>
<div>
<h3>Component Collision: <code>sort-a/ComponentCollision.vue</code></h3>
<slot />
</div>
</template>
7 changes: 7 additions & 0 deletions examples/vite-vue3/src/components/sort/Component.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<template>
<ComponentCollision>
<div>
<strong>Should display Component Collision: <code>sort-b/ComponentCollision.vue</code></strong>
</div>
</ComponentCollision>
</template>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<template>
<div>
<h3>Component Collision: <code>sort-b/ComponentCollision.vue</code></h3>
<slot />
</div>
</template>
4 changes: 3 additions & 1 deletion examples/vite-vue3/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,12 @@ const config: UserConfig = {
Icons(),
Inspect(),
Components({
dirs: ['src/components', 'src/layer-components'],
extensions: ['vue', 'md', 'svg'],
sort: 'pattern-desc',
directoryAsNamespace: true,
dts: true,
globalNamespaces: ['global'],
globalNamespaces: ['global', 'sort-a', 'sort-b'],
include: [/\.vue($|\?)/, /\.md($|\?)/],
resolvers: [
(name) => {
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"homepage": "https://github.com/unplugin/unplugin-vue-components#readme",
"repository": {
"type": "git",
"url": "https://github.com/unplugin/unplugin-vue-components.git"
"url": "git+https://github.com/unplugin/unplugin-vue-components.git"
},
"bugs": "https://github.com/unplugin/unplugin-vue-components/issues",
"exports": {
Expand Down Expand Up @@ -51,6 +51,7 @@
"typecheck": "tsgo",
"release": "bumpp",
"test": "vitest",
"test:debug:sort": "DEBUG=unplugin-vue-components:glob vitest -t sort",
"test:update": "vitest -u"
},
"peerDependencies": {
Expand All @@ -69,7 +70,7 @@
"mlly": "^1.8.0",
"obug": "^2.1.1",
"picomatch": "^4.0.3",
"tinyglobby": "^0.2.15",
"tinyglobby": "https://pkg.pr.new/tinyglobby@46902a8",
"unplugin": "^2.3.11",
"unplugin-utils": "^0.3.1"
},
Expand Down
14 changes: 12 additions & 2 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions src/core/fs/glob.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ export function searchComponents(ctx: Context) {
cwd: root,
absolute: true,
expandDirectories: false,
sort: ctx.options.sort,
})

if (!files.length && !ctx.options.resolvers?.length)

if (!files.length && !ctx.options.resolvers?.length) {
console.warn('[unplugin-vue-components] no components found')
}

debug(`${files.length} components found.`)

Expand Down
14 changes: 13 additions & 1 deletion src/core/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { isPackageExists } from 'local-pkg'
import { detectTypeImports } from './type-imports/detect'
import { escapeSpecialChars } from './utils'

export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude' | 'excludeNames' | 'transformer' | 'globs' | 'globsExclude' | 'directives' | 'types' | 'version'> = {
export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude' | 'excludeNames' | 'transformer' | 'globs' | 'globsExclude' | 'directives' | 'types' | 'version' | 'sort'> = {
dirs: 'src/components',
extensions: 'vue',
deep: true,
Expand Down Expand Up @@ -85,6 +85,18 @@ export function resolveOptions(options: Options, root: string): ResolvedOptions
return false
})

// tinyglobby doesn't support sorting patterns, we just sort them
// check the WARNING added to sort option at types.ts
const sort = options.sort
switch (true) {
case sort === 'pattern-asc':
resolved.globs.sort((a, b) => a.localeCompare(b))
break
case sort === 'pattern-desc':
resolved.globs.sort((a, b) => b.localeCompare(a))
break
}

resolved.dts = !resolved.dts
? false
: resolve(
Expand Down
28 changes: 27 additions & 1 deletion src/types.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { Awaitable } from '@antfu/utils'
import type { Sort } from 'tinyglobby'
import type { TransformResult } from 'unplugin'
import type { FilterPattern } from 'unplugin-utils'

Expand Down Expand Up @@ -219,11 +220,35 @@ export interface Options {
* @default 'default'
*/
syncMode?: 'default' | 'append' | 'overwrite'

/**
* Sort the results.
* - `asc`: Sorts the results in ascending order.
* - `desc`: Sorts the results in descending order.
* - `pattern`: Sorts the results by pattern precedence.
* - `pattern-asc`: Sorts the results by pattern precedence and then ascending.
* - `pattern-desc`: Sorts the results by pattern precedence and then descending.
* - `(a: string, b: string) => number`: A custom sort function.
*
* **WARNING**: If you have multiple directories (e.g. layers), and you
* are using `pattern`, `pattern-asc` or `pattern-desc`, you must configure the
* `dirs` array carefully:
* - `pattern`: The files will be sorted using the entries in the `dirs` array: files for the first dir, then files for the second dir, and so on (the order matters).
* - `pattern-asc`: The `dirs` will be sorted ascending before the file search, so files will be sorted based on the new sorted `dirs` order.
* - `pattern-desc`: The `dirs` will be sorted descending before the file search, so files will be sorted based on the new sorted `dirs` order.
*
* Check the [src/component/sort-a](https://github.com/unplugin/unplugin-vue-components/tree/main/examples/vite-vue3/src/components/sort-a),
* [src/layer-component/sort-b](https://github.com/unplugin/unplugin-vue-components/tree/main/examples/vite-vue3/src/components/sort-a) and the
* [vite.config.ts](https://github.com/unplugin/unplugin-vue-components/blob/main/examples/vite-vue3/vite.config.ts) files.
*
* @default undefined
*/
sort?: Sort
}

export type ResolvedOptions = Omit<
Required<Options>,
'resolvers' | 'extensions' | 'dirs' | 'globalComponentsDeclaration'
'resolvers' | 'extensions' | 'dirs' | 'globalComponentsDeclaration' | 'sort'
> & {
resolvers: ComponentResolverObject[]
extensions: string[]
Expand All @@ -234,6 +259,7 @@ export type ResolvedOptions = Omit<
dts: string | false
dtsTsx: boolean
root: string
sort?: Sort
}

export type ComponentsImportMap = Record<string, string[] | undefined>
Expand Down
2 changes: 2 additions & 0 deletions test/__snapshots__/dts.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,12 @@ declare module 'vue' {
CustomPrefixButton: typeof import('./examples/vite-vue3/src/components/ui/button.vue')['default']
CustomPrefixCheckbox: typeof import('./examples/vite-vue3/src/components/ui/nested/checkbox.vue')['default']
CustomPrefixCollapseFolderAndComponentFromRoot: typeof import('./examples/vite-vue3/src/components/collapse/collapseFolder/CollapseFolderAndComponentFromRoot.vue')['default']
CustomPrefixComponent: typeof import('./examples/vite-vue3/src/components/sort/Component.vue')['default']
CustomPrefixComponentA: typeof import('./examples/vite-vue3/src/components/ComponentA.vue')['default']
CustomPrefixComponentAsync: typeof import('./examples/vite-vue3/src/components/ComponentAsync.vue')['default']
CustomPrefixComponentB: typeof import('./examples/vite-vue3/src/components/ComponentB.vue')['default']
CustomPrefixComponentC: typeof import('./examples/vite-vue3/src/components/component-c.vue')['default']
CustomPrefixComponentCollision: typeof import('./examples/vite-vue3/src/components/sort-a/ComponentCollision.vue')['default']
CustomPrefixComponentD: typeof import('./examples/vite-vue3/src/components/ComponentD.vue')['default']
CustomPrefixFolderAndComponentPartially: typeof import('./examples/vite-vue3/src/components/collapse/collapseFolder/FolderAndComponentPartially.vue')['default']
CustomPrefixKebabCaseCollapseFile: typeof import('./examples/vite-vue3/src/components/kebab-case/kebab-case-collapse/KebabCaseCollapseFile.vue')['default']
Expand Down
24 changes: 24 additions & 0 deletions test/__snapshots__/search.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ exports[`search > should with namespace & collapse 1`] = `
"as": "Recursive",
"from": "src/components/Recursive.vue",
},
{
"as": "SortAComponentCollision",
"from": "src/components/sort-a/ComponentCollision.vue",
},
{
"as": "SortComponent",
"from": "src/components/sort/Component.vue",
},
{
"as": "UiButton",
"from": "src/components/ui/button.vue",
Expand Down Expand Up @@ -111,6 +119,14 @@ exports[`search > should with namespace 1`] = `
"as": "Recursive",
"from": "src/components/Recursive.vue",
},
{
"as": "SortAComponentCollision",
"from": "src/components/sort-a/ComponentCollision.vue",
},
{
"as": "SortComponent",
"from": "src/components/sort/Component.vue",
},
{
"as": "UiButton",
"from": "src/components/ui/button.vue",
Expand Down Expand Up @@ -144,6 +160,10 @@ exports[`search > should work 1`] = `
"as": "CollapseFolderAndComponentFromRoot",
"from": "src/components/collapse/collapseFolder/CollapseFolderAndComponentFromRoot.vue",
},
{
"as": "Component",
"from": "src/components/sort/Component.vue",
},
{
"as": "ComponentA",
"from": "src/components/ComponentA.vue",
Expand All @@ -160,6 +180,10 @@ exports[`search > should work 1`] = `
"as": "ComponentC",
"from": "src/components/component-c.vue",
},
{
"as": "ComponentCollision",
"from": "src/components/sort-a/ComponentCollision.vue",
},
{
"as": "ComponentD",
"from": "src/components/ComponentD.vue",
Expand Down
Loading
Loading