@freave/make-pot

Freave make-pot

Scan files and make a POT file for translation.

Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Installation
   • Usage
   • CLI options
2. Roadmap
3. Contributing
4. License
5. Credits

Getting Started

Installation

Install with npm:

npm install --save-dev @freave/make-pot

Install with yarn:

yarn add @freave/make-pot --dev

Usage

make-pot --source path/to/input/folder --destination path/to/output/folder --domain domain

CLI options

make-pot --help output:

make-pot <args>

Options:
  --help         Show help                                                      [boolean]
  --version      Show version number                                            [boolean]
  --source       Space-seperated list of directories that should be searched.   [array] [required]
  --destination  Directory where the POT file will be placed.                   [string] [required]
  --domain       The domain that will be used inside the POT file.              [string] [required]
  --headers      The headers that will be added to the POT file.                [string]
                 Example: --headers.Language-Team Acme                        

Examples:

make-pot --source app resources --destination resources/lang --domain freave --headers.Report-Msgid-Bugs-To [e-mail] --headers.Language-Team Acme

This will look for files in the app and resources directories and will create a POT file in the resources/lang directory with the domain freave and the headers Report-Msgid-Bugs-To and Language-Team Acme changed.

Roadmap

• [x] PHP support
• [x] Blade support
• [x] Support all WordPress translation functions
• [x] POT file header is customizable
• [ ] Read info from style.css
• [ ] Option to select output type (POT or JSON)
• [ ] JSON / JS support

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Before you start

Make sure all commits are signed and marked as "verified". This is a requirement for merging pull requests. You can find instructions for signing commits here.

How to contribute

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Credits

Mike van Egmond - egmond.dev - [e-mail]
Freave B.V. - Freave.com - [e-mail]