@ gouvfr- lasite/ 整合 npm 软件包
这个 @gouvfr-lasuite/integration npm 软件包帮助服务 法语套接字 带有常见的 React 和 HTML 模板 套间 乌伊斯.
目前,它帮助开发者整合:
- (单位:千美元) 套间 品牌主页
- 页:1 高弗尔 ("waffle")按钮,可以让服务用户轻松地在两者之间切换 套间 服务.
使用量
npm install @gouvfr-lasuite/integration
如果使用React,可以直接消耗所暴露的React组件.
如果您使用其他任何工具, 您可以从 HTML 模板中复制并粘贴内容 dist/html 文件夹.
中央支助系统也提供。 取决于是否使用 联邦,您可以使用来自 dist/css。 。 。 .
关于使用情况的精确文件见 集成. lassuite.numerique.gouv.fr。 。 。 .
发展
此文件夹旨在生成 @gouvfr-lasuite/integration npm 软件包.
维特应用.
开始, npm install 第一次并复制示例 env 文件 : cp .env.example .env确保API Env var瞄准运行中的API. 如果你不想使用制作器,你可以轻松地在本地运行: API通过 /website 服务器,去检查 README那里.
然后,用 npm run dev。 。 。 .
主 dev 文件为 src/dev/dev.tsx 用于在开发时制作不同的反应组件.
大楼
运行 npm run build 来建造所有 dist/ 文件是: React 组件、 CSS 文件和 HTML 模板.
内部,建造这一切 比你通常的Vite应用程序有点不同。 我们实际上使用三个虚拟配置,并运行 npm run build 运行全部 :
反应组件
默认构建会以 vite "lib" 模式生成 es6 和 commonjs 文件的 React 组件. 里面的东西 src/index.ts 在生成文件中被曝光.
支助科
这个 css-config 构建生成 CSS 文件 。 皆通入净相. 要生成的 CSS 文件列表在 fs vite 配置中.
CSS的渲染是这样的,而不是通过主 vite 配置,因为使用 lib 模式的 CSS 渲染不能让我们在使用 postcs-config 时轻易生成多个 CSS 文件.
HTML 文件
这个 html-config 生成 HTML 文件.
HTML 文件不是手写的:它们来自反应组件。 html vite 配置检查 src/html.tsx 并让 HTML 文件用于列出每个模板.
发布一个新的 npm 软件包
- 运行
npm version与两个major, (中文(简体) ),minor或者说patch来敲打版本。 目前还没有精确的版本策略,但遵循semver是一个好主意. 所以: 打破更改应该是major更新,新功能应该是minor更新和错误修正应该是patch更新. - 添加新条目
CHANGELOG.md用于描述更改的文件. - : 警告: 确保您的本地
.env文件使用生产值. - 运行
npm pack以本地生成新的焦油球。 很容易在发布之前手动核实包是好的. - 运行
npm publish在 npm 上发布软件包. - 执行您的修改.
- 在此新任务上创建 git 标签 :
integration-vX.X.X。 。 。 . - 将主分行和新标记推到github上.