chore: readme

amihhs · Aug 25, 2023 · f89dd77 · f89dd77
1 parent 87db5da
commit f89dd77
Show file tree

Hide file tree

Showing 7 changed files with 105 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -16,15 +16,95 @@
 
     export default {
       plugins: [
-        FilesLoader()
+        FilesLoader({
+          paths: './demos',
+          resolveChildrenBase: 'src',
+          enableResolveLongChildren: true,
+        })
       ],
     }
     ```
 
+3. Usage
+
+```ts
+/**
+ * |-demos
+ *    |-button
+ *        |-src
+ *          |-basic
+ *            |-index.html
+ */
+import DEMOS from 'virtual:files-loader' // =>  /demos/..
+import BUTTON_DEMOS from 'virtual:files-loader/button' // => /demos/button/src/..
+import BUTTON_BASIC_DEMOS from 'virtual:demo-loader/button/basic' // => /demos/button/src/basic/..
+
+
+```
+
+```json
+// virtual:files-loader
+{
+  "__default": [
+    {
+      "name": "button",
+      "children": [
+        {
+          "name": "basic",
+          "children": [
+            {
+              "name": "index.html",
+              "content": "...",
+              "language": "html"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "index.html",
+      "content": "...",
+      "language": "html"
+    }
+  ]
+}
+
+
+// virtual:files-loader/button
+{
+  "name": "button",
+  "children": [
+    {
+      "name": "basic",
+      "children": [
+        {
+          "name": "index.html",
+          "content": "...",
+          "language": "html"
+        }
+      ]
+    }
+  ]
+}
+
+
+// virtual:demo-loader/button/basic
+{
+  "name": "basic",
+  "children": [
+    {
+      "name": "index.html",
+      "content": "...",
+      "language": "html"
+    }
+  ]
+}
+```
+
 ## Options
 
 ```ts
-export interface DemoLoaderPluginOptions {
+export interface FilesLoaderPluginOptions {
   /**
    * Relative paths will be based on root
    * @default process.cwd()

diff --git a/client.d.ts b/client.d.ts
@@ -1,12 +1,7 @@
 
-declare module 'virtual:files-loader' {
-  const demos: Record<string,  import('./src/types').DemoItem[]>
+declare module 'virtual:files-loader*' {
+  const demos: Record<string,  import('./src/types').FilesLoaderItem[]>
 
   export default demos
 }
 
-declare module 'virtual:files-loader/*' {
-  const demos: Record<string,  import('./src/types').DemoItem[]>
-
-  export default demos
-}
diff --git a/playground/demo/button/src/basic/index.html b/playground/demo/button/src/basic/index.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Document</title>
+</head>
+<body>
+
+</body>
+</html>
diff --git a/playground/demo/index copy.html b/playground/demo/index copy.html
diff --git a/playground/src/main.ts b/playground/src/main.ts
@@ -1,8 +1,12 @@
 import './style.css'
-import DEMOS from 'virtual:files-loader'
+import DEMOS from 'virtual:files-loader' // =>  /demos/..
+import BUTTON_DEMOS from 'virtual:files-loader/button' // => /demos/button/src/..
+import BUTTON_BASIC_DEMOS from 'virtual:files-loader/button/basic' // => /demos/button/src/basic/..
 
 const app = document.getElementById('app')!
 
-const settled = DEMOS
+const settled = JSON.stringify(DEMOS, null, 2) 
++ '\n' + JSON.stringify(BUTTON_DEMOS, null, 2) 
++ '\n' + JSON.stringify(BUTTON_BASIC_DEMOS, null, 2) 
 
-app.textContent = JSON.stringify(settled, null, 2)
+app.textContent = settled
diff --git a/playground/tsconfig.json b/playground/tsconfig.json
@@ -5,7 +5,6 @@
     "target": "ESNext",
     "lib": ["DOM", "ESNext"],
     "strict": true,
-    "jsx": "preserve",
     "esModuleInterop": true,
     "skipLibCheck": true,
     "moduleResolution": "node",

diff --git a/playground/vite.config.ts b/playground/vite.config.ts
@@ -13,7 +13,9 @@ export default defineConfig({
   },
   plugins: [
     FilesLoader({
-      paths: './demo'
+      paths: './demo',
+      resolveChildrenBase: 'src',
+      enableResolveLongChildren: true,
     }),
   ],
   build: {