Big News: Socket raises $60M Series C at a $1B valuation to secure software supply chains for AI-driven development.Announcement
Sign In

gulp-teddy

Package Overview
Dependencies
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gulp-teddy

Teddy template compiler gulp plugin

latest
Source
npmnpm
Version
1.6.2
Version published
Weekly downloads
11
266.67%
Maintainers
1
Weekly downloads
 
Created
Source

Build Status npm version Dependency Status semantic-release Commitizen friendly GitHub license

gulp-teddy

Compiles Teddy templates

Install

$ npm install --save-dev gulp-teddy

Usage

src/html/index.html

<!doctype html>
<html>

<head>
    <meta charset="utf-8">
    <meta name="description" content="">
    <meta name="viewport" content="width=device-width">
    <title>Title</title>
</head>

<body>
    <include src='templates/header.html'>
        <arg mainTitle>Main title</arg>
    </include>
</body>

</html>

src/html/templates/header.html

<header>
    <if mainTitle>
        <h1>{mainTitle}</h1>
    </if>
    <else>
        <p>No main title</p>
    </else>
</header>

gulpfile.js

var gulp  = require('gulp'),
    teddy = require('gulp-teddy').settings({
        setTemplateRoot: 'src/html/'
    });

gulp.task('default', () => gulp.src(['src/html/**/*.html','!src/html/templates/**/*.html'])
    .pipe(teddy.compile())
    .pipe(gulp.dest('dist'))
);

dist/index.html

<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8" />
    <meta name="description" content="" />
    <meta name="viewport" content="width=device-width" />
    <title>Title</title>
</head>

<body>
    <header>
        <h1>Main title</h1>
    </header>
</body>

</html>

Passing data

Passing data as an object

src/html/index.html

<!doctype html>
<html>

<head>
    <meta charset="utf-8">
    <meta name="description" content="">
    <meta name="viewport" content="width=device-width">
    <title>Title</title>
</head>

<body>
    <loop through='letters' val='letter'>
        <p>{letter}</p>
    </loop>
</body>

</html>

gulpfile.js

var gulp  = require('gulp'),
    teddy = require('gulp-teddy').settings({
        setTemplateRoot: 'src/html/'
    });

gulp.task('default', () => gulp.src(['src/html/**/*.html', '!src/html/templates/**/*.html'])
    .pipe(teddy.compile({
        letters: ['a', 'b', 'c']
    }))
    .pipe(gulp.dest('dist'))
);

dist/index.html

<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8" />
    <meta name="description" content="" />
    <meta name="viewport" content="width=device-width" />
    <title>Title</title>
</head>

<body>
    <p>a</p>
    <p>b</p>
    <p>c</p>
</body>

</html>

Passing data with gulp-data

For example from a json file, you can use it together the above example, your data will be merged (extended)

src/html/index.html

<!doctype html>
<html>

<head>
    <meta charset="utf-8">
    <meta name="description" content="">
    <meta name="viewport" content="width=device-width">
    <title>Title</title>
</head>

<body>
    <if subTitle>
        <h2>{subTitle}</h2>
    </if>
    <if subData and subData.level1>
        <ul>
            <loop through='subData.level1' key='name' val='text'>
                <li>
                    <strong>{name}</strong>
                    <br />{text}
                </li>
            </loop>
        </ul>
    </if>
</body>

</html>

src/data/index.json

{
    "subTitle": "Sub title",
    "subData": {
        "level1": {
            "sd1": "sub data 1",
            "sd2": "sub data 2",
            "sd3": "sub data 3"
        }
    }
}

gulpfile.js

var gulp = require('gulp'),
    data = require('gulp-data'),
    path = require('path'),
    teddy = require('gulp-teddy').settings({
        setTemplateRoot: 'src/html/templates/'
    });


gulp.task('default', function() {
    return gulp.src(['src/html/**/*.html', '!src/html/templates/**/*.html'])
        .pipe(data(function(file) {
            return require('./src/data/' + path.basename(file.path, '.html') + '.json');
        }))
        .pipe(teddy.compile({
            letters: ['a', 'b', 'c']
        }))
        .pipe(gulp.dest('dist'));
});

dist/index.html

<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8" />
    <meta name="description" content="" />
    <meta name="viewport" content="width=device-width" />
    <title>Title</title>
</head>

<body>
    <h2>Sub title</h2>
    <ul>
        <li>
            <strong>sd1</strong>
            <br/>sub data 1
        </li>
        <li>
            <strong>sd2</strong>
            <br/>sub data 2
        </li>
        <li>
            <strong>sd3</strong>
            <br/>sub data 3
        </li>
    </ul>
</body>

</html>

API

teddy.settings(options)

options

Type: Object

{
    setTemplateRoot: './',
    setVerbosity: 0,
    strictParser: false,
    enableForeachTag: false,
    compileAtEveryRender: false
}

See the Teddy docs.

teddy.compile(data)

data (optional)

Type: Object

Notes

The compile method executes the original teddy.render() method with a template path and the optional data param.

The original teddy.compile() method is not allowed, this plugin is for generating static html files with the help of the Teddy templating engine functionalities.

Keywords

gulpplugin

FAQs

Package last updated on 20 Jul 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts