# i18n-strings-files

> Process .strings files used for localization in iOS/OSX development

Latest version **2.0.0** (published 2022-06-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install i18n-strings-files
pnpm add i18n-strings-files
yarn add i18n-strings-files
bun add i18n-strings-files
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-06-07 |
| First published | 2013-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 1 |
| Unpacked size | 27.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 36 |
| Author | Justin Klemm |
| Maintainers | justinklemm |
| Keywords | i18n, localization, internationalization, strings, apple, ios, osx |

## Links

- npm: https://www.npmjs.com/package/i18n-strings-files
- Repository: https://github.com/justinklemm/i18n-strings-files
- Issues: https://github.com/justinklemm/i18n-strings-files/issues
- npm.io page: https://npm.io/package/i18n-strings-files

## Dependencies (1)

- [iconv](https://npm.io/package/iconv.md) ^3.0.1

## Alternatives

- [messageformat](https://npm.io/package/messageformat.md) — 329.7K weekly downloads
- [@mintlify/scraping](https://npm.io/package/@mintlify/scraping.md) — 294.8K weekly downloads
- [@mintlify/previewing](https://npm.io/package/@mintlify/previewing.md) — 209.5K weekly downloads
- [@mintlify/prebuild](https://npm.io/package/@mintlify/prebuild.md) — 209.5K weekly downloads
- [@mintlify/link-rot](https://npm.io/package/@mintlify/link-rot.md) — 206.3K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2022-06-07
- 0.0.5 (v0.0.5) — 2014-06-30
- 1.0.10 — 2022-06-07
- 1.0.9 — 2021-05-13
- 1.0.8 — 2021-04-20
- 1.0.7 — 2021-01-13
- 1.0.6 — 2020-07-29
- 1.0.5 — 2020-03-24
- 1.0.4 — 2018-12-14
- 1.0.2 — 2016-04-29
- 1.0.1 — 2016-03-09
- 1.0.0 — 2015-11-19
- 0.0.7 — 2015-02-14
- 0.0.6 — 2014-06-30
- 0.0.4 — 2013-12-22
- … 1 more at https://npm.io/package/i18n-strings-files/versions

## README

i18n-strings-files
==================

[![Build Status](https://travis-ci.org/justinklemm/i18n-strings-files.png)](https://travis-ci.org/justinklemm/i18n-strings-files)

Node.js module for processing .strings files used for localization in iOS/OSX development

## Installing with [npm](http://npmjs.org/)

```
npm install i18n-strings-files
```

## Usage

i18n-strings-files can be used to read a .strings file and parse it into an object, or to compile an object into .strings format and write it to a file. The intermediate functions for parsing and compiling can also be used directly.

Note that specifying an encoding is optional. If an encoding is not specified, UTF-16 will be used [as recommended by Apple](https://developer.apple.com/library/mac/documentation/macosx/conceptual/bpinternational/Articles/StringsFiles.html). It's important to understand the encoding of the file being read/written and make sure it's specified properly (if it's something other than UTF-16).

### readFile(filename, [encoding or options], callback)
```js
// Include i18n-strings-files
var i18nStringsFiles = require('i18n-strings-files');

// Read 'Localizable.strings' and pass an object containing the key/value pairs to a callback
i18nStringsFiles.readFile('Localizable.strings', 'UTF-16', function(err, data){
    console.log(data);
});

// Read 'Localizable.strings' and pass an object containing the key/value pairs (each value contains 'text' and 'comment') to a callback
i18nStringsFiles.readFile('Localizable.strings', { 'encoding' : 'UTF-16', 'wantsComments' : true }, function(err, data){
    console.log(data);
});
```

### readFileSync(filename, [encoding or options])
```js
// Include i18n-strings-files
var i18nStringsFiles = require('i18n-strings-files');

// Read 'Localizable.strings' and return it as an object containing the key/value pairs
var data = i18nStringsFiles.readFileSync('Localizable.strings', 'UTF-16');
console.log(data);

// Read 'Localizable.strings' and return it as an object containing the key/value (each value contains 'text' and 'comment') pairs
var data = i18nStringsFiles.readFileSync('Localizable.strings', { 'encoding' : 'UTF-16', 'wantsComments' : true });
console.log(data);
```

### writeFile(filename, data, [encoding], callback)
```js
// Include i18n-strings-files
var i18nStringsFiles = require('i18n-strings-files');

// An object containing some properties
var data = {
    'key1': 'value1',
    'key2': 'value2'
};

// Write an object containing key/value pairs to file 'Localizable.strings', execute callback when done
i18nStringsFiles.writeFile('Localizable.strings', data, 'UTF-16', function(err){
    if(err) return console.log(err);
    console.log('File written');
});
```

### writeFile(filename, data, [options], callback)
```js
// Include i18n-strings-files
var i18nStringsFiles = require('i18n-strings-files');

// An object containing some properties
var data = {
    'key1': { 'text' : 'value1', 'comment' : 'comment1' },
    'key2': { 'text' : 'value2', 'comment' : 'comment2' }
};

// Write an object containing key/value pairs (with comments) to file 'Localizable.strings', execute callback when done
i18nStringsFiles.writeFile('Localizable.strings', data, { 'encoding' : 'UTF-16', 'wantsComments' : true }, function(err){
    if(err) return console.log(err);
    console.log('File written');
});
```

### writeFileSync(filename, data, [encoding or options])
```js
// Include i18n-strings-files
var i18nStringsFiles = require('i18n-strings-files');

// Write an object containing key/value pairs to file 'Localizable.strings'
i18nStringsFiles.writeFileSync('Localizable.strings', data, 'UTF-16');
console.log('File written');

// Write an object containing key/value pairs (with comments) to file 'Localizable.strings'
i18nStringsFiles.writeFileSync('Localizable.strings', data, { 'encoding' : 'UTF-16', 'wantsComments' : true });
console.log('File written');
```

### parse(input, [options])
```js
// Include i18n-strings-files
var i18nStringsFiles = require('i18n-strings-files');

// A string in the .strings file format
var input = '"key1" = "value1";'

// Parse .strings format string into object containing the key/value pairs
var data = i18nStringsFiles.parse(input);

// A string in the .strings file format
input = '/* comment1 */\n"key1" = "value1";'

// Parse .strings format string into object containing the key/value pairs
data = i18nStringsFiles.parse(input, { 'wantsComments' : true });
```

### compile(data, [options])
```js
// Include i18n-strings-files
var i18nStringsFiles = require('i18n-strings-files');

// An object containing some properties
var data = {
    'key1': 'value1',
    'key2': 'value2'
};

// Compile an object containing key/value pairs into a string in .strings file format
var str = i18nStringsFiles.compile(data);

// An object containing some properties
data = {
    'key1': { 'text' : 'value1', 'comment' : 'comment1' },
    'key2': { 'text' : 'value2', 'comment' : 'comment2' }
};

// Compile an object containing key/value pairs into a string in .strings file format
var str = i18nStringsFiles.compile(data, { 'wantsComments' : true });
```

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