locize/resx

resx2js and js2resx converter resx resource utils

Download

The source is available for download from GitHub. Alternatively, you can install using npm:

npm install --save resx

You can then import or require() resx as normal:

import resx from 'resx'
// or
const resx = require('resx')

resx.resx2js(xml, (err, res) => {})

Or you can direclty import or require() its functions:

import resx2js from 'resx/resx2js'
// or
const resx2js = require('resx/cjs/resx2js')

Usage

const xml = `<?xml version="1.0" encoding="utf-8"?>
<root>
  <!--
    Microsoft ResX Schema

    Version 2.0

    The primary goals of this format is to allow a simple XML format
    that is mostly human readable. The generation and parsing of the
    various data types are done through the TypeConverter classes
    associated with the data types.

    Example:

    ... ado.net/XML headers & schema ...
    <resheader name="resmimetype">text/microsoft-resx</resheader>
    <resheader name="version">2.0</resheader>
    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
        <value>[base64 mime encoded serialized .NET Framework object]</value>
    </data>
    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
        <comment>This is a comment</comment>
    </data>

    There are any number of "resheader" rows that contain simple
    name/value pairs.

    Each data row contains a name, and value. The row also contains a
    type or mimetype. Type corresponds to a .NET class that support
    text/value conversion through the TypeConverter architecture.
    Classes that don't support this are serialized and stored with the
    mimetype set.

    The mimetype is used for serialized objects, and tells the
    ResXResourceReader how to depersist the object. This is currently not
    extensible. For a given mimetype the value must be set accordingly:

    Note - application/x-microsoft.net.object.binary.base64 is the format
    that the ResXResourceWriter will generate, however the reader can
    read any of the formats listed below.

    mimetype: application/x-microsoft.net.object.binary.base64
    value   : The object must be serialized with
            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
            : and then encoded with base64 encoding.

    mimetype: application/x-microsoft.net.object.soap.base64
    value   : The object must be serialized with
            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
            : and then encoded with base64 encoding.

    mimetype: application/x-microsoft.net.object.bytearray.base64
    value   : The object must be serialized into a byte array
            : using a System.ComponentModel.TypeConverter
            : and then encoded with base64 encoding.
    -->
  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
    <xsd:import namespace="http://www.w3.org/XML/1998/namespace"/>
    <xsd:element name="root" msdata:IsDataSet="true">
      <xsd:complexType>
        <xsd:choice maxOccurs="unbounded">
          <xsd:element name="metadata">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0"/>
              </xsd:sequence>
              <xsd:attribute name="name" use="required" type="xsd:string"/>
              <xsd:attribute name="type" type="xsd:string"/>
              <xsd:attribute name="mimetype" type="xsd:string"/>
              <xsd:attribute ref="xml:space"/>
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="assembly">
            <xsd:complexType>
              <xsd:attribute name="alias" type="xsd:string"/>
              <xsd:attribute name="name" type="xsd:string"/>
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="data">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2"/>
              </xsd:sequence>
              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1"/>
              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3"/>
              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4"/>
              <xsd:attribute ref="xml:space"/>
            </xsd:complexType>
          </xsd:element>
          <xsd:element name="resheader">
            <xsd:complexType>
              <xsd:sequence>
                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1"/>
              </xsd:sequence>
              <xsd:attribute name="name" type="xsd:string" use="required"/>
            </xsd:complexType>
          </xsd:element>
        </xsd:choice>
      </xsd:complexType>
    </xsd:element>
  </xsd:schema>
  <resheader name="resmimetype">
    <value>text/microsoft-resx</value>
  </resheader>
  <resheader name="version">
    <value>2.0</value>
  </resheader>
  <resheader name="reader">
    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <resheader name="writer">
    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
  </resheader>
  <data name="key1" xml:space="preserve">
    <value>Hello</value>
  </data>
  <data name="key2" xml:space="preserve">
    <value>An application to manipulate and process resx documents</value>
  </data>
  <data name="key.nested" xml:space="preserve">
    <value>resx Data Manager</value>
  </data>
</root>`

const js = {
  "key1": "Hello",
  "key2": "An application to manipulate and process resx documents",
  "key.nested": "resx Data Manager"
}


import resx2js from 'resx/resx2js'
resx2js(xml, (err, res) => {
  // res is like js
})

import js2resx from 'resx/js2resx'
js2resx(js, (err, res) => {
  // res is like xml
})

Omitting the callback returns a promise

const resJs = await resx2js(xml)
const resXml = await js2resx(js)
// or
resx2js(xml).then((res) => {})
js2resx(js).then((res) => {})

resx's Issues

Json to Resx name field is not copying the correct value (Angular)

🐛 Bug Report

I am converting JSON to Resx XML, I am passing name, value, comment in the Json Object list. But when i get the resultant XML it does not map the name field value to name, Value and Comment field work properly but not the name.

To Reproduce

Pass the JSON object list to this function in Console the resultant XML will not map the name values to name in the XML
My JSON object list is like the below JSON list.

returned XML is like this name contain random number.

data = [{name: 'menuItemValue', value:'Weeks Per Year', comment:'Add DDI LM 19-09-2016'}]

js2resx(data, (err: any, res: any) => {
            // res is like xml
            console.log(res);
        })

result: 

<data name="816" xml:space="preserve">
    <value>Weeks Per Year</value>
    <comment>Add DDI LM 19-09-2016</comment>
  </data>

Expected behavior

I want to have name field value from my JSON object list to the resultant name in the XML. like this below.

<data name="menuItemValue" xml:space="preserve">
    <value>Weeks Per Year</value>
    <comment>Add DDI LM 19-09-2016</comment>
  </data>

Your Environment

node v16
angular v13
windows 10

remove empty comment at js2resx

🚀 Feature Proposal

remove <comment/>

Motivation

<comment> is removed instead of leaving blank at some resx files, making changes in file dff.

Example

don't preserve empty comment as default or making an option for it.

Security Vulnerability: xml2js

Some days ago a vulnerability has been reported for the referenced package xml2js.

Could you please update xml2js to the latest version?