From 27c0d64a9fa4fc535825afc1d418937c1fa41cdb Mon Sep 17 00:00:00 2001 From: Steffen Kolmer Date: Sat, 12 Nov 2016 15:09:10 +0100 Subject: [PATCH] docs(pages): Updated pages --- docs/assets/js/search.js | 2 +- docs/globals.html | 36 +++++++++++++++++------------------- docs/index.html | 6 +++--- 3 files changed, 21 insertions(+), 23 deletions(-) diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index 0b5c7d0..7bffa2c 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1 +1 @@ -var typedoc = typedoc || {};typedoc.search = typedoc.search || {};typedoc.search.data = {"kinds":{"32":"Variable","64":"Function","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":4194304,"name":"Logger","url":"globals.html#logger","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":1,"kind":65536,"name":"__type","url":"globals.html#logger.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"Logger"},{"id":2,"kind":32,"name":"info","url":"globals.html#logger.__type.info","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":3,"kind":65536,"name":"__type","url":"globals.html#logger.__type.info.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.info"},{"id":4,"kind":32,"name":"trace","url":"globals.html#logger.__type.trace","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":5,"kind":65536,"name":"__type","url":"globals.html#logger.__type.trace.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.trace"},{"id":6,"kind":32,"name":"warn","url":"globals.html#logger.__type.warn","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":7,"kind":65536,"name":"__type","url":"globals.html#logger.__type.warn.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.warn"},{"id":8,"kind":32,"name":"error","url":"globals.html#logger.__type.error","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":9,"kind":65536,"name":"__type","url":"globals.html#logger.__type.error.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.error"},{"id":10,"kind":32,"name":"toConsole","url":"globals.html#logger.__type.toconsole","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":11,"kind":4194304,"name":"ExportOptions","url":"globals.html#exportoptions","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":12,"kind":65536,"name":"__type","url":"globals.html#exportoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"ExportOptions"},{"id":13,"kind":32,"name":"rootPath","url":"globals.html#exportoptions.__type.rootpath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":14,"kind":32,"name":"filePath","url":"globals.html#exportoptions.__type.filepath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":15,"kind":32,"name":"filter","url":"globals.html#exportoptions.__type.filter","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":16,"kind":32,"name":"logger","url":"globals.html#exportoptions.__type.logger","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":17,"kind":32,"name":"progress","url":"globals.html#exportoptions.__type.progress","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":18,"kind":65536,"name":"__type","url":"globals.html#exportoptions.__type.progress.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"ExportOptions.__type.progress"},{"id":19,"kind":32,"name":"preprocessor","url":"globals.html#exportoptions.__type.preprocessor","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":20,"kind":32,"name":"babylonConfig","url":"globals.html#exportoptions.__type.babylonconfig","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":21,"kind":65536,"name":"__type","url":"globals.html#exportoptions.__type.babylonconfig.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"ExportOptions.__type.babylonConfig"},{"id":22,"kind":4194304,"name":"SchemaOptions","url":"globals.html#schemaoptions","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":23,"kind":65536,"name":"__type","url":"globals.html#schemaoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"SchemaOptions"},{"id":24,"kind":32,"name":"rootPath","url":"globals.html#schemaoptions.__type.rootpath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":25,"kind":32,"name":"schemaPath","url":"globals.html#schemaoptions.__type.schemapath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":26,"kind":32,"name":"filter","url":"globals.html#schemaoptions.__type.filter","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":27,"kind":32,"name":"logger","url":"globals.html#schemaoptions.__type.logger","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":28,"kind":32,"name":"progress","url":"globals.html#schemaoptions.__type.progress","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":29,"kind":65536,"name":"__type","url":"globals.html#schemaoptions.__type.progress.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"SchemaOptions.__type.progress"},{"id":30,"kind":32,"name":"preprocessor","url":"globals.html#schemaoptions.__type.preprocessor","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":31,"kind":32,"name":"babylonConfig","url":"globals.html#schemaoptions.__type.babylonconfig","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":32,"kind":65536,"name":"__type","url":"globals.html#schemaoptions.__type.babylonconfig.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"SchemaOptions.__type.babylonConfig"},{"id":33,"kind":4194304,"name":"ValidateOptions","url":"globals.html#validateoptions","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":34,"kind":65536,"name":"__type","url":"globals.html#validateoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"ValidateOptions"},{"id":35,"kind":32,"name":"rootPath","url":"globals.html#validateoptions.__type.rootpath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":36,"kind":32,"name":"schemaPath","url":"globals.html#validateoptions.__type.schemapath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":37,"kind":32,"name":"logger","url":"globals.html#validateoptions.__type.logger","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":38,"kind":32,"name":"progress","url":"globals.html#validateoptions.__type.progress","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":39,"kind":65536,"name":"__type","url":"globals.html#validateoptions.__type.progress.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"ValidateOptions.__type.progress"},{"id":40,"kind":64,"name":"generateTranslationSchema","url":"globals.html#generatetranslationschema","classes":"tsd-kind-function"},{"id":41,"kind":64,"name":"exportTranslationKeys","url":"globals.html#exporttranslationkeys","classes":"tsd-kind-function"},{"id":42,"kind":64,"name":"validateSchema","url":"globals.html#validateschema","classes":"tsd-kind-function"}]}; \ No newline at end of file +var typedoc = typedoc || {};typedoc.search = typedoc.search || {};typedoc.search.data = {"kinds":{"32":"Variable","64":"Function","65536":"Type literal","4194304":"Type alias"},"rows":[{"id":0,"kind":4194304,"name":"Logger","url":"globals.html#logger","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":1,"kind":65536,"name":"__type","url":"globals.html#logger.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"Logger"},{"id":2,"kind":32,"name":"info","url":"globals.html#logger.__type.info","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":3,"kind":65536,"name":"__type","url":"globals.html#logger.__type.info.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.info"},{"id":4,"kind":32,"name":"trace","url":"globals.html#logger.__type.trace","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":5,"kind":65536,"name":"__type","url":"globals.html#logger.__type.trace.__type-3","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.trace"},{"id":6,"kind":32,"name":"warn","url":"globals.html#logger.__type.warn","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":7,"kind":65536,"name":"__type","url":"globals.html#logger.__type.warn.__type-4","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.warn"},{"id":8,"kind":32,"name":"error","url":"globals.html#logger.__type.error","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":9,"kind":65536,"name":"__type","url":"globals.html#logger.__type.error.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"Logger.__type.error"},{"id":10,"kind":32,"name":"toConsole","url":"globals.html#logger.__type.toconsole","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"Logger.__type"},{"id":11,"kind":4194304,"name":"ExportOptions","url":"globals.html#exportoptions","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":12,"kind":65536,"name":"__type","url":"globals.html#exportoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"ExportOptions"},{"id":13,"kind":32,"name":"rootPath","url":"globals.html#exportoptions.__type.rootpath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":14,"kind":32,"name":"filePath","url":"globals.html#exportoptions.__type.filepath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":15,"kind":32,"name":"filter","url":"globals.html#exportoptions.__type.filter","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":16,"kind":32,"name":"logger","url":"globals.html#exportoptions.__type.logger","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":17,"kind":32,"name":"progress","url":"globals.html#exportoptions.__type.progress","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":18,"kind":65536,"name":"__type","url":"globals.html#exportoptions.__type.progress.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"ExportOptions.__type.progress"},{"id":19,"kind":32,"name":"preprocessor","url":"globals.html#exportoptions.__type.preprocessor","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":20,"kind":32,"name":"babylonConfig","url":"globals.html#exportoptions.__type.babylonconfig","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ExportOptions.__type"},{"id":21,"kind":65536,"name":"__type","url":"globals.html#exportoptions.__type.babylonconfig.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"ExportOptions.__type.babylonConfig"},{"id":22,"kind":4194304,"name":"SchemaOptions","url":"globals.html#schemaoptions","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":23,"kind":65536,"name":"__type","url":"globals.html#schemaoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"SchemaOptions"},{"id":24,"kind":32,"name":"rootPath","url":"globals.html#schemaoptions.__type.rootpath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":25,"kind":32,"name":"schemaPath","url":"globals.html#schemaoptions.__type.schemapath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":26,"kind":32,"name":"filter","url":"globals.html#schemaoptions.__type.filter","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":27,"kind":32,"name":"logger","url":"globals.html#schemaoptions.__type.logger","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":28,"kind":32,"name":"progress","url":"globals.html#schemaoptions.__type.progress","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":29,"kind":65536,"name":"__type","url":"globals.html#schemaoptions.__type.progress.__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"SchemaOptions.__type.progress"},{"id":30,"kind":32,"name":"preprocessor","url":"globals.html#schemaoptions.__type.preprocessor","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":31,"kind":32,"name":"babylonConfig","url":"globals.html#schemaoptions.__type.babylonconfig","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"SchemaOptions.__type"},{"id":32,"kind":65536,"name":"__type","url":"globals.html#schemaoptions.__type.babylonconfig.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"SchemaOptions.__type.babylonConfig"},{"id":33,"kind":4194304,"name":"ValidateOptions","url":"globals.html#validateoptions","classes":"tsd-kind-type-alias tsd-is-not-exported"},{"id":34,"kind":65536,"name":"__type","url":"globals.html#validateoptions.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"ValidateOptions"},{"id":35,"kind":32,"name":"rootPath","url":"globals.html#validateoptions.__type.rootpath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":36,"kind":32,"name":"schemaPath","url":"globals.html#validateoptions.__type.schemapath","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":37,"kind":32,"name":"logger","url":"globals.html#validateoptions.__type.logger","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":38,"kind":32,"name":"progress","url":"globals.html#validateoptions.__type.progress","classes":"tsd-kind-variable tsd-parent-kind-type-literal tsd-is-not-exported","parent":"ValidateOptions.__type"},{"id":39,"kind":65536,"name":"__type","url":"globals.html#validateoptions.__type.progress.__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported","parent":"ValidateOptions.__type.progress"},{"id":40,"kind":64,"name":"generateTranslationSchema","url":"globals.html#generatetranslationschema","classes":"tsd-kind-function"},{"id":41,"kind":64,"name":"exportTranslationKeys","url":"globals.html#exporttranslationkeys","classes":"tsd-kind-function"},{"id":42,"kind":64,"name":"validateTranslations","url":"globals.html#validatetranslations","classes":"tsd-kind-function"}]}; \ No newline at end of file diff --git a/docs/globals.html b/docs/globals.html index 99ff336..37c363b 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -82,7 +82,7 @@

Functions

@@ -96,7 +96,7 @@

ExportOptions

ExportOptions: object
@@ -193,7 +193,7 @@

Logger

Logger: object
@@ -295,7 +295,7 @@

SchemaOptions

SchemaOptions: object
@@ -392,7 +392,7 @@

ValidateOptions

ValidateOptions: object
@@ -464,19 +464,18 @@

Functions

exportTranslationKeys

    -
  • exportTranslationKeys(options: ExportOptions): Promise<object>
    • +
  • exportTranslationKeys(options: ExportOptions): Promise<[object | string]>
  • -

    Generates an array of all i18n tagged template literals in a file. - The array will be returned as json via callback output param.

    +

    Generates an array of all i18n tagged template literals in a file.

    Parameters

    @@ -484,11 +483,11 @@

    Parameters

  • options: ExportOptions
    -

    The translation options.

    +

    The export options.

-

Returns Promise<object>

+

Returns Promise<[object | string]>

@@ -502,13 +501,12 @@

generateTranslationSchema

  • -

    Generates a JSON schema based on i18n tagged template literals. - If no target schema is provided the json will be returned via callback output param.

    +

    Generates a JSON schema based on i18n tagged template literals.

    Parameters

    @@ -525,16 +523,16 @@

    Returns Promise
    - -

    validateSchema

    + +

    validateTranslations

    diff --git a/docs/index.html b/docs/index.html index 31724bc..e25974f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -178,13 +178,13 @@

    Validation Rules

    Some IDEs can also provide auto completion for translation keys and groups

    Preprocessors

    -

    This libaray has support for custom preprocessors. It ships with a typescript preprocessor out of the box. Please make sure 'typescript' npm package is installed if you want to parse typescript code.

    +

    This library has support for custom preprocessors. It ships with a typescript preprocessor out of the box. Please make sure typescript npm package is installed if you want to parse typescript code.

    $ i18n-tag-schema ./src -e ./typescript.ts -p ./preprocessors/typescript -f \.ts

    Custom preprocessors can be added as npm packages

    $ npm install my-preprocessor --save-dev
 $ i18n-tag-schema ./src -e ./file.myext -p my-preprocessor -f \.myext

    A preprocessor is a function that receives file content as an argument and returns the processed source code in ES2015 syntax. - An example can be found at ./lib/preprocessors/typescript.js

    + An example can be found at ./lib/preprocessors/typescript.js

    IDE Integration

    Webstorm / PhpStorm

    Webstorm and PhpStorm support JSON Schemas since version 2016.1. For more details please see: Add JSON Schema Mapping Dialog

    @@ -276,7 +276,7 @@

    License

    generateTranslationSchema

  • - validateSchema + validateTranslations