Skip to content

othree/po-writer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

po-writer

A simple gettext Po file writer.

Usage

Create instance

import Po from 'po-writer';

let po = new Po();

Add translations:

po.add({
  id: 'hello world',
  str: '夜露死苦'
})

Create write stream and write to file:

let stream = fs.createWriteStream(targetFilePath);

po.writeToStream(stream);

API

constructor(headers)

headers is an object contains file header. Current support header fields and default values:

  • Project-Id-Version: 'PACKAGE VERSION',
  • POT-Creation-Date: now,
  • PO-Revision-Date: now,
  • Last-Translator: '',
  • Language-Team: 'none',
  • MIME-Version: '1.0',
  • Content-Type: 'text/plain; charset=UTF-8',
  • Content-Transfer-Encoding: '8bit',
  • Plural-Forms: 'nplurals=INTEGER; plural=EXPRESSION;'

add(msg|msg[])

Add a translated message to Po. msg support attributes:

  • translatorComments
  • extractedComments
  • reference
  • flag
  • context
  • id
  • plural
  • str (string|string[])

remove(id|id[])

Remove translation message from Po. id is a msg id or msg object.

writeToStream(stream)

Write the content of Po file to writable stream.

Releases

No releases published

Packages

No packages published