Home Manual Reference Source Test Repository

References

References

Class Summary

Static Public Class Summary
public

API

Provides common properties and methods for the Gulp.js tasks related to the Smartling service.
public

Downloads the message translations from the Smartling server.
public

Provides the base implementation for file-based tasks.
public

Represents a locale, that is a language-region pair.
public

Uploads the message translations to the Smartling server.

Function Summary

Static Public Function Summary
public

download(filePattern: string, locales: string[], options: object): function

Downloads the message translations from the Smartling server.
public

upload(file: string, options: object): function

Uploads the original source content to the Smartling server.

Variable Summary

Static Public Variable Summary
public

Defines the type of a file to be uploaded.
public

Defines the retrieval type of a file to be downloaded.

Changelog

Changelog

This file contains highlights of what changes on each version of the Gulp-Smartling package.

Version 5.1.0

  • Added a description to the tasks for the Gulp command line interface.
  • Updated the package dependencies.

Version 5.0.0

  • Breaking change: raised the required Node.js version.
  • Breaking change: the UploadTask#callbackURL property is now an instance of the URL class.
  • Updated the package dependencies.

Version 4.1.0

Version 4.0.0

  • Breaking change: the Locale.getSpecificLocale() method is now a property.
  • Updated the package dependencies.

Version 3.1.0

  • Updated the package dependencies.

Version 3.0.0

  • Breaking change: changed the default region associated to the Portuguese language from Portugal to Brazil.
  • Breaking change: changed the signature of all constructors.
  • Breaking change: the Locale.getSpecificLocale() method is now an instance one.
  • Breaking change: raised the required Node.js version.
  • Breaking change: changed the type of the DownloadTask#locales property.
  • Breaking change: the locales options of the download task is now required.
  • Breaking change: using ES2017 features, like async/await functions.
  • Added the language and region properties to the Locale class.
  • Added the SubRip file format to the list of supported file types.
  • Improved the build system.
  • Ported the unit test assertions from TDD to BDD.
  • Updated the package dependencies.

Version 2.1.0

  • Replaced the Codacy code coverage service by the Coveralls one.
  • Updated the package dependencies.

Version 2.0.5

  • Added a dedicated enumeration API to the FileType and RetrievalType types.

Version 2.0.4

Version 2.0.3

  • Updated the package dependencies.

Version 2.0.1

Version 2.0.0

  • Breaking change: ported the CommonJS modules to ES2015 format.
  • Breaking change: replaced the test classes by plain tests.
  • Replaced JSDoc documentation generator by ESDoc.

Version 1.0.0

  • Breaking change: raised the required Node.js version.
  • Breaking change: changed the naming convention of some methods.
  • Added a build task for fixing the coding standards issues.
  • Replaced JSHint linter by ESLint.

Version 0.3.2

  • Fixed a bug with the download task whose promise was resolved too soon.
  • Updated the package dependencies.

Version 0.3.1

  • Fixed a bug with the boolean properties of the tasks.

Version 0.3.0

  • Breaking change: complete rewrite of the source code.
  • Download task: renamed the ${locale} placeholder of the file pattern to {{locale}}.
  • Download task: the en/en-US locales are not ignored anymore.
  • Download task: added support for includeOriginalStrings parameter.
  • Download task: added support for retrievalType parameter.
  • Upload task: the file type is now optional. It is derived from the extension of the file URI.
  • Upload task: added support for authorize parameter.
  • Upload task: added support for callbackURL parameter.
  • Added some unit tests.
  • Added support for code coverage.
  • Added support for Travis CI continuous integration.
  • Updated the package dependencies.

Version 0.2.0

  • Breaking change: raised the required Node.js version.
  • Breaking change: using ES2015 features, like classes and default parameters.
  • Turned the package into a scoped one.

Version 0.1.2

  • Added support for Codacy code analyzer.
  • Renamed the project according to its npm package name.
  • Updated the package dependencies.

Version 0.1.1

  • Fixed some bugs.
  • Updated the package dependencies.

Version 0.1.0

  • Initial release.