@zhin.js/page 1.1.0 → 1.1.2

package/README.md

@@ -1,13 +1,13 @@
 # @zhin.js/page
 
-标准 Page Feature provider。它把插件或项目根的平面 `pages/*.ts|tsx` 发现为 owner-bound Page manifest，并从 Plugin path 确定性生成 route。
+标准 Page Feature provider。它把插件或项目根的平面 `pages/*/index.ts|tsx` 发现为 owner-bound Page manifest，并从 Plugin path 确定性生成 route；未加 `$` 的文件不会被加载为页面。
 
 ## Convention
 
 - `pages/status.tsx` -> localName `status`。
 - Root route 为 `/p-status`；`root/a/b` 的 route 为 `/a/b/p-status`。
 - 首版不递归，不支持 `index`、`[param]` 或 route metadata override。
-- `$nav.tsx`、`$footer.tsx` 以及其他 `$` 文件不属于 Page。
+- `pages/nav/`、`pages/footer/` 由 Layout Feature 处理，不属于普通 Page。
 
 ## Client Boundary
 

package/lib/provider.js

@@ -1,6 +1,6 @@
-import { join, parse } from 'node:path';
+import { join, sep } from 'node:path';
 import { featureId } from '@zhin.js/plugin-runtime';
-import { defineFeatureProvider } from '@zhin.js/feature-kit';
+import { defineFeatureProvider, } from '@zhin.js/feature-kit';
 import { parsePageArtifact } from './definition.js';
 import { PageIndex } from './page-index.js';
 export const pageFeatureId = featureId('zhin.page');
@@ -11,11 +11,20 @@ const pageFiles = {
         const entries = [...await context.host.list(directory)]
             .sort((left, right) => left.name.localeCompare(right.name));
         for (const entry of entries) {
-            if (entry.kind !== 'file' || !isPageFile(entry.name))
+            if (entry.kind !== 'directory' || !isPageName(entry.name)
+                || entry.name === 'nav' || entry.name === 'footer')
+                continue;
+            const moduleDirectory = join(directory, entry.name);
+            const moduleEntries = await context.host.list(moduleDirectory);
+            const index = preferredPageIndex(moduleEntries, context.packageRoot.split(sep).includes('node_modules'));
+            if (!index)
                 continue;
             yield {
-                localName: parse(entry.name).name,
-                source: join(directory, entry.name),
+                localName: entry.name,
+                source: join(moduleDirectory, index),
+                relatedSources: moduleEntries
+                    .filter((candidate) => candidate.kind === 'file' && candidate.name !== index)
+                    .map((candidate) => join(moduleDirectory, candidate.name)),
                 target: 'client',
             };
         }
@@ -40,8 +49,15 @@ const pageFeature = defineFeatureProvider({
         },
     },
 });
-function isPageFile(value) {
-    return /^[a-z0-9][a-z0-9-]*\.tsx?$/u.test(value);
+function isPageName(value) {
+    return /^[a-z0-9][a-z0-9-]*$/u.test(value);
+}
+function preferredPageIndex(entries, preferJavaScript) {
+    const files = new Set(entries.filter((entry) => entry.kind === 'file').map((entry) => entry.name));
+    const extensions = preferJavaScript
+        ? ['js', 'mjs', 'cjs', 'ts', 'tsx']
+        : ['ts', 'tsx', 'js', 'mjs', 'cjs'];
+    return extensions.map((extension) => `index.${extension}`).find((name) => files.has(name));
 }
 export { pageFeature };
 export default pageFeature;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/page",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Convention-based Page capability Feature for Zhin.js plugins",
   "type": "module",
   "main": "./lib/index.js",
@@ -17,9 +17,9 @@
     "src"
   ],
   "dependencies": {
+    "@zhin.js/plugin-runtime": "1.1.11",
     "@zhin.js/console-contract": "1.1.0",
-    "@zhin.js/feature-kit": "1.1.0",
-    "@zhin.js/plugin-runtime": "1.1.9"
+    "@zhin.js/feature-kit": "1.1.2"
   },
   "devDependencies": {
     "@types/node": "^26.1.2",

package/src/provider.ts

@@ -1,6 +1,9 @@
-import { join, parse } from 'node:path';
+import { join, sep } from 'node:path';
 import { featureId } from '@zhin.js/plugin-runtime';
-import { defineFeatureProvider, type SourceConvention } from '@zhin.js/feature-kit';
+import {
+  defineFeatureProvider,
+  type SourceConvention,
+} from '@zhin.js/feature-kit';
 import { parsePageArtifact } from './definition.js';
 import { PageIndex } from './page-index.js';
 
@@ -13,10 +16,18 @@ const pageFiles: SourceConvention = {
     const entries = [...await context.host.list(directory)]
       .sort((left, right) => left.name.localeCompare(right.name));
     for (const entry of entries) {
-      if (entry.kind !== 'file' || !isPageFile(entry.name)) continue;
+      if (entry.kind !== 'directory' || !isPageName(entry.name)
+        || entry.name === 'nav' || entry.name === 'footer') continue;
+      const moduleDirectory = join(directory, entry.name);
+      const moduleEntries = await context.host.list(moduleDirectory);
+      const index = preferredPageIndex(moduleEntries, context.packageRoot.split(sep).includes('node_modules'));
+      if (!index) continue;
       yield {
-        localName: parse(entry.name).name,
-        source: join(directory, entry.name),
+        localName: entry.name,
+        source: join(moduleDirectory, index),
+        relatedSources: moduleEntries
+          .filter((candidate) => candidate.kind === 'file' && candidate.name !== index)
+          .map((candidate) => join(moduleDirectory, candidate.name)),
         target: 'client',
       };
     }
@@ -42,8 +53,19 @@ const pageFeature = defineFeatureProvider({
   },
 });
 
-function isPageFile(value: string): boolean {
-  return /^[a-z0-9][a-z0-9-]*\.tsx?$/u.test(value);
+function isPageName(value: string): boolean {
+  return /^[a-z0-9][a-z0-9-]*$/u.test(value);
+}
+
+function preferredPageIndex(
+  entries: readonly { readonly name: string; readonly kind: 'file' | 'directory' }[],
+  preferJavaScript: boolean,
+): string | undefined {
+  const files = new Set(entries.filter((entry) => entry.kind === 'file').map((entry) => entry.name));
+  const extensions = preferJavaScript
+    ? ['js', 'mjs', 'cjs', 'ts', 'tsx']
+    : ['ts', 'tsx', 'js', 'mjs', 'cjs'];
+  return extensions.map((extension) => `index.${extension}`).find((name) => files.has(name));
 }
 
 export { pageFeature };