@shuvi/platform-shared 1.0.13 → 1.0.14

package/esm/shared/helper/getAppData.js

@@ -9,7 +9,7 @@ export function getAppData() {
         return {
             ssr: false,
             filesByRoutId: {},
-            publicPath: ''
+            publicPath: '/'
         };
     }
     const el = document.getElementById(CLIENT_APPDATA_ID);
@@ -18,7 +18,7 @@ export function getAppData() {
             ssr: false,
             pageData: {},
             filesByRoutId: {},
-            publicPath: ''
+            publicPath: '/'
         };
     }
     return JSON.parse(el.textContent);

package/esm/shared/loader/loader.js

@@ -63,7 +63,7 @@ export function runInParallerAndBail(fns) {
 }
 function redirectHelper(to, status = 302) {
     if (process.env.NODE_ENV === 'development') {
-        invariant(typeof to === 'string', `redirect fist argument should be string, now is ${typeof to}`);
+        invariant(typeof to === 'string', `redirect's frist argument should be string, now is ${typeof to}`);
     }
     throw createRedirect(to, status);
 }

package/lib/node/route/matchSpec.d.ts

@@ -1,8 +1,14 @@
 export interface FileMatcherPatterns {
+    includePattern: string | undefined;
     excludePattern: string | undefined;
 }
-export declare function getRegularExpressionsForWildcards(specs: readonly string[] | undefined, basePath: string): readonly string[] | undefined;
-export declare function getRegularExpressionForWildcard(specs: readonly string[] | undefined, basePath: string, usage: 'exclude'): string | undefined;
+export declare type Usage = 'include' | 'exclude';
+export declare function getRegularExpressionsForWildcards(specs: readonly string[] | undefined, basePath: string, usage: Usage): readonly string[] | undefined;
+export declare function getRegularExpressionForWildcard(specs: readonly string[] | undefined, basePath: string, usage: Usage): string | undefined;
 export declare function getRegexFromPattern(pattern: string, caseSensitive: boolean): RegExp;
-export declare function getFileMatcherPatterns(basePath: string, excludes: readonly string[] | undefined): FileMatcherPatterns;
-export declare function matchFile(file: string, patterns: FileMatcherPatterns, caseSensitive: boolean): boolean;
+export declare function getFileMatcherPatterns(basePath: string, includes: readonly string[] | undefined, excludes: readonly string[] | undefined): FileMatcherPatterns;
+export declare function matchesSpecs(basePath: string, { includes, excludes, caseSensitive }: {
+    includes?: string[];
+    excludes?: string[];
+    caseSensitive: boolean;
+}): (path: string) => boolean;

package/lib/node/route/matchSpec.js

@@ -23,17 +23,21 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.matchFile = exports.getFileMatcherPatterns = exports.getRegexFromPattern = exports.getRegularExpressionForWildcard = exports.getRegularExpressionsForWildcards = void 0;
+exports.matchesSpecs = exports.getFileMatcherPatterns = exports.getRegexFromPattern = exports.getRegularExpressionForWildcard = exports.getRegularExpressionsForWildcards = void 0;
 // port from typescript
 const nodePath = __importStar(require("path"));
+const CharacterCodes = {
+    asterisk: 42,
+    question: 63
+};
 const directorySeparator = '/';
 // Reserved characters, forces escaping of any non-word (or digit), non-whitespace character.
 // It may be inefficient (we could just match (/[-[\]{}()*+?.,\\^$|#\s]/g), but this is future
 // proof.
 const reservedCharacterPattern = /[^\w\s\/]/g;
 const commonPackageFolders = ['node_modules'];
-// does not match centeain directories or directories that start with a . character
-const implicitExcludePathRegexPattern = `/((${commonPackageFolders.join('|')})|([/.][^/]*))`;
+// does not match centeain directories like node_modules
+const implicitExcludePathRegexPattern = `(?!(${commonPackageFolders.join('|')})(/|$))`;
 function replaceWildcardCharacter(match, singleAsteriskRegexFragment) {
     return match === '*'
         ? singleAsteriskRegexFragment
@@ -41,13 +45,29 @@ function replaceWildcardCharacter(match, singleAsteriskRegexFragment) {
             ? '[^/]'
             : '\\' + match;
 }
-const wildcardMatcher = {
+const includeMatcher = {
+    /**
+     * Matches any single directory segment except for directory separators.
+     */
+    singleAsteriskRegexFragment: '[^/]*',
+    /**
+     * Regex for the ** wildcard. Matches any number of subdirectories. When used for including
+     * files or directories, does not match subdirectories that start with a . character
+     */
+    doubleAsteriskRegexFragment: `(/${implicitExcludePathRegexPattern}[^/.][^/]*)*?`,
+    replaceWildcardCharacter: match => replaceWildcardCharacter(match, includeMatcher.singleAsteriskRegexFragment)
+};
+const excludeMatcher = {
     singleAsteriskRegexFragment: '[^/]*',
     doubleAsteriskRegexFragment: '(/.+?)?',
-    replaceWildcardCharacter: match => replaceWildcardCharacter(match, wildcardMatcher.singleAsteriskRegexFragment)
+    replaceWildcardCharacter: match => replaceWildcardCharacter(match, excludeMatcher.singleAsteriskRegexFragment)
+};
+const wildcardMatchers = {
+    include: includeMatcher,
+    exclude: excludeMatcher
 };
 /**
- * An "includes" path "foo" is implicitly a glob "foo/** /*" (without the space) if its last component has no extension,
+ * An "includes" or "exclude" path "foo" is implicitly a glob "foo/** /*" (without the space) if its last component has no extension,
  * and does not contain any glob characters itself.
  */
 function isImplicitGlob(lastPathComponent) {
@@ -65,7 +85,7 @@ function getNormalizedPathComponents(path, currentDirectory) {
         comps.pop();
     return comps;
 }
-function getSubPatternFromSpec(spec, basePath, { doubleAsteriskRegexFragment, replaceWildcardCharacter }) {
+function getSubPatternFromSpec(spec, basePath, usage, { singleAsteriskRegexFragment, doubleAsteriskRegexFragment, replaceWildcardCharacter }) {
     let subpattern = '';
     let hasWrittenComponent = false;
     const components = getNormalizedPathComponents(spec, basePath);
@@ -83,20 +103,47 @@ function getSubPatternFromSpec(spec, basePath, { doubleAsteriskRegexFragment, re
             if (hasWrittenComponent) {
                 subpattern += directorySeparator;
             }
-            subpattern += component.replace(reservedCharacterPattern, replaceWildcardCharacter);
+            if (usage !== 'exclude') {
+                let componentPattern = '';
+                // The * and ? wildcards should not match directories or files that start with . if they
+                // appear first in a component. Dotted directories and files can be included explicitly
+                // like so: **/.*/.*
+                if (component.charCodeAt(0) === CharacterCodes.asterisk) {
+                    componentPattern += '([^./]' + singleAsteriskRegexFragment + ')?';
+                    component = component.substring(1);
+                }
+                else if (component.charCodeAt(0) === CharacterCodes.question) {
+                    componentPattern += '[^./]';
+                    component = component.substring(1);
+                }
+                componentPattern += component.replace(reservedCharacterPattern, replaceWildcardCharacter);
+                // Patterns should not include subfolders like node_modules unless they are
+                // explicitly included as part of the path.
+                //
+                // As an optimization, if the component pattern is the same as the component,
+                // then there definitely were no wildcard characters and we do not need to
+                // add the exclusion pattern.
+                if (componentPattern !== component) {
+                    subpattern += implicitExcludePathRegexPattern;
+                }
+                subpattern += componentPattern;
+            }
+            else {
+                subpattern += component.replace(reservedCharacterPattern, replaceWildcardCharacter);
+            }
         }
         hasWrittenComponent = true;
     }
     return subpattern;
 }
-function getRegularExpressionsForWildcards(specs, basePath) {
+function getRegularExpressionsForWildcards(specs, basePath, usage) {
     if (specs === undefined || specs.length === 0) {
         return undefined;
     }
     const result = [];
     for (const spec of specs) {
         if (spec) {
-            let r = getSubPatternFromSpec(spec, basePath, wildcardMatcher);
+            let r = getSubPatternFromSpec(spec, basePath, usage, wildcardMatchers[usage]);
             if (r) {
                 result.push(r);
             }
@@ -106,12 +153,12 @@ function getRegularExpressionsForWildcards(specs, basePath) {
 }
 exports.getRegularExpressionsForWildcards = getRegularExpressionsForWildcards;
 function getRegularExpressionForWildcard(specs, basePath, usage) {
-    const patterns = getRegularExpressionsForWildcards(specs, basePath);
+    const patterns = getRegularExpressionsForWildcards(specs, basePath, usage);
     if (!patterns || !patterns.length) {
         return undefined;
     }
     const pattern = patterns.map(pattern => `(${pattern})`).join('|');
-    // If excluding, match "foo/bar/baz...", but if including, only allow "foo".
+    // If excluding, match "foo/", but if including, only allow "foo".
     const terminator = usage === 'exclude' ? '($|/)' : '$';
     return `^(${pattern})${terminator}`;
 }
@@ -120,19 +167,29 @@ function getRegexFromPattern(pattern, caseSensitive) {
     return new RegExp(pattern, caseSensitive ? '' : 'i');
 }
 exports.getRegexFromPattern = getRegexFromPattern;
-function getFileMatcherPatterns(basePath, excludes) {
+function getFileMatcherPatterns(basePath, includes, excludes) {
     const absolutePath = normalizePath(basePath);
     return {
+        includePattern: getRegularExpressionForWildcard(includes, absolutePath, 'include'),
         excludePattern: getRegularExpressionForWildcard(excludes, absolutePath, 'exclude')
     };
 }
 exports.getFileMatcherPatterns = getFileMatcherPatterns;
-function matchFile(file, patterns, caseSensitive) {
-    file = normalizePath(file);
+function matchesSpecs(basePath, { includes, excludes, caseSensitive }) {
+    const patterns = getFileMatcherPatterns(basePath, includes, excludes);
+    const includeRegex = patterns.includePattern &&
+        getRegexFromPattern(patterns.includePattern, caseSensitive);
     const excludeRegex = patterns.excludePattern &&
         getRegexFromPattern(patterns.excludePattern, caseSensitive);
-    const implicitExcludeRegex = getRegexFromPattern(implicitExcludePathRegexPattern, caseSensitive);
-    return (!implicitExcludeRegex.test(file) &&
-        (!excludeRegex || !excludeRegex.test(file)));
+    if (includeRegex) {
+        if (excludeRegex) {
+            return path => !(includeRegex.test(path) && !excludeRegex.test(path));
+        }
+        return path => !includeRegex.test(path);
+    }
+    if (excludeRegex) {
+        return path => excludeRegex.test(path);
+    }
+    return () => true;
 }
-exports.matchFile = matchFile;
+exports.matchesSpecs = matchesSpecs;

package/lib/node/route/route.d.ts

@@ -28,7 +28,19 @@ export declare type PageRoutes = RouteResult<IPageRouteConfig>;
 export declare type ApiRoutes = RouteResult<IApiRouteConfig>;
 export declare type MiddlewareRoutes = RouteResult<IMiddlewareRouteConfig>;
 export declare type RouteConfigType = IPageRouteConfig | IApiRouteConfig | IMiddlewareRouteConfig;
-export declare const getRawRoutesFromDir: (dirname: string, excludes?: string[]) => Promise<RawRoutes>;
-export declare const getPageRoutes: (dir: string | RawRoutes, excludes?: string[]) => Promise<PageRoutes>;
-export declare const getApiRoutes: (dir: string | RawRoutes, excludes?: string[]) => Promise<ApiRoutes>;
-export declare const getMiddlewareRoutes: (dir: string | RawRoutes, excludes?: string[]) => Promise<MiddlewareRoutes>;
+export declare const getRawRoutesFromDir: (dirname: string, { includes, excludes }: {
+    includes?: string[] | undefined;
+    excludes?: string[] | undefined;
+}) => Promise<RawRoutes>;
+export declare const getPageRoutes: (dir: string | RawRoutes, { includes, excludes }?: {
+    includes?: string[] | undefined;
+    excludes?: string[] | undefined;
+}) => Promise<PageRoutes>;
+export declare const getApiRoutes: (dir: string | RawRoutes, { includes, excludes }?: {
+    includes?: string[] | undefined;
+    excludes?: string[] | undefined;
+}) => Promise<ApiRoutes>;
+export declare const getMiddlewareRoutes: (dir: string | RawRoutes, { includes, excludes }?: {
+    includes?: string[] | undefined;
+    excludes?: string[] | undefined;
+}) => Promise<MiddlewareRoutes>;

package/lib/node/route/route.js

@@ -14,7 +14,7 @@ const path_1 = require("path");
 const file_1 = require("@shuvi/utils/file");
 const helpers_1 = require("./helpers");
 const matchSpec_1 = require("./matchSpec");
-const getRawRoutesFromDir = (dirname, excludes) => __awaiter(void 0, void 0, void 0, function* () {
+const getRawRoutesFromDir = (dirname, { includes, excludes }) => __awaiter(void 0, void 0, void 0, function* () {
     const rootDirname = dirname;
     if (!(yield (0, file_1.isDirectory)(rootDirname))) {
         return {
@@ -26,7 +26,11 @@ const getRawRoutesFromDir = (dirname, excludes) => __awaiter(void 0, void 0, voi
     const warnings = [];
     const errors = [];
     const routes = [];
-    const patterns = (0, matchSpec_1.getFileMatcherPatterns)(rootDirname, excludes);
+    const shouldExclude = (0, matchSpec_1.matchesSpecs)(rootDirname, {
+        includes: includes && includes.length > 0 ? includes : ['**/*'],
+        excludes,
+        caseSensitive: false
+    });
     const visitDirectory = (dirname, routes, parentDir) => __awaiter(void 0, void 0, void 0, function* () {
         const files = yield (0, helpers_1.getAllowFilesAndDirs)(dirname);
         if (!files.length) {
@@ -43,7 +47,7 @@ const getRawRoutesFromDir = (dirname, excludes) => __awaiter(void 0, void 0, voi
                 // this is required for matchFile to wrok properly
                 filepath = (0, path_1.join)(filepath, path_1.sep);
             }
-            if (!(0, matchSpec_1.matchFile)(filepath, patterns, false)) {
+            if (shouldExclude(filepath)) {
                 continue;
             }
             const segment = parentDir === '' ? '/' : (0, helpers_1.normalizeRoutePath)(parentDir);
@@ -77,10 +81,10 @@ const getRawRoutesFromDir = (dirname, excludes) => __awaiter(void 0, void 0, voi
     };
 });
 exports.getRawRoutesFromDir = getRawRoutesFromDir;
-const getPageRoutes = (dir, excludes) => __awaiter(void 0, void 0, void 0, function* () {
+const getPageRoutes = (dir, { includes, excludes } = {}) => __awaiter(void 0, void 0, void 0, function* () {
     let raw;
     if (typeof dir === 'string') {
-        raw = yield (0, exports.getRawRoutesFromDir)(dir, excludes);
+        raw = yield (0, exports.getRawRoutesFromDir)(dir, { excludes });
     }
     else {
         raw = dir;
@@ -124,10 +128,10 @@ const getPageRoutes = (dir, excludes) => __awaiter(void 0, void 0, void 0, funct
     };
 });
 exports.getPageRoutes = getPageRoutes;
-const getApiRoutes = (dir, excludes) => __awaiter(void 0, void 0, void 0, function* () {
+const getApiRoutes = (dir, { includes, excludes } = {}) => __awaiter(void 0, void 0, void 0, function* () {
     let raw;
     if (typeof dir === 'string') {
-        raw = yield (0, exports.getRawRoutesFromDir)(dir, excludes);
+        raw = yield (0, exports.getRawRoutesFromDir)(dir, { excludes });
     }
     else {
         raw = dir;
@@ -177,10 +181,10 @@ const getApiRoutes = (dir, excludes) => __awaiter(void 0, void 0, void 0, functi
     };
 });
 exports.getApiRoutes = getApiRoutes;
-const getMiddlewareRoutes = (dir, excludes) => __awaiter(void 0, void 0, void 0, function* () {
+const getMiddlewareRoutes = (dir, { includes, excludes } = {}) => __awaiter(void 0, void 0, void 0, function* () {
     let raw;
     if (typeof dir === 'string') {
-        raw = yield (0, exports.getRawRoutesFromDir)(dir, excludes);
+        raw = yield (0, exports.getRawRoutesFromDir)(dir, { excludes });
     }
     else {
         raw = dir;

package/lib/shared/helper/getAppData.js

@@ -12,7 +12,7 @@ function getAppData() {
         return {
             ssr: false,
             filesByRoutId: {},
-            publicPath: ''
+            publicPath: '/'
         };
     }
     const el = document.getElementById(constants_1.CLIENT_APPDATA_ID);
@@ -21,7 +21,7 @@ function getAppData() {
             ssr: false,
             pageData: {},
             filesByRoutId: {},
-            publicPath: ''
+            publicPath: '/'
         };
     }
     return JSON.parse(el.textContent);

package/lib/shared/loader/loader.js

@@ -70,7 +70,7 @@ function runInParallerAndBail(fns) {
 exports.runInParallerAndBail = runInParallerAndBail;
 function redirectHelper(to, status = 302) {
     if (process.env.NODE_ENV === 'development') {
-        (0, invariant_1.default)(typeof to === 'string', `redirect fist argument should be string, now is ${typeof to}`);
+        (0, invariant_1.default)(typeof to === 'string', `redirect's frist argument should be string, now is ${typeof to}`);
     }
     throw (0, response_1.redirect)(to, status);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuvi/platform-shared",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/shuvijs/shuvi.git",
@@ -83,17 +83,17 @@
     "node": ">= 16.0.0"
   },
   "dependencies": {
-    "@shuvi/hook": "1.0.13",
+    "@shuvi/hook": "1.0.14",
     "doura": "0.0.7",
-    "@shuvi/router": "1.0.13",
-    "@shuvi/runtime": "1.0.13",
-    "@shuvi/shared": "1.0.13",
-    "@shuvi/toolpack": "1.0.13",
-    "@shuvi/utils": "1.0.13",
+    "@shuvi/router": "1.0.14",
+    "@shuvi/runtime": "1.0.14",
+    "@shuvi/shared": "1.0.14",
+    "@shuvi/toolpack": "1.0.14",
+    "@shuvi/utils": "1.0.14",
     "redux": "4.1.2"
   },
   "peerDependencies": {
-    "@shuvi/service": "1.0.13"
+    "@shuvi/service": "1.0.14"
   },
   "devDependencies": {
     "@shuvi/service": "workspace:*",