# grunt-twig-gettext

> Extract i18n strings from Twig templates

Latest version **0.3.2** (published 2018-11-10) · 0 weekly downloads

## Install

```sh
npm install grunt-twig-gettext
pnpm add grunt-twig-gettext
yarn add grunt-twig-gettext
bun add grunt-twig-gettext
```

## 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.2 |
| Published | 2018-11-10 |
| First published | 2015-12-17 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Unpacked size | 15.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Marijn Ophorst |
| Maintainers | monomelodies |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-twig-gettext
- Repository: https://github.com/monomelodies/grunt-twig-gettext
- Homepage: http://grunt-twig-gettext.monomelodies.nl
- Issues: https://github.com/monomelodies/grunt-twig-gettext/issues
- npm.io page: https://npm.io/package/grunt-twig-gettext

## Recent versions

- 0.3.2 (latest) — 2018-11-10
- 0.3.1 — 2018-06-26
- 0.3.0 — 2017-03-27
- 0.2.2 — 2016-11-29
- 0.2.1 — 2016-11-23
- 0.2.0 — 2016-11-23
- 0.1.9 — 2016-09-09
- 0.1.8 — 2016-03-23
- 0.1.7 — 2015-12-17
- 0.1.6 — 2015-12-17
- 0.1.5 — 2015-12-17
- 0.1.4 — 2015-12-17
- 0.1.3 — 2015-12-17
- 0.1.2 — 2015-12-17
- 0.1.1 — 2015-12-17
- … 1 more at https://npm.io/package/grunt-twig-gettext/versions

## README

# grunt-twig-gettext

> Extract i18n string from Twig 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-twig-gettext --save-dev
```

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

```js
grunt.loadNpmTasks('grunt-twig-gettext');
```

## The "twig_gettext" task

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

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

### Options

#### options.charset
Type: `String`
Default value: `'ASCII'`

The character set for the .po file.

#### options.encoding
Type: `String`
Default value: `'8bit'`

The content transfer encoding for the .po file.

### Usage Examples

#### Default Options
Extract translatable strings from all Twig templates in a directory and its subdirectories:

```js
grunt.initConfig({
  twig_gettext: {
    options: {},
    your_target: {
        files: {
          'dest/domain.po': ['src/**/*.twig', 'dist/**/*.twig'],
        }
    }
  }
});
```

#### Custom Options
Input/output in UTF-8:

```js
grunt.initConfig({
  twig_gettext: {
    options: {
      charset: 'UTF-8'
    },
    your_target: {
        files: {
          'dest/domain.po': ['src/**/*.twig'],
        }
    }
  },
});
```

## Notes/caveats
- You should use tools like `msgcat` and `msguniq` to combine the generated
  `.po` file with translations extract from other sources (Javascript, PHP etc.)
  into a `.pot` file to use as a template.
- This Grunt task does not do any validation on the supplied Twig templates, so
  it's up to you to pass something valid.

## 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/).

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