Logo for jsDocs.io

vscode-nls-dev

  • Version 4.0.4
  • Published
  • 83.4 kB
  • 12 dependencies
  • MIT license

Install

npm i vscode-nls-dev
yarn add vscode-nls-dev
pnpm add vscode-nls-dev

Overview

Development time npm module to generate strings bundles from Javascript files

Index

Functions

Classes

Interfaces

Namespaces

Functions

function bundleLanguageFiles

bundleLanguageFiles: () => ThroughStream;

    function bundleMetaDataFiles

    bundleMetaDataFiles: (id: string, outDir: string) => ThroughStream;

      function createAdditionalLanguageFiles

      createAdditionalLanguageFiles: (
          languages: Language[],
          i18nBaseDir: string,
          baseDir?: string,
          logProblems?: boolean
      ) => ThroughStream;

        function createKeyValuePairFile

        createKeyValuePairFile: (commentSeparator?: string | undefined) => ThroughStream;

        • A stream the creates additional key/value pair files for structured nls files.

          Parameter commentSeparator

          if provided comments will be joined into one string using the commentSeparator value. If omitted comments will be includes as a string array.

        function createMetaDataFiles

        createMetaDataFiles: () => ThroughStream;

          function createXlfFiles

          createXlfFiles: (projectName: string, extensionName: string) => ThroughStream;

            function debug

            debug: (prefix?: string) => ThroughStream;

              function prepareJsonFiles

              prepareJsonFiles: () => ThroughStream;

                function rewriteLocalizeCalls

                rewriteLocalizeCalls: () => ThroughStream;

                  Classes

                  class Line

                  class Line {}

                    constructor

                    constructor(indent?: number);

                      method append

                      append: (value: string) => Line;

                        method toString

                        toString: () => string;

                          class XLF

                          class XLF {}

                            constructor

                            constructor(project: string);

                              property project

                              project: string;

                                method addFile

                                addFile: (original: string, keys: KeyInfo[], messages: MessageInfo[]) => void;

                                  method parse

                                  static parse: (xlfString: string) => Promise<ParsedXLF[]>;

                                    method toString

                                    toString: () => string;

                                      Interfaces

                                      interface Language

                                      interface Language {}

                                        property folderName

                                        folderName?: string;

                                          property id

                                          id: string;

                                            interface ParsedXLF

                                            interface ParsedXLF {}

                                              property language

                                              language: string;

                                                property messages

                                                messages: Map<string>;

                                                  property originalFilePath

                                                  originalFilePath: string;

                                                    interface Resource

                                                    interface Resource {}

                                                      property name

                                                      name: string;

                                                        property project

                                                        project: string;

                                                          Namespaces

                                                          namespace MessageInfo

                                                          namespace MessageInfo {}

                                                            function comment

                                                            comment: (value: MessageInfo) => string[] | undefined;

                                                              function message

                                                              message: (value: MessageInfo) => string;

                                                                Package Files (1)

                                                                Dependencies (12)

                                                                Dev Dependencies (19)

                                                                Peer Dependencies (0)

                                                                No peer dependencies.

                                                                Badge

                                                                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/vscode-nls-dev.

                                                                • Markdown
                                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/vscode-nls-dev)
                                                                • HTML
                                                                  <a href="https://www.jsdocs.io/package/vscode-nls-dev"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>