# grunt-parse-templates

> Parser for Styledeer templates

Latest version **0.5.3** (published 2015-04-27) · 0 weekly downloads

## Install

```sh
npm install grunt-parse-templates
pnpm add grunt-parse-templates
yarn add grunt-parse-templates
bun add grunt-parse-templates
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2015-04-27 |
| First published | 2015-02-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gabriel Zeck |
| Maintainers | gabezeck |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-parse-templates
- Repository: https://github.com/gzeck/grunt-parse-templates
- Issues: https://github.com/gzeck/grunt-parse-templates/issues
- npm.io page: https://npm.io/package/grunt-parse-templates

## Recent versions

- 0.5.3 (latest) — 2015-04-27
- 0.5.2 — 2015-04-27
- 0.5.1 — 2015-04-27
- 0.5.0 — 2015-04-27
- 0.4.9 — 2015-04-17
- 0.4.8 — 2015-04-17
- 0.4.7 — 2015-04-17
- 0.4.6 — 2015-04-09
- 0.4.5 — 2015-04-09
- 0.4.4 — 2015-04-07
- 0.4.3 — 2015-03-04
- 0.4.2 — 2015-03-04
- 0.4.1 — 2015-03-04
- 0.4.0 — 2015-03-02
- 0.3.9 — 2015-02-27
- … 15 more at https://npm.io/package/grunt-parse-templates/versions

## README

# grunt-parse-templates

> Parser for Angular style guide templates

## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-parse-templates --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-parse-templates');
```

## The "parsetemplates" task

This plugin is part of a larger project to create an Angular-based style guide / pattern library generator.
The end goal is to be able to create a fully functional guide by simply dropping Angular templates representing style blocks
into a folder structure.

The result of running this task is an Angular config file that sets up basic routing for the application.

### Overview
In your project's Gruntfile, add a section named `parsetemplates` to the data object passed into `grunt.initConfig()`.

The fileDir property should include the relative path to your template directory. This plugin will parse all subdirectories looking for templates
and create a JSON array of them.

The directory structure is important here and should look like this:

fileDir > page folder > section folders > files

Each page folder will correspond to an application page. Each section folder beneath that will be a section on that page with a header and each file will be a subsection beneath that.

The dataDir property should be the relative path of the directory you want to save the JSON output in. The file will be saved as templates.json.

The configDir should point to the location for your Angular application config.

The appName property should be the name of your Angular application (as defined in the app.js).

The baseTemplate property should point to the template file which will generate your style guide.

```js
grunt.initConfig({
  parsetemplates: {
    fileDir: '',
    dataDir: '',
    configDir: '',
    appName: '',
    baseTemplate: ''
  },
});
```

### Options

TBD

## Release History
_(Nothing yet)_

---
_Source: https://npm.io/package/grunt-parse-templates · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._