多应用入口
在第一个应用一文中,我们看到唯一的文件是src/entries/index.tsx
,这个路径是一种约定。
我们将所有的入口放置到了src/entries
中,这样带来的好处是可以支持一个应用有多个入口。
编写入口文件
src/entries
是一个特殊的目录,这个目录下的JavaScript文件代表着应用系统的一个入口,在完成构建后会对应一份HTML文件,用户可以通过HTML进行访问。
可以尝试修改一下你现成的项目,再增加一个入口文件:
/my-app
/src
/entrise
index.tsx
hello.tsx
reskript.config.ts
然后使用skr build
进行编译,可以看到它的编译产出:
/dist
/assets
hello.2e82f9ea88ad3b4a11ce.js
hello.2e82f9ea88ad3b4a11ce.js.map
index.24e7095a5771e54fb830.js
index.24e7095a5771e54fb830.js.map
hello-stable.html
index-stable.html
在现在这个阶段可以看到,在不需要任何配置的情况下,2个入口文件分别生成了:
- 与名称对应的JavaScript文件,包含hash并放置在
dist/assets
文件夹下。 - 与名称对应的HTML文件,放置在
dist
文件夹下。
自定义HTML模板
我们接着看一下生成的HTML的内容,此处将生成的HTML进行了一下格式化:
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>My App</title>
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no">
<meta name="app-version" content="0000000/stable@2019-03-26T11:29:10.550Z">
</head>
<body>
<script src="/assets/hello.2e82f9ea88ad3b4a11ce.js"></script>
</body>
</html>
可以看到这个HTML包含了基本的元素,包括title
、meta[charset]
、meta[viewport]
等,构建会生成一个meta[app-version]
的标签,它的值格式为{git-version}/{target}@{build-time}
,它能告诉你这个文件是从哪一个git提交上进行构建,构建时使用的目标(后续介绍)是什么,在什么时间完成构建,便于发现问题时进行排查。除此之外,HTML中仅包含了所有对应的JavaScript文件的引用,并没有其它的内容。
如果你需要应用放置在一个固定的<div>
元素中,比如常见的<div id="root">
,可以通过构建配置中的appContainerId
来设置,不需要额外增加自己的自定义模板文件,比如用下面的配置就能默认生成一个<div id="root"></div>
在HTML中:
export default configure(
'webpack',
{
build: {
appContainerId: 'root',
},
}
);
当然很多时候,我们还是希望能够定制HTML的结构,比如加入一些系统加载的动画等。在这种情况下,我们在src/entries
下放置一个与对应的JavaScript文件同名的.ejs
文件,例如我们编写一个src/entries/index.ejs
文件,写入以下内容:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title><%= htmlWebpackPlugin.options.title %></title>
<style>
#loading {
color: #0571bd;
font-size: 64px;
font-weight: bold;
}
</style>
</head>
<body>
<div id="loading">系统加载中……</div>
</body>
</html>
这个文件不需要单独写meta[viewport]
和meta[app-version]
,它们会自动生成,但是meta[charset]
却是必须的。在构建后,我们看到的dist/index-stable.html
将是以下内容(格式化后):
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>My App</title>
<style>
#loading {
color: #0571bd;
font-size: 64px;
font-weight: 700
}
</style>
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no">
<meta name="app-version" content="0000000/stable@2019-03-26T11:40:25.631Z">
</head>
<body>
<div id="loading">系统加载中……</div>
<script src="/assets/index.24e7095a5771e54fb830.js"></script>
</body>
</html>
在无需配置index.js
与index.ejs
的关系的情况下,构建系统会自动识别它们的关联并通过指定的.ejs
文件生成最终的HTML文件。
配置HTML生成
众所周知地,基于webpack
的工具使用html-webpack-plugin生成HTML文件,这个插件有着众多的配置,我们同样可以对它进行自定义。
我们可以在src/entries
下,放置一个与入口JavaScript文件同名的.config.{mjs|ts}
文件,如src/entries/hello.config.{mjs|ts}
文件,并放置以下内容:
export const html = {
meta: {
'X-UA-Compatible': {
'http-equiv': 'X-UA-Compatible',
content: 'IE=edge',
},
},
};
随后运行skr build
,并查看dist/hello-stable.html
(格式化后):
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>My App</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body>
<script src="/assets/hello.2e82f9ea88ad3b4a11ce.js"></script>
</body>
</html>
可以看到一个X-UA-Compatible
已经加入到了<head>
中。
总而言之,同名的.config.{mjs|ts}
中的export const html
将会提供一个用于html-webpack-plugin
的配置,用于控制生成HTML的逻辑。
自定义入口配置
在正常逻辑下,reSKRipt
会根据入口(src/entries/*
)文件生成对应的带有哈希的文件。如果你熟悉Webpack的入口配置,我们支持你做一些自定义的配置。
假设我们希望一个入口在产出时不要加上哈希,并指定一个固定的产出文件名,我们可以在src/entries
下,放置一个与入口JavaScript文件同名的.config.{mjs|ts}
文件,如src/entries/hello.config.{mjs|ts}
文件,并放置以下内容:
export const entry = {
filename: 'hello.dist.js',
};
随后运行skr build
,并查看dist/assets
目录,可以看到hello.dist.js
文件,并且该文件没有默认的哈希部分。
你同样可以参考此方法配置诸如dependOn
、library
等属性。
caution
请注意你无法配置import
属性,该属性强制为src/entries/hello.js
。
入口查找规则
对于一个指定的目录entriesDirectory
(通常是src/entries
),reSKRipt
会使用以下规则收集入口:
${entriesDirectory}/*.{js,ts,jsx,tsx}
作为入口文件,此时对应名称的*.ejs
作为可选的HTML模板,*.config.{mjs,ts}
作为可选的入口配置文件。${entriesDirectory}/*/index.{js,ts,jsx,tsx}
当*
为一个目录并且有index
命名的代码文件时,该文件作为入口,对应的*/index.ejs
作为可选的HTML模板,*/index.config.{mjs,ts}
作为可选的入口配置文件。
以src/entries
作为入口目录、.ts
作为配置文件为例,以下均是合法的入口:
src/entries/foo.js
、src/entries/foo.config.ts
、src/entries/foo.ejs
。src/entries/bar/index.js
、src/entries/bar/index.config.ts
、src/entries/bar/index.ejs
。
但目录结构只限一层,以下并不是合法的入口:
src/entries/foo/bar/index.js
,多层的目录不予收集。src/entries/foo/bar.js
,命名不是index.js
不予收集。
指定入口目录
默认情况下,reSKRipt
使用src/entries
作为入口目录,在该目录下寻找应用的入口文件。对于一些多页式的应用,往往会约定其它的名称,如src/pages
目录来集中放置入口文件。这种情况下,可以使用--entries-dir
指定入口存放的目录,如:
skr build --entries-dir=pages