ejs-precompile
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

EJS Precompile

Build & Test codecov Known Vulnerabilities npm version

This package is a CLI tool to precompile EJS templates into JavaScript functions. Additionally, it provides a Node.js API to precompile EJS templates.

Installation

npm install -g ejs-precompile

or locally in your project

npm install --save-dev ejs-precompile

Samples

Please check samples directory for more details.

Template Variables

Template variables can be passed to the template function as an object. The object can be passed as a first argument to the template function.

Variables can be accessed in the template using locals object.

const renderedTemplate = template.templateFunction({
    name: 'John',
});

Default Values

Default values for template variables can be passed to the precompile function as an object.

const template = await precompileTemplate({
    templateString: 'Hello, <%= locals.name %>!',
    defaults: {
        name: 'John',
    },
});
const renderedTemplate = template.templateFunction();

CLI Usage

ejs-precompile [options]

Options

Option Description Default
-i, --input Input file or directory. current working directory
-o, --output Output file or directory. Is has to be directory when input is directory. current working directory
-f, --file Output file name template, to be used together when input is directory.
Available variables: [name, ext, lang-ext].
- [name] - The name of the input file without extension.
- [ext] - The extension of the input file.
- [lang-ext] - The extension of the output file based on the language.
[name].template[lang-ext]
-l, --language Language of the output file. Default is "javascript".
Available languages: [javascript, typescript].
javascript
--ejs.client Returns standalone compiled function.
Please check EJS documentation for more details.
true
--ejs.strict When set to true, generated function is in strict mode.
Please check EJS documentation for more details.
true
-h, --help display help for command

API Usage

Precompile EJS template from file precompileFile

import { precompileFile } from 'ejs-precompile';

const template = await precompileFile({
    inputPath: inputPath,
    outputPath: outputPath,
    compileOptions: {
        strict: true,
        client: true,
    },
});
const renderedTemplate = template.templateFunction();

Precompile EJS templates from directory precompileDirectory

import { precompileDirectory } from 'ejs-precompile';

const templates = await precompileDirectory({
    inputPath: inputPath,
    outputPath: outputPath,
    compileOptions: {
        strict: true,
        client: true,
    },
});

for (const template of templates) {
    const renderedTemplate = template.templateFunction();
    // do something with renderedTemplate
}

Precompile EJS template from string precompileTemplate

import { precompileTemplate } from 'ejs-precompile';

const template = await precompileTemplate({
    templateString: 'Hello, world!',
    compileOptions: {
        strict: true,
        client: true,
    },
});

const renderedTemplate = template.templateFunction();

API

EjsCompileOptions

See "compile" function from EJS documentation

export type EjsCompileOptions = Parameters<typeof compile>[1];

precompileTemplate

Options:

export type PrecompileTemplateOptions = {
    /**
     * Path to the input file. Optional, works together with `outputPath`.
     */
    inputPath?: string | undefined;

    /**
     * Path to the output file. Optional, works together with `inputPath`.
     */
    outputPath?: string | undefined;

    /**
     * EJS template content.
     */
    inputContent: string;

    /**
     * EJS compile options.
     */
    compileOptions: EjsCompileOptions;

    /**
     * Default values for template variables.
     */
    defaults?: Record<string, unknown>;

    /**
     * Precompile options.
     */
    options?: PrecompileOptions;
};

Returns:

export type PrecompiledTemplate = {
    /**
     * EJS template content.
     */
    inputContent: string;

    /**
     * Generated JavaScript module content.
     */
    outputContent: string;

    /**
     * Compiled template function.
     */
    templateFunction: ReturnType<typeof compile>;
};

precompileFile

Options:

export type PrecompileFileOptions = {
    /**
     * Path to the input file. If relative, it will be resolved relative to the current working directory.
     */
    inputPath: string;

    /**
     * Path to the output file. If relative, it will be resolved relative to the current working directory.
     */
    outputPath: string;

    /**
     * EJS compile options.
     */
    compileOptions: EjsCompileOptions;

    /**
     * If `true`, the output file will be written to the file system.
     */
    write?: boolean;

    /**
     * Default values for template variables.
     */
    defaults?: Record<string, unknown>;

    /**
     * Precompile options.
     */
    options?: PrecompileOptions;
};

Returns:

export type PrecompiledFile = PrecompiledTemplate & {
    /**
     * Absolute path to the input file.
     */
    inputPath: string;

    /**
     * Absolute path to the output file.
     */
    outputPath: string;
};

precompileDirectory

Options:

export type PrecompileDirectoryOptions = {
    /**
     * Path to the input directory. If relative, it will be resolved relative to the current working directory.
     */
    inputPath: string;

    /**
     * Path to the output directory. If relative, it will be resolved relative to the current working directory.
     */
    outputPath: string;

    /**
     * Output file name template, to be used together when input is directory. Available variables: [name, ext, lang-ext].
     * @default '[name].template[lang-ext]'
     */
    fileNameTemplate?: string;

    /**
     * EJS compile options.
     */
    compileOptions: EjsCompileOptions;

    /**
     * If `true`, the output files will be written to the file system.
     */
    write?: boolean;

    /**
     * Default values for template variables.
     */
    defaults?: Record<string, unknown>;

    /**
     * Precompile options.
     */
    options?: PrecompileOptions;
};

Returns:

Array of PrecompiledFile

Package Sidebar

Install

npm i ejs-precompile

Weekly Downloads

11

Version

1.0.0

License

MIT

Unpacked Size

31.6 kB

Total Files

13

Last publish

Collaborators

  • eugenezinovyev