@varlet/cli 2.9.2 → 2.9.3-alpha.1679397001839

package/README.md

@@ -55,6 +55,7 @@ Also refer to `@varlet/ui` [varlet.config.mjs](https://github.com/varletjs/varle
 | `analysis` | Document statistics related | _{ baidu: string }_ | `-` |
 | `pc` | PC-side document structure configuration | _Record<string, any>_ | `-` |
 | `mobile` | Mobile side document structure configuration | _Record<string, any>_ | `-` |
+| `directives` | Directive folder names | _string[]_ | `[]` |
 | `copy` | Copy file options | _[CopyPath[]](https://github.com/varletjs/varlet/blob/dev/packages/varlet-vite-plugins/src/copy.ts)_ | `-` |
 | `icons` | Font icon packaging related configuration | _[VarletConfigIcons](https://github.com/varletjs/varlet/blob/dev/packages/varlet-cli/src/node/config/varlet.config.ts)_ | `-` |
 

package/README.zh-CN.md

@@ -55,6 +55,7 @@ varlet-cli gen
 | `analysis` | 文档统计相关 | _{ baidu: string }_ | `-` |
 | `pc` | pc 端文档结构配置 | _Record<string, any>_ | `-` |
 | `mobile` | mobile 端文档结构配置 | _Record<string, any>_ | `-` |
+| `directives` | 组件库指令文件夹名称 | _string[]_ | `[]` |
 | `copy` | 复制文件配置 | _[CopyPath[]](https://github.com/varletjs/varlet/blob/dev/packages/varlet-vite-plugins/src/copy.ts)_ | `-` |
 | `icons` | 字体图标打包相关配置 | _[VarletConfigIcons](https://github.com/varletjs/varlet/blob/dev/packages/varlet-cli/src/node/config/varlet.config.ts)_ | `-` |
 

package/lib/node/compiler/compileTypes.js

@@ -11,25 +11,39 @@ export * from '${relative(moduleDir, TYPES_DIR)}'
 `);
 }
 export async function compileTypes() {
+    await ensureDir(TYPES_DIR);
     const varletConfig = await getVarletConfig();
     const namespace = get(varletConfig, 'namespace');
-    const { name } = readJSONSync(UI_PACKAGE_JSON);
-    await ensureDir(TYPES_DIR);
-    const dir = await readdir(TYPES_DIR);
-    const ignoreEntryDir = dir.filter((filename) => filename !== 'index.d.ts' && filename !== 'global.d.ts');
+    const directives = get(varletConfig, 'directives');
+    const { name: libraryName } = readJSONSync(UI_PACKAGE_JSON);
+    const filenames = await readdir(TYPES_DIR);
+    const includeFilenames = filenames.filter((filename) => filename !== 'index.d.ts' && filename !== 'global.d.ts');
     const exports = [];
-    const declares = [];
-    ignoreEntryDir.forEach((filename) => {
-        const componentName = filename.slice(0, filename.indexOf('.d.ts'));
-        exports.push(`export * from './${componentName}'`);
-        if (!componentName.startsWith(namespace)) {
-            declares.push(`${bigCamelize(namespace)}${bigCamelize(componentName)}: typeof import('${name}')['_${bigCamelize(componentName)}Component']`);
+    const componentDeclares = [];
+    const directiveDeclares = [];
+    includeFilenames.forEach((filename) => {
+        const folder = filename.slice(0, filename.indexOf('.d.ts'));
+        const name = bigCamelize(folder);
+        exports.push(`export * from './${filename}'`);
+        if (filename.startsWith(namespace)) {
+            // ignore prefix with namespace e.g. varComponent
+            return;
+        }
+        if (directives.includes(folder)) {
+            directiveDeclares.push(`v${name}: typeof import('${libraryName}')['_${name}Component']`);
+        }
+        else {
+            componentDeclares.push(`${bigCamelize(namespace)}${name}: typeof import('${libraryName}')['_${name}Component']`);
         }
     });
-    const globalDeclares = `\
+    const vueDeclares = `\
 declare module 'vue' {
   export interface GlobalComponents {
-    ${declares.join('\n    ')}
+    ${componentDeclares.join('\n    ')}
+  }
+
+  export interface ComponentCustomProperties {
+    ${directiveDeclares.join('\n    ')}
   }
 }`;
     const template = `\
@@ -40,7 +54,7 @@ export const install: (app: App) => void
 
 ${exports.join('\n')}
 
-${globalDeclares}
+${vueDeclares}
 `;
-    await Promise.all([writeFile(resolve(TYPES_DIR, 'index.d.ts'), template)]);
+    await writeFile(resolve(TYPES_DIR, 'index.d.ts'), template);
 }

package/lib/node/config/varlet.config.d.ts

@@ -62,6 +62,11 @@ export interface VarletConfig {
     mobile?: Record<string, any>;
     copy?: CopyOptions['paths'];
     icons?: VarletConfigIcons;
+    /**
+     * @default `[]`
+     * Directive folder name for component library.
+     */
+    directives?: string[];
 }
 export declare function defineConfig(config: VarletConfig): VarletConfig;
 export declare function mergeStrategy(value: any, srcValue: any, key: string): any[] | undefined;

package/lib/node/config/varlet.default.config.js

@@ -267,4 +267,5 @@ export default defineConfig({
         fontFamilyClassName: 'var-icon--set',
         base64: true,
     },
+    directives: [],
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@varlet/cli",
-  "version": "2.9.2",
+  "version": "2.9.3-alpha.1679397001839",
   "type": "module",
   "description": "cli of varlet",
   "bin": {
@@ -37,18 +37,15 @@
   "dependencies": {
     "@babel/core": "^7.14.8",
     "@babel/helper-plugin-utils": "^7.14.5",
+    "@babel/plugin-transform-typescript": "^7.14.5",
     "@babel/preset-env": "^7.14.8",
     "@babel/preset-typescript": "^7.14.5",
-    "@babel/plugin-transform-typescript": "^7.14.5",
     "@vitejs/plugin-vue": "4.0.0",
     "@vitejs/plugin-vue-jsx": "3.0.0",
     "@vue/babel-plugin-jsx": "1.1.1",
     "@vue/compiler-sfc": "3.2.25",
     "@vue/runtime-core": "3.2.25",
-    "webfont": "^9.0.0",
-    "sharp": "0.31.3",
     "babel-jest": "26.6.3",
-    "picocolors": "^1.0.0",
     "chokidar": "^3.5.2",
     "commander": "^8.3.0",
     "conventional-changelog": "^3.1.25",
@@ -62,15 +59,18 @@
     "less": "^3.12.2",
     "lodash-es": "^4.17.21",
     "nanospinner": "^1.1.0",
+    "picocolors": "^1.0.0",
     "semver": "^7.3.5",
+    "sharp": "0.31.1",
     "slash": "^3.0.0",
     "ts-jest": "^26.5.1",
     "typescript": "^4.4.4",
     "vite": "4.0.4",
     "vue": "3.2.25",
     "vue-jest": "^5.0.0-alpha.8",
-    "@varlet/vite-plugins": "2.9.2",
-    "@varlet/shared": "2.9.2"
+    "webfont": "^9.0.0",
+    "@varlet/shared": "2.9.3-alpha.1679397001839",
+    "@varlet/vite-plugins": "2.9.3-alpha.1679397001839"
   },
   "devDependencies": {
     "@types/babel__core": "^7.1.12",
@@ -78,13 +78,13 @@
     "@types/fs-extra": "^9.0.2",
     "@types/glob": "^7.1.3",
     "@types/hash-sum": "^1.0.0",
+    "@types/inquirer": "^9.0.2",
     "@types/lodash-es": "^4.17.5",
     "@types/node": "^18.7.20",
     "@types/semver": "^7.3.9",
-    "@types/inquirer": "^9.0.2",
     "@types/sharp": "0.31.1",
-    "@varlet/icons": "2.9.2",
-    "@varlet/touch-emulator": "2.9.2"
+    "@varlet/icons": "2.9.3-alpha.1679397001839",
+    "@varlet/touch-emulator": "2.9.3-alpha.1679397001839"
   },
   "peerDependencies": {
     "@vue/runtime-core": "3.2.16",
@@ -94,8 +94,8 @@
     "lodash-es": "^4.17.21",
     "vue": "3.2.25",
     "vue-router": "4.0.12",
-    "@varlet/icons": "2.9.2",
-    "@varlet/touch-emulator": "2.9.2"
+    "@varlet/icons": "2.9.3-alpha.1679397001839",
+    "@varlet/touch-emulator": "2.9.3-alpha.1679397001839"
   },
   "scripts": {
     "dev": "tsc --watch",