1.1.8 • Published 7 months ago

ejsc-views v1.1.8

Weekly downloads
-
License
ISC
Repository
github
Last release
7 months ago

EJS Compiler CLI Tool

The EJS Compiler is a CLI tool for compiling .ejs templates into a single JavaScript file. This simplifies including precompiled views in your projects, improving efficiency and maintainability.

Compatibility: Node 16.14.0 and later


Features

  • Compiles all .ejs files, including nested ones, into a single JavaScript file.
  • Supports detailed compilation logs for debugging and verification.
  • Works cross-platform (Windows, macOS, Linux).
  • Easy-to-use CLI interface or programmatic integration.

Installation

1. Install Globally

To install globally for CLI usage:

npm install -g ejsc-views

2. Local Installation

For usage in a specific project:

npm install ejsc-views

Usage

Method 1: CLI

Run the compiler directly via the terminal.

Syntax:

ejsc [options]

Options:

OptionDescriptionDefault
-v, --views <views>Directory containing .ejs templates.views
-o, --output <output>Directory for the compiled JavaScript output file.public/js
-d, --detailsDisplay detailed logs during the compilation.Off
-h, --helpDisplay help for the CLI.N/A

Examples:

  1. Compile .ejs templates in src/views and save the output in dist/js:

    ejsc --views src/views --output dist/js
  2. Compile with detailed logs enabled:

    ejsc --views src/views --output dist/js --details

Method 2: Programmatic Integration

You can integrate the compiler into your Node.js scripts.

Example Code:

import { compile } from "ejs-compile";

const viewsDir = "src/views";
const outputDir = "dist/js";
const details = true; // Enable detailed logs

compile(viewsDir, outputDir, details);

Parameters:

ParameterTypeDescriptionDefault
viewsDirStringDirectory containing .ejs templates."views"
outputDirStringDirectory for the compiled JavaScript output file."public/js"
detailsBooleanWhether to display detailed logs during compilation.false

Output

The output is a single JavaScript file containing all compiled .ejs templates. By default, this file is saved as public/js/views.js.

The compiled file includes: 1. Precompiled views as functions. 2. A helper function ejs.views_include for including templates programmatically.


1.1.1

7 months ago

1.1.0

7 months ago

1.1.8

7 months ago

1.1.7

7 months ago

1.1.6

7 months ago

1.1.5

7 months ago

1.1.4

7 months ago

1.1.3

7 months ago

1.1.2

7 months ago

1.0.7

3 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

1.0.0

3 years ago