@digitalmaas/esbuild-plugin-ejs

中文文档
1.0.0发布于 2024/03/22MITTypeScriptCommonJS近 30 天下载 4481

An esbuild plugin that adds support for Embedded JavaScript Templates (.ejs) imports

原始使用文档
文档目录12 节
  1. Installation
  2. Setup
  3. Usage
  4. Options
  5. delimiter: string
  6. openDelimiter: string
  7. closeDelimiter: string
  8. localsName: string
  9. rmWhitespace: boolean
  10. async: boolean
  11. More Info
  12. License

Esbuild Embedded JavaScript Templates Plugin

NPM version NPM downloads digitalmaas

An esbuild plugin that adds support for Embedded JavaScript Templates (.ejs) imports.

Installation

npm install @digitalmaas/esbuild-plugin-ejs --save-dev

Setup

import esbuild from 'esbuild'
import ejsPlugin from '@digitalmaas/esbuild-plugin-ejs'

await esbuild.build({
  /* all of your config */,
  plugins: [
    ejsPlugin({ /* ejs options */ }),
  ]
})

Usage

<!-- template.ejs -->
<html>
  <head>
    <title><%= locals.title =></title>
  </head>
  <body>
    <% if (locals.isAdmin) { %>
      <div>ADMIN</div>
    <% } else { %>
      <div>USER</div>
    <% } %>
    <h1><%= locals.name %></h1>
  </body>
</html>
import template from './template.ejs'

const templateAsString = template({ isAdmin: false, title: 'Doc Title', name: 'Cool Test' })

Options

delimiter: string

Character to use for inner delimiter. Defaults to '%'.

openDelimiter: string

Character to use for opening delimiter. Defaults to '<'.

closeDelimiter: string

Character to use for closing delimiter. Defaults to '>'.

localsName: string

Name to use for the object storing local variables. Defaults to locals.

rmWhitespace: boolean

Remove all safe-to-remove whitespace, including leading and trailing whitespace. It also enables a safer version of `-%>`` line slurping for all scriptlet tags (it does not strip new lines of tags in the middle of a line).

async: boolean

When true, EJS will use an async function for rendering.

More Info

License

MIT License.

Complete license in ./LICENSE file.

版本与发布记录

@digitalmaas/esbuild-plugin-ejs 共发布 1 个版本,首次发布于 2024/03/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0latest2024/03/222 年前

关于 @digitalmaas/esbuild-plugin-ejs 的常见问题

@digitalmaas/esbuild-plugin-ejs 是什么?

An esbuild plugin that adds support for Embedded JavaScript Templates (.ejs) imports

如何安装 @digitalmaas/esbuild-plugin-ejs?

在项目目录运行 npm install @digitalmaas/esbuild-plugin-ejs,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:esbuild(>=0.18.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@digitalmaas/esbuild-plugin-ejs 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@digitalmaas/esbuild-plugin-ejs 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@digitalmaas/esbuild-plugin-ejs 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=14。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@digitalmaas/esbuild-plugin-ejs 可以商用吗?

@digitalmaas/esbuild-plugin-ejs 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@digitalmaas/esbuild-plugin-ejs 的下载量有多少?

根据 npm 官方下载统计,@digitalmaas/esbuild-plugin-ejs 在 2026/10/12 – 2026/11/10 这 30 天内被下载 4,481 次,日均约 149 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@digitalmaas/esbuild-plugin-ejs 还在维护吗?

最新版本 1.0.0 发布于 2024/03/22(2 年前);至今共发布 1 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/03/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。