# grunt-tpcheck

> template check plugin

Latest version **0.3.0** (published 2014-12-04) · 0 weekly downloads

## Install

```sh
npm install grunt-tpcheck
pnpm add grunt-tpcheck
yarn add grunt-tpcheck
bun add grunt-tpcheck
```

## 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.3.0 |
| Published | 2014-12-04 |
| First published | 2014-11-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alvin Hui |
| Maintainers | alvinhui |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-tpcheck
- Repository: https://github/alvinhui/grunt-tpcheck
- Homepage: https://github.com/alvinhui/grunt-tpcheck
- Issues: https://github.com/alvinhui/grunt-tpcheck/issues
- npm.io page: https://npm.io/package/grunt-tpcheck

## Dependencies (1)

- [tpcheck](https://npm.io/package/tpcheck.md) ~0.4.2

## Recent versions

- 0.3.0 (latest) — 2014-12-04
- 0.2.0 — 2014-12-01
- 0.1.0 — 2014-11-30

## README

# grunt-tpcheck

> template check plugin

## 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-tpcheck --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-tpcheck');
```

## The "tpcheck" task

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

```js
grunt.initConfig({
  tpcheckinclude: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
  tpcheckencoding: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});
```

### Options

#### tpcheckinclude

Check the include path exists

1. rootPath
  Type: `String`
  Default value: `''`
2. regular
  Type: `String`
  Default value: `''`

#### tpcheckencoding

Check the file encoding

1. rules
  Type: `Array`
  Default value: `['utf-8']`

#### tpchecknote


1. typeNote
  Type: `string`
  Default value: `@type`

### Usage Examples

see Gruntfile.js

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

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