# @flownet/lib-render-templates-dir

> ## Introduction

Latest version **0.1.19** (published 2024-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @flownet/lib-render-templates-dir
pnpm add @flownet/lib-render-templates-dir
yarn add @flownet/lib-render-templates-dir
bun add @flownet/lib-render-templates-dir
```

Provides the commands `lib-render-templates-dir`, `fnet-render-templates-dir`.

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.19 |
| Published | 2024-11-14 |
| First published | 2023-07-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 24.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | gboyraz |

## Links

- npm: https://www.npmjs.com/package/@flownet/lib-render-templates-dir
- Repository: https://gitlab.com/fnetai/render-templates-dir
- Homepage: https://gitlab.com/fnetai/render-templates-dir#readme
- Issues: https://gitlab.com/fnetai/render-templates-dir/issues
- npm.io page: https://npm.io/package/@flownet/lib-render-templates-dir

## Dependencies (3)

- [nunjucks](https://npm.io/package/nunjucks.md) ^3.2
- [@fnet/args](https://npm.io/package/@fnet/args.md) ^0.1
- [@fnet/list-files](https://npm.io/package/@fnet/list-files.md) ^0.1

## Recent versions

- 0.1.19 (latest) — 2024-11-14
- 0.1.18 — 2024-11-14
- 0.1.17 — 2024-10-02
- 0.1.16 — 2024-10-02
- 0.1.15 — 2024-10-02
- 0.1.14 — 2024-02-23
- 0.1.13 — 2024-02-22
- 0.1.12 — 2023-10-06
- 0.1.11 — 2023-09-21
- 0.1.10 — 2023-09-13
- 0.1.9 — 2023-09-12
- 0.1.8 — 2023-08-31
- 0.1.7 — 2023-07-24
- 0.1.6 — 2023-07-24
- 0.1.5 — 2023-07-22
- … 4 more at https://npm.io/package/@flownet/lib-render-templates-dir/versions

## README

# @flownet/lib-render-templates-dir

## Introduction

The `@flownet/lib-render-templates-dir` is a utility designed for processing and rendering template files. This tool focuses on transforming Nunjucks templates into static files based on a given context, which can then be saved to a specified output directory. The utility is straightforward, offering a structured way to manage and render templates in large directory structures.

## How It Works

This utility works by scanning a designated directory for Nunjucks template files, specified by a pattern. It then compiles these templates within the context provided by the user, and writes the rendered output to a chosen output directory. Additionally, the utility can also copy files that do not match the template pattern to the output directory, if configured to do so.

## Key Features

- **Template Rendering**: Compiles and renders Nunjucks template files using a specified context.
- **File Management**: Supports listing and processing files in directory structures.
- **Configurable Output**: Allows specifying an output directory and customizing whether to overwrite existing files.
- **Unmatched File Handling**: Provides an option to copy files that do not match the template pattern to the output directory.

## Conclusion

The `@flownet/lib-render-templates-dir` utility offers a practical way to render and manage Nunjucks templates across directories. Its straightforward approach makes it a useful tool for projects that require automatic template rendering and file management.


# Developer Guide for @flownet/lib-render-templates-dir

## Overview

The `@flownet/lib-render-templates-dir` library is a utility designed to streamline the rendering of Nunjucks templates from a specified directory. It offers a simple interface to render templates and optionally copies non-template files to an output directory. This can be particularly useful for generating static websites, configuration files, or any batch processing of templated content.

## Installation

To use the `@flownet/lib-render-templates-dir` library, you can install it via npm or yarn:

```sh
# Using npm
npm install @flownet/lib-render-templates-dir

# Using yarn
yarn add @flownet/lib-render-templates-dir
```

## Usage

The primary function provided by the library is `index`, which takes an options object to specify the input directory, output directory, and rendering context among other parameters. Below is a practical example on how to use the library to render templates.

### Example

```javascript
import renderTemplates from '@flownet/lib-render-templates-dir';

async function renderMyTemplates() {
  try {
    const result = await renderTemplates({
      dir: './templates',           // Directory containing the Nunjucks templates
      pattern: '**/*.njk',          // Pattern to match template files
      outDir: './dist',             // Output directory
      context: { title: 'Hello World' },  // Context for rendering the templates
      copyUnmatchedAlso: true,      // Option to copy files not matching the pattern
      overwriteExisting: true,      // Option to overwrite existing files in the output directory
      ignore: ['**/ignore/**']      // Pattern of files to ignore
    });

    console.log('Rendered files:', result.files);
    console.log('Unmatched files:', result.unmatched);
  } catch (error) {
    console.error('Error rendering templates:', error);
  }
}

renderMyTemplates();
```

## Functionality Explained

- **`dir`**: The directory containing your Nunjucks templates.
- **`pattern`**: A file pattern to identify which files in the directory are templates. Defaults to `**/*.njk`.
- **`outDir`**: The directory where rendered files will be output.
- **`context`**: An object containing variables to be used during template rendering.
- **`copyUnmatchedAlso`/`unmatched`**: If true, files not matching the template pattern are also copied to the output directory. The `unmatched` option is preferred; `copyUnmatchedAlso` is deprecated.
- **`overwriteExisting`**: When set to true, any existing files at the destination will be overwritten by newly rendered or copied files.
- **`ignore`**: A pattern or array of patterns specifying which files to ignore in the source directory.

## Acknowledgement

This library utilizes `nunjucks` for template rendering and `@fnet/list-files` for file pattern matching. These utilities help simplify file handling and rendering processes in the library.



# Input Schema
```yaml
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
  dir:
    type: string
    description: Directory path to locate templates
  pattern:
    type: string
    description: Glob pattern to match template files
    default: "**/*.njk"
  outDir:
    type: string
    description: Output directory to store rendered files
  context:
    type: object
    description: Context object to populate templates
  copyUnmatchedAlso:
    type: boolean
    description: Flag to copy unmatched files as well
    default: false
  overwriteExisting:
    type: boolean
    description: Flag to overwrite existing files
    default: false
  ignore:
    type: array
    description: List of patterns to ignore
    items:
      type: string
  unmatched:
    type: boolean
    description: Flag to copy unmatched files (alias for copyUnmatchedAlso)
required:
  - dir
  - outDir

```

---
_Source: https://npm.io/package/@flownet/lib-render-templates-dir · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._