@modern-js/plugin-ssg 1.2.6 → 1.2.9

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @modern-js/plugin-ssg
 
+## 1.2.9
+
+### Patch Changes
+
+- 04ae5262: chore: bump @modern-js/utils to v1.4.1 in dependencies
+- 60f7d8bf: feat: add tests dir to npmignore
+- Updated dependencies [b8599d09]
+- Updated dependencies [60f7d8bf]
+- Updated dependencies [3bf4f8b0]
+  - @modern-js/utils@1.5.0
+
+## 1.2.8
+
+### Patch Changes
+
+- 046e58aa: fix: plugin-analyze and plugin-ssg should not import method from core
+- Updated dependencies [77ff9754]
+- Updated dependencies [d2d1d6b2]
+- Updated dependencies [07a4887e]
+- Updated dependencies [ea2ae711]
+- Updated dependencies [17d0cc46]
+- Updated dependencies [d2d1d6b2]
+  - @modern-js/utils@1.4.0
+
+## 1.2.7
+
+### Patch Changes
+
+- bebb39b6: chore: improve devDependencies and peerDependencies
+- 132f7b53: feat: move config declarations to @modern-js/core
+- Updated dependencies [132f7b53]
+  - @modern-js/utils@1.3.7
+
 ## 1.2.6
 
 ### Patch Changes

package/dist/js/modern/index.js

@@ -35,7 +35,6 @@ export default (() => ({
         };
       },
 
-      // eslint-disable-next-line max-statements
       async afterBuild() {
         const resolvedConfig = api.useResolvedConfigContext();
         const appContext = api.useAppContext();
@@ -169,7 +168,7 @@ export default (() => ({
           ssgRoute.isSSR = false;
           ssgRoute.output = formatOutput(ssgRoute.output);
         });
-        const htmlAry = await createServer(ssgRoutes, pageRoutes, apiRoutes, resolvedConfig, appDirectory); // write to dist file
+        const htmlAry = await createServer(api, ssgRoutes, pageRoutes, apiRoutes, resolvedConfig, appDirectory); // write to dist file
 
         writeHtmlFile(htmlAry, ssgRoutes, buildDir); // format route info, side effect
 

package/dist/js/modern/server/index.js

@@ -1,10 +1,9 @@
 import childProcess from 'child_process';
 import path from 'path';
 import { logger } from '@modern-js/utils';
-import { useAppContext } from '@modern-js/core';
 import { openRouteSSR } from "../libs/util";
 import { CLOSE_SIGN } from "./consts";
-export const createServer = (ssgRoutes, pageRoutes, apiRoutes, options, appDirectory) => new Promise((resolve, reject) => {
+export const createServer = (api, ssgRoutes, pageRoutes, apiRoutes, options, appDirectory) => new Promise((resolve, reject) => {
   // this side of the shallow copy of a route for subsequent render processing, to prevent the modification of the current field
   // manually enable the server-side rendering configuration for all routes that require SSG
   const backup = openRouteSSR(pageRoutes);
@@ -13,7 +12,7 @@ export const createServer = (ssgRoutes, pageRoutes, apiRoutes, options, appDirec
     cwd: appDirectory,
     silent: true
   });
-  const appContext = useAppContext();
+  const appContext = api.useAppContext();
   const serverPlugins = appContext.plugins.filter(p => p.server).map(p => p.server);
   const plugins = serverPlugins.map(p => p.name);
   cp.send(JSON.stringify({

package/dist/js/modern/types.js

@@ -1 +0,0 @@
-import '@modern-js/core';

package/dist/js/node/index.js

@@ -52,7 +52,6 @@ var _default = () => ({
         };
       },
 
-      // eslint-disable-next-line max-statements
       async afterBuild() {
         const resolvedConfig = api.useResolvedConfigContext();
         const appContext = api.useAppContext();
@@ -187,7 +186,7 @@ var _default = () => ({
           ssgRoute.isSSR = false;
           ssgRoute.output = (0, _util.formatOutput)(ssgRoute.output);
         });
-        const htmlAry = await (0, _server.createServer)(ssgRoutes, pageRoutes, apiRoutes, resolvedConfig, appDirectory); // write to dist file
+        const htmlAry = await (0, _server.createServer)(api, ssgRoutes, pageRoutes, apiRoutes, resolvedConfig, appDirectory); // write to dist file
 
         (0, _output.writeHtmlFile)(htmlAry, ssgRoutes, buildDir); // format route info, side effect
 

package/dist/js/node/server/index.js

@@ -11,15 +11,13 @@ var _path = _interopRequireDefault(require("path"));
 
 var _utils = require("@modern-js/utils");
 
-var _core = require("@modern-js/core");
-
 var _util = require("../libs/util");
 
 var _consts = require("./consts");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const createServer = (ssgRoutes, pageRoutes, apiRoutes, options, appDirectory) => new Promise((resolve, reject) => {
+const createServer = (api, ssgRoutes, pageRoutes, apiRoutes, options, appDirectory) => new Promise((resolve, reject) => {
   // this side of the shallow copy of a route for subsequent render processing, to prevent the modification of the current field
   // manually enable the server-side rendering configuration for all routes that require SSG
   const backup = (0, _util.openRouteSSR)(pageRoutes);
@@ -30,7 +28,7 @@ const createServer = (ssgRoutes, pageRoutes, apiRoutes, options, appDirectory) =
     silent: true
   });
 
-  const appContext = (0, _core.useAppContext)();
+  const appContext = api.useAppContext();
   const serverPlugins = appContext.plugins.filter(p => p.server).map(p => p.server);
   const plugins = serverPlugins.map(p => p.name);
   cp.send(JSON.stringify({

package/dist/js/node/types.js

@@ -1,3 +0,0 @@
-"use strict";
-
-require("@modern-js/core");

package/dist/types/libs/make.d.ts

@@ -1,5 +1,5 @@
 import { ServerRoute as ModernRoute } from '@modern-js/types';
 import { compile } from '../server/prerender';
-import { RouteOptions, SsgRoute } from '../types';
+import { SSGRouteOptions, SsgRoute } from '../types';
 export declare function makeRender(ssgRoutes: SsgRoute[], render: ReturnType<typeof compile>, port: number): Promise<string>[];
-export declare function makeRoute(baseRoute: ModernRoute, route: string | RouteOptions, headers?: Record<string, any>): SsgRoute;
+export declare function makeRoute(baseRoute: ModernRoute, route: string | SSGRouteOptions, headers?: Record<string, any>): SsgRoute;

package/dist/types/libs/util.d.ts

@@ -1,5 +1,5 @@
 import { ServerRoute as ModernRoute } from '@modern-js/types';
-import { EntryPoint, MultiEntryOptions, SSG, SsgRoute } from '../types';
+import { SsgRoute, SSGConfig, EntryPoint, SSGMultiEntryOptions } from '../types';
 export declare function formatOutput(filename: string): string;
 export declare function formatPath(str: string): string;
 export declare function isDynamicUrl(url: string): boolean;
@@ -8,7 +8,7 @@ export declare function getOutput(route: SsgRoute, base: string, agreed?: boolea
 export declare const readJSONSpec: (dir: string) => ModernRoute[];
 export declare const writeJSONSpec: (dir: string, routes: ModernRoute[]) => void;
 export declare const replaceWithAlias: (base: string, filePath: string, alias: string) => string;
-export declare const standardOptions: (ssgOptions: SSG, entrypoints: EntryPoint[]) => false | MultiEntryOptions;
+export declare const standardOptions: (ssgOptions: SSGConfig, entrypoints: EntryPoint[]) => false | SSGMultiEntryOptions;
 export declare const openRouteSSR: (routes: ModernRoute[]) => {
   isSSR: boolean;
   bundle: string;

package/dist/types/server/index.d.ts

@@ -1,4 +1,4 @@
-import { NormalizedConfig } from '@modern-js/core';
+import type { NormalizedConfig, PluginAPI } from '@modern-js/core';
 import { ServerRoute as ModernRoute } from '@modern-js/types';
 import { SsgRoute } from '../types';
-export declare const createServer: (ssgRoutes: SsgRoute[], pageRoutes: ModernRoute[], apiRoutes: ModernRoute[], options: NormalizedConfig, appDirectory: string) => Promise<string[]>;
+export declare const createServer: (api: PluginAPI, ssgRoutes: SsgRoute[], pageRoutes: ModernRoute[], apiRoutes: ModernRoute[], options: NormalizedConfig, appDirectory: string) => Promise<string[]>;

package/dist/types/types.d.ts

@@ -1,5 +1,6 @@
-import { ServerRoute as ModernRoute } from '@modern-js/types';
-import '@modern-js/core';
+import type { ServerRoute as ModernRoute } from '@modern-js/types';
+import type { SSGConfig, SSGRouteOptions, SSGMultiEntryOptions, SSGSingleEntryOptions } from '@modern-js/core';
+export type { SSGConfig, SSGRouteOptions, SSGMultiEntryOptions, SSGSingleEntryOptions };
 export declare type AgreedRoute = {
   path: string;
   component: string;
@@ -17,24 +18,6 @@ export declare type SsgRoute = ModernRoute & {
   output: string;
   headers?: Record<string, string>;
 };
-export declare type RouteOptions = string | {
-  url: string;
-  output?: string;
-  params?: Record<string, any>[];
-  headers?: Record<string, any>;
-};
-export declare type SingleEntryOptions = boolean | {
-  preventDefault?: string[];
-  headers?: Record<string, any>;
-  routes?: RouteOptions[];
-};
-export declare type MultiEntryOptions = Record<string, SingleEntryOptions>;
-export declare type SSG = boolean | SingleEntryOptions | MultiEntryOptions | ((entryName: string) => SingleEntryOptions);
 export declare type ExtendOutputConfig = {
-  ssg: SSG;
-};
-declare module '@modern-js/core' {
-  interface OutputConfig {
-    ssg?: SSG;
-  }
-}
+  ssg: SSGConfig;
+};

package/jest.config.js

@@ -2,7 +2,6 @@ const sharedConfig = require('@scripts/jest-config');
 
 /** @type {import('@jest/types').Config.InitialOptions} */
 module.exports = {
-  // eslint-disable-next-line node/no-unsupported-features/es-syntax
   ...sharedConfig,
   rootDir: __dirname,
 };

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.2.6",
+  "version": "1.2.9",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -55,15 +55,15 @@
   },
   "dependencies": {
     "@babel/runtime": "^7",
-    "@modern-js/utils": "^1.3.5",
+    "@modern-js/utils": "^1.5.0",
     "node-mocks-http": "^1.10.1",
     "normalize-path": "^3.0.0",
     "portfinder": "^1.0.28",
     "react-router-dom": "^5.2.1"
   },
   "devDependencies": {
-    "@modern-js/types": "^1.3.5",
-    "@modern-js/prod-server": "^1.0.4",
+    "@modern-js/types": "^1.5.0",
+    "@modern-js/prod-server": "^1.1.1",
     "@types/jest": "^26",
     "@types/node": "^14",
     "@types/react": "^17",
@@ -71,7 +71,7 @@
     "@types/react-router": "^5.1.16",
     "@types/react-router-dom": "^5.1.8",
     "typescript": "^4",
-    "@modern-js/core": "^1.5.0",
+    "@modern-js/core": "1.8.0",
     "@scripts/build": "0.0.0",
     "jest": "^27",
     "@scripts/jest-config": "0.0.0"

package/tests/.eslintrc.js

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: ['@modern-js'],
-  parserOptions: {
-    project: require.resolve('./tsconfig.json'),
-  },
-};

package/tests/index.test.ts

@@ -1,8 +0,0 @@
-import plugin from '../src';
-
-describe('plugin-ssg', () => {
-  it('default', () => {
-    expect(plugin).toBeDefined();
-    expect(plugin().name).toBe('@modern-js/plugin-ssg');
-  });
-});

package/tests/lib.test.ts

@@ -1,104 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { ServerRoute as ModernRoute } from '@modern-js/types';
-import { exist, replaceRoute } from '../src/libs/replace';
-import { makeRoute } from '../src/libs/make';
-
-describe('test functional function', () => {
-  it('should check route exist correctly', () => {
-    const pageRoutes: ModernRoute[] = JSON.parse(
-      fs.readFileSync(path.join(__dirname, 'material/lib.route.json'), 'utf-8'),
-    ).routes;
-    const testRoutes = [
-      {
-        urlPath: '/lib/entry',
-        entryName: 'entry',
-        result: 0,
-      },
-      {
-        urlPath: '/lib/home',
-        entryName: 'home1',
-        result: -1,
-      },
-      {
-        urlPath: '/lib/home1',
-        entryName: 'home',
-        result: -1,
-      },
-      {
-        urlPath: '/lib/user',
-        entryName: 'mobile',
-        result: 2,
-      },
-      {
-        urlPath: '/lib/user',
-        entryName: 'pc',
-        result: 3,
-      },
-    ];
-    testRoutes.forEach(route => {
-      expect(exist(route as any, pageRoutes)).toBe(route.result);
-    });
-  });
-
-  it('should replace route correctly', () => {
-    const matrial = JSON.parse(
-      fs.readFileSync(
-        path.join(__dirname, 'material/replace.route.json'),
-        'utf-8',
-      ),
-    );
-
-    const { origin, ssg, final } = matrial;
-    const result = replaceRoute(ssg, origin);
-
-    expect(result).toEqual(final);
-  });
-
-  it('shoule generate route correctly', () => {
-    const baseRoute: ModernRoute = {
-      urlPath: '/foo',
-      isSPA: true,
-      isSSR: false,
-      entryName: 'foo',
-      isApi: false,
-      bundle: '',
-      entryPath: 'html/foo/index.html',
-    };
-
-    const route1 = makeRoute(baseRoute, '/baz');
-    expect(route1.urlPath).toBe('/foo/baz');
-    expect(route1.urlPath).toBe('/foo/baz');
-
-    const route2 = makeRoute(baseRoute, { url: '/baz' });
-    expect(route2.urlPath).toBe('/foo/baz');
-    expect(route2.output).toBe(path.normalize('html/foo/baz'));
-
-    const route3 = makeRoute(baseRoute, {
-      url: '/baz',
-      output: 'html/baz.html',
-    });
-    expect(route3.output).toBe(path.normalize('html/baz.html'));
-
-    const route4 = makeRoute(
-      baseRoute,
-      {
-        url: '/baz',
-      },
-      { ua: 'mobile' },
-    );
-    expect(route4.headers).toEqual({ ua: 'mobile' });
-
-    const route5 = makeRoute(
-      baseRoute,
-      {
-        url: '/baz',
-        headers: {
-          ua: 'pc',
-        },
-      },
-      { ua: 'mobile' },
-    );
-    expect(route5.headers).toEqual({ ua: 'pc' });
-  });
-});

package/tests/material/lib.route.json

@@ -1,24 +0,0 @@
-{
-  "routes": [
-    {
-      "urlPath": "/lib/entry",
-      "entryPath": "html/entry/index.html",
-      "entryName": "entry"
-    },
-    {
-      "urlPath": "/lib/home",
-      "entryPath": "html/home/index.html",
-       "entryName": "home"
-    },
-    {
-      "urlPath": "/lib/user",
-      "entryPath": "html/mobile/index.html",
-      "entryName": "mobile"
-    },
-    {
-      "urlPath": "/lib/user",
-      "entryPath": "html/mobile/index.html",
-      "entryName": "pc"
-    }
-  ]
-}

package/tests/material/replace.route.json

@@ -1,45 +0,0 @@
-{
-  "origin": [{
-      "urlPath": "/lib/entry",
-      "entryPath": "html/entry/index.html",
-      "entryName": "entry"
-  }, {
-      "urlPath": "/lib/home",
-      "entryPath": "html/home/index.html",
-      "entryName": "home"
-  }, {
-      "urlPath": "/lib/mobile",
-      "entryPath": "html/mobile/index.html",
-      "entryName": "mobile"
-  }],
-  "ssg": [{
-      "urlPath": "/lib/entry",
-      "entryPath": "html/entry/index.html",
-      "entryName": "entry"
-  }, {
-      "urlPath": "/lib/home",
-      "entryPath": "html/home.html",
-      "entryName": "home"
-  }, {
-      "urlPath": "/lib/pc",
-      "entryPath": "html/pc/index.html",
-      "entryName": "pc"
-  }],
-  "final": [{
-      "urlPath": "/lib/entry",
-      "entryPath": "html/entry/index.html",
-      "entryName": "entry"
-  }, {
-      "urlPath": "/lib/home",
-      "entryPath": "html/home.html",
-      "entryName": "home"
-  }, {
-      "urlPath": "/lib/mobile",
-      "entryPath": "html/mobile/index.html",
-      "entryName": "mobile"
-  }, {
-      "urlPath": "/lib/pc",
-      "entryPath": "html/pc/index.html",
-      "entryName": "pc"
-  }]
-}

package/tests/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "@modern-js/tsconfig/base",
-  "compilerOptions": {
-    "declaration": false,
-    "jsx": "preserve",
-    "baseUrl": "./",
-    "paths": {},
-    "esModuleInterop": true
-  }
-}

package/tests/util.test.ts

@@ -1,157 +0,0 @@
-import {
-  formatOutput,
-  formatPath,
-  isDynamicUrl,
-  getUrlPrefix,
-  getOutput,
-  replaceWithAlias,
-  standardOptions,
-  openRouteSSR,
-} from '../src/libs/util';
-
-describe('test ssg util function', () => {
-  it('should return format path correctly', () => {
-    const f1 = formatPath('foo');
-    expect(f1).toBe('/foo');
-
-    const f2 = formatPath('/foo/');
-    expect(f2).toBe('/foo');
-
-    const f3 = formatPath('foo/');
-    expect(f3).toBe('/foo');
-
-    const f4 = formatPath('./foo');
-    expect(f4).toBe('/foo');
-
-    const f5 = formatPath('/');
-    expect(f5).toBe('/');
-
-    const f6 = formatPath(1 as any);
-    expect(f6).toBe(1);
-  });
-
-  it('should detect dynamic url correctly', () => {
-    const d1 = isDynamicUrl('/:foo');
-    expect(d1).toBe(true);
-
-    const d2 = isDynamicUrl('/foo');
-    expect(d2).toBe(false);
-  });
-
-  it('should get url base correctly', () => {
-    const r1: any = { entryName: 'main' };
-    expect(getUrlPrefix(r1, '/')).toBe('');
-    expect(getUrlPrefix(r1, '/base')).toBe('/base');
-
-    const r2: any = { entryName: 'home' };
-    expect(getUrlPrefix(r2, '/')).toBe('/home');
-    expect(getUrlPrefix(r2, '/base')).toBe('/base/home');
-  });
-
-  it('should get output correctly', () => {
-    const r1: any = { urlPath: '/foo/a' };
-    expect(getOutput(r1, '', true)).toBe('foo/a');
-    expect(getOutput(r1, '/foo', true)).toBe('a');
-    expect(getOutput(r1, '/foo/a', true)).toBe('');
-
-    const r2 = {
-      urlPath: '/foo/a',
-      output: './foo/a.html',
-    };
-    expect(getOutput(r2 as any, '', false)).toBe(r2.output);
-    expect(getOutput(r2 as any, '/foo', true)).toBe(r2.output);
-  });
-
-  it('should return format output correctly', () => {
-    const entryPath1 = '/base/home/index.html';
-    expect(formatOutput(entryPath1)).toBe(entryPath1);
-
-    const entryPath2 = '/base/home';
-    expect(formatOutput(entryPath2)).toBe(entryPath1);
-  });
-
-  it('should replace alias correctly', () => {
-    expect(replaceWithAlias('/src', '/src/app.js', '@src')).toBe('@src/app.js');
-  });
-
-  // eslint-disable-next-line max-statements
-  it('should starndar user config correctly', () => {
-    const opt0 = standardOptions(false, []);
-    expect(opt0).toBeFalsy();
-
-    const opt1 = standardOptions(true, [{ entryName: 'main', entry: '' }]);
-    expect(opt1).toEqual({ main: true });
-
-    const opt2 = standardOptions(true, [
-      { entryName: 'main', entry: '' },
-      { entryName: 'home', entry: '' },
-    ]);
-    expect(opt2).toEqual({ main: true, home: true });
-
-    const opt3 = standardOptions(true, [
-      { entryName: 'main', entry: '' },
-      { entryName: 'home', entry: '' },
-    ]);
-    expect(opt3).toEqual({ main: true, home: true });
-
-    // single entry, object config
-    const ssg1 = {
-      routes: ['/foo', { url: '/baz' }],
-    };
-    const opt4 = standardOptions(ssg1, [{ entryName: 'main', entry: '' }]);
-    expect(opt4).toEqual({ main: ssg1 });
-
-    // error usage, just test
-    const ssg2 = {
-      routes: ['/foo', { url: '/baz' }],
-    };
-    const opt5 = standardOptions(ssg2, [
-      { entryName: 'main', entry: '' },
-      { entryName: 'home', entry: '' },
-    ]);
-    expect(opt5).toEqual(ssg2);
-
-    const ssg3 = {
-      main: { routes: ['/foo', { url: '/baz' }] },
-      home: false,
-    };
-    const opt6 = standardOptions(ssg3, [
-      { entryName: 'main', entry: '' },
-      { entryName: 'home', entry: '' },
-    ]);
-    expect(opt6).toEqual(ssg3);
-
-    const ssg4 = () => true;
-    const opt7 = standardOptions(ssg4, [
-      { entryName: 'main', entry: '' },
-      { entryName: 'home', entry: '' },
-    ]);
-    expect(opt7).toEqual({ main: true, home: true });
-
-    const ssg5 = (entryName: string) => {
-      if (entryName === 'main') {
-        return true;
-      } else {
-        return {
-          routes: ['/foo'],
-        };
-      }
-    };
-    const opt8 = standardOptions(ssg5, [
-      { entryName: 'main', entry: '' },
-      { entryName: 'home', entry: '' },
-    ]);
-    expect(opt8).toEqual({ main: true, home: { routes: ['/foo'] } });
-  });
-
-  it('should get ssr route correctly', () => {
-    const ssrRoutes = openRouteSSR([
-      {
-        isSSR: false,
-      },
-    ] as any);
-
-    expect(ssrRoutes[0].isSSR).toBeTruthy();
-    expect(ssrRoutes[0].bundle).toBeDefined();
-  });
-});