Flow locale typings (closes #429) (#453)

* Generate flow locale typings

* Regenerate typings

scripts/buildTypings.js

@@ -63,7 +63,7 @@ const fns = Object.keys(jsDocs)
 const aliases = jsDocs['Types']
 
 generateTypeScriptTypings(fns, aliases, locales)
-generateFlowTypings(fns, aliases)
+generateFlowTypings(fns, aliases, locales)
 
 // Common
 
@@ -399,11 +399,32 @@ function generateFlowFPFnTyping (fn, nameSuffix, aliasDeclarations) {
   fs.writeFileSync(filename, typingString)
 }
 
-function generateFlowTypings (fns, aliases) {
+function generateFlowLocaleTyping (locale, localeAliasDeclaration) {
+  const {path} = locale
+  const filename = `${path.replace(/^\./, './src')}/index.js.flow`
+
+  const typingString = ['// @flow']
+    .concat('// This file is generated automatically by `scripts/build_typings.js`. Please, don\'t change it.')
+    .concat('')
+    .concat(localeAliasDeclaration)
+    .concat('')
+    .concat(`declare module.exports: Locale\n`)
+    .join('\n')
+
+  fs.writeFileSync(filename, typingString)
+}
+
+function generateFlowTypings (fns, aliases, locales) {
   const aliasDeclarations = aliases.map(getFlowTypeAlias)
+  const localeAliasDeclaration = getFlowTypeAlias(aliases.find((alias) => alias.title === 'Locale'))
+
   fns.forEach((fn) => {
     generateFlowFnTyping(fn, aliasDeclarations)
     generateFlowFPFnTyping(fn, '', aliasDeclarations)
     generateFlowFPFnTyping(fn, 'WithOptions', aliasDeclarations)
   })
+
+  locales.forEach((locale) => {
+    generateFlowLocaleTyping(locale, localeAliasDeclaration)
+  })
 }

src/locale/ar/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/bg/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/ca/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/cs/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/da/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/de/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/el/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/en/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/eo/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/es/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/fi/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/fil/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/fr/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/hr/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/id/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/is/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale

src/locale/it/index.js.flow

@@ -0,0 +1,19 @@
+// @flow
+// This file is generated automatically by `scripts/build_typings.js`. Please, don't change it.
+
+type Locale = {
+  distanceInWords?: {
+    localize?: Function
+  },
+  format?: {
+    formatters?: Object,
+    formattingTokensRegExp?: RegExp
+  },
+  parse?: {
+    units?: Object,
+    parsers?: Object,
+    parsingTokensRegExp?: RegExp
+  }
+}
+
+declare module.exports: Locale