.github/workflows/coverage.yaml

@@ -12,6 +12,9 @@ jobs:
       matrix:
         node-version: [14.x]
 
+    env:
+      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
@@ -25,5 +28,5 @@ jobs:
         run: npm install -g yarn
       - name: Install dependencies
         run: yarn install
-      - name: Run release script
+      - name: Run coverage report
         run: ./scripts/test/coverageReport.sh

CHANGELOG.md

@@ -8,6 +8,66 @@ This change log follows the format documented in [Keep a CHANGELOG].
 [semantic versioning]: http://semver.org/
 [keep a changelog]: http://keepachangelog.com/
 
+## v2.27.0 - 2021-11-30
+
+Kudos to @tan75, @hg-pyun, @07akioni, @razvanmitre, @Haqverdi, @pgcalixto, @janziemba, @fturmel, @JuanM04, @zhirzh, @seanghay, @bulutfatih, @nodeadtree, @cHaLkdusT, @a-korzun, @fishmandev, @wingclover, @Zacharias3690, @kossnocorp and @leshakoss for working on the release.
+
+### Fixed
+
+- [Fixed translation for quarters in `format` in Chinese Simplified locale (`zh-CN`).](https://github.com/date-fns/date-fns/pull/2771)
+
+- [Fixed `P` token in `format` for Romanian locale (`ro`).](https://github.com/date-fns/date-fns/pull/2213)
+
+- [Fixed era and month formatters in Azerbaijani locale (`az`).](https://github.com/date-fns/date-fns/pull/1632)
+
+- [Fixed `formatRelative` patterns in Georgian locale (`ka`).](https://github.com/date-fns/date-fns/pull/2797)
+
+- [Fixed regular expressions for `parse` in Estonian locale (`er`).](https://github.com/date-fns/date-fns/pull/2038)
+
+- [Fixed the format of zeros in `formatDuration` in Czech locale (`cs`).](https://github.com/date-fns/date-fns/pull/2579)
+
+- [Fixed ordinal formatting for years, weeks, hours, minutes and seconds in `fr`, `fr-CA` and `fr-CH` locales.](https://github.com/date-fns/date-fns/pull/2626)
+
+- [Fixed constants not having proper TypeScript and Flow types.](https://github.com/date-fns/date-fns/pull/2791)
+
+- [Fixed translation for Monday in Turkish locale (`tr`).](https://github.com/date-fns/date-fns/pull/2720)
+
+- [Fixed `eachMinuteOfInterval` not handling intervals less than a minute correctly.](https://github.com/date-fns/date-fns/pull/2603)
+
+- [Fixed flow types for `closestTo` and `closestIndexTo`.](https://github.com/date-fns/date-fns/pull/2781)
+
+### Added
+
+- [Added Khmer locale (`km`).](https://github.com/date-fns/date-fns/pull/2713)
+
+## v2.26.0 - 2021-11-19
+
+Thanks to @kossnocorp, @leshakoss, @tan75, @gaplo, @AbdAllahAbdElFattah13, @fturmel, @kentaro84207, @V-Gutierrez, @atefBB, @jhonatanmacazana, @zhirzh, @Haqverdi, @mandaputtra, @micnic and @rikkalo for working on the release.
+
+### Fixed
+
+- [Fixed `formatRelative` format for `lastWeek` in Spanish locale.](https://github.com/date-fns/date-fns/pull/2753)
+
+- [Fixed translation for October in Hindi locale.](https://github.com/date-fns/date-fns/pull/2729)
+
+- [Fixed Azerbaijani locale to use correct era matchers for `parse`.](https://github.com/date-fns/date-fns/pull/1633)
+
+- [Added the functions that use `weekStartsOn` and `firstWeekContainsDate` that were missing from the `Locale` documentation page.](https://github.com/date-fns/date-fns/pull/2652)
+
+### Changed
+
+- [Changed abbreviation for August from "Ags" to "Agt" in Indonesian locale.](https://github.com/date-fns/date-fns/pull/2658)
+
+### Added
+
+- [Added Irish English locale (`en-IE`).](https://github.com/date-fns/date-fns/pull/2772)
+
+- [Added Arabic locale (`ar`).](https://github.com/date-fns/date-fns/pull/2721) ([#1670](https://github.com/date-fns/date-fns/issues/1670))
+
+- [Added Hong Kong Traditional Chinese locale (zh-HK).](https://github.com/date-fns/date-fns/pull/2686) ([#2684](https://github.com/date-fns/date-fns/issues/2684))
+
+- [Added Egyptian Arabic locale (ar-EG).](https://github.com/date-fns/date-fns/pull/2699)
+
 ## v2.25.0 - 2021-10-05
 
 This release is brought to you by @kossnocorp, @gierschv, @fturmel, @redbmk, @mprovenc, @artyom-ivanov and @tan75.

docs/i18nContributionGuide.md

@@ -213,7 +213,7 @@ Localizes a numeric era. Takes either 0 or 1 as the first argument.
 As with many of the `localize` functions, they can be generated by built-in
 `buildLocalizeFn` function.
 
-From CLDR chart, use ['Date & Time'/'Gregorian'/'Eras'](https://www.unicode.org/cldr/charts/32/summary/en.html#1771) values.
+From the CLDR chart, use ['Date & Time'/'Gregorian'/'Eras'](https://www.unicode.org/cldr/charts/32/summary/en.html#1771) values.
 
 ```js
 // In `en-US` locale:
@@ -256,12 +256,12 @@ var result = locale.localize.era(1, {width: 'foobar'})
 
 #### Formatting localizers
 
-For some languages, there is a difference for "stand-alone" localizers and "formatting" localizers.
+For some languages, there is a difference between "stand-alone" localizers and "formatting" localizers.
 "Stand-alone" means that the resulting value should make grammatical sense without context.
 "Formatting" means that the resulting value should be declined using the grammar rules of the language
 as if the value was a part of a date.
-For example, for languages with grammatical cases, stand-alone month could be in the nominative case ("January"),
-and formatting month could decline as a part of phrase "1st of January".
+For example, for languages with grammatical cases, the stand-alone month could be in the nominative case ("January"),
+and the formatting month could decline as a part of the phrase "1st of January".
 In this case, use parameters `formattingValues` and `defaultFormattingWidth` of `buildLocalizeFn` function.
 
 Any localizer could be stand-alone and formatting.
@@ -303,7 +303,7 @@ export default localize
 
 Localizes a quarter. Takes 1, 2, 3 or 4 as the first argument.
 `width` could be either 'narrow', 'abbreviated' or 'wide'.
-From CLDR chart, use ['Date & Time'/'Gregorian'/'Quarters'](https://www.unicode.org/cldr/charts/32/summary/en.html#1781) values.
+From the CLDR chart, use ['Date & Time'/'Gregorian'/'Quarters'](https://www.unicode.org/cldr/charts/32/summary/en.html#1781) values.
 
 ```js
 // In `en-US` locale:
@@ -337,7 +337,7 @@ Note the usage of `argumentCallback` here. It converts the value passed into `lo
 
 Localizes a month. Takes numbers between 0 (for January) and 11 (for December).
 `width` could be either 'narrow', 'abbreviated' or 'wide'.
-From CLDR chart, use ['Date & Time'/'Gregorian'/'Months'](https://www.unicode.org/cldr/charts/32/summary/en.html#1793) values.
+From the CLDR chart, use ['Date & Time'/'Gregorian'/'Months'](https://www.unicode.org/cldr/charts/32/summary/en.html#1793) values.
 
 ```js
 // In `en-US` locale:
@@ -381,7 +381,7 @@ var monthValues = {
 
 Localizes a week day. Takes numbers between 0 (for Sunday) and 6 (for Saturday).
 `width` could be either 'narrow', 'short', 'abbreviated' or 'wide'.
-From CLDR chart, use ['Date & Time'/'Gregorian'/'Days'](https://www.unicode.org/cldr/charts/32/summary/en.html#1829) values.
+From the CLDR chart, use ['Date & Time'/'Gregorian'/'Days'](https://www.unicode.org/cldr/charts/32/summary/en.html#1829) values.
 
 ```js
 // In `en-US` locale:
@@ -411,9 +411,9 @@ export default localize
 #### localize.dayPeriod
 
 Localizes a certain day period.
-Could take of these strings as the argument: 'am', 'pm', 'midnight', 'noon', 'morning', 'afternoon', 'evening', 'night'.
+Could take one of these strings as the argument: 'am', 'pm', 'midnight', 'noon', 'morning', 'afternoon', 'evening', 'night'.
 `width` could be either 'narrow', 'abbreviated' or 'wide'.
-From CLDR chart, use ['Date & Time'/'Gregorian'/'Day periods'](https://www.unicode.org/cldr/charts/32/summary/en.html#1857) values.
+From the CLDR chart, use ['Date & Time'/'Gregorian'/'Day periods'](https://www.unicode.org/cldr/charts/32/summary/en.html#1857) values.
 
 ```js
 // In `en-US` locale:
@@ -504,7 +504,7 @@ Use ordinal day of the month ('do' token) where applicable (date-fns, unlike CLD
 
 `dateFormats.medium` contains the same values as `dateFormats.long`, but with short form of month and non-ordinal day.
 
-`dateFormats.short` usually contains strictly numerical form of the date.
+`dateFormats.short` usually contains a strictly numerical form of the date.
 Pay attention to the order of units (big-, little- or middle-endian)
 
 #### formatLong.timeFormats

docs/release.md

@@ -0,0 +1,19 @@
+# Releasing date-fns
+
+1. First, make sure that the library is built by running `./scripts/build/build.sh` and committing and pushing any change you would have.
+
+2. Then add the changelog entry generated by `yarn ts-node scripts/release/buildChangelog.ts` to (CHANGELOG.md)[../CHANGELOG.md]. Make sure that the output is valid Markdown and fix if there're any errors. Commit and push the file.
+
+3. Using the version that the changelog script generated, run the command:
+
+   ```bash
+   env VERSION="vX.XX.X" APP_ENV="production" GOOGLE_APPLICATION_CREDENTIALS="secrets/production/key.json" ./scripts/release/release.sh
+   ```
+
+   The script will change `package.json`. **Do not commit the change, and reset it instead**.
+
+4. Now when the package is published, go to [GitHub Releases](https://github.com/date-fns/date-fns/releases) and draft a new version using the changelog entry you generated earlier.
+
+5. Finally, write an announce tweet using the created GitHub release as the tweet link.
+
+You're done, great job!

scripts/build/_lib/typings/common.js

@@ -15,13 +15,13 @@ function getParams(params, { leftBorder = '{', rightBorder = '}' } = {}) {
   }
 
   const formattedParams = addSeparator(
-    params.map(param => {
+    params.map((param) => {
       const {
         name,
         props,
         optional,
         variable,
-        type: { names: typeNames }
+        type: { names: typeNames },
       } = param
       const type = getType(typeNames, { props, forceArray: variable })
       return `${variable ? '...' : ''}${name}${optional ? '?' : ''}: ${type}`
@@ -36,8 +36,17 @@ function getParams(params, { leftBorder = '{', rightBorder = '}' } = {}) {
   `
 }
 
-function getType(types, { props = [], forceArray = false } = {}) {
-  const typeStrings = types.map(type => {
+function getType(
+  types,
+  { props = [], forceArray = false, flowType = false } = {}
+) {
+  let optional = false
+  if (flowType && types.some((type) => type === 'undefined')) {
+    optional = true
+    types = types.filter((type) => type !== 'undefined')
+  }
+
+  const typeStrings = types.map((type) => {
     if (type === '*') {
       return 'any'
     }
@@ -63,23 +72,27 @@ function getType(types, { props = [], forceArray = false } = {}) {
     return caseCorrectedType
   })
 
+  const prefix = optional ? '?' : ''
+
   const allArrayTypes =
-    typeStrings.length > 1 && typeStrings.every(type => type.endsWith('[]'))
+    typeStrings.length > 1 && typeStrings.every((type) => type.endsWith('[]'))
   if (allArrayTypes) {
-    return `(${typeStrings.map(type => type.replace('[]', '')).join(' | ')})[]`
+    return `(${typeStrings
+      .map((type) => `${prefix}${type.replace('[]', '')}`)
+      .join(' | ')})[]`
   }
 
-  return typeStrings.join(' | ')
+  return typeStrings.map((typeString) => `${prefix}${typeString}`).join(' | ')
 }
 
-function getFPFnType(params, returns) {
-  const fpParamTypes = params.map(param =>
-    getType(param.type.names, { props: param.props })
+function getFPFnType(params, returns, { flowType = false } = {}) {
+  const fpParamTypes = params.map((param) =>
+    getType(param.type.names, { props: param.props, flowType })
   )
 
   const arity = fpParamTypes.length
 
-  fpParamTypes.push(getType(returns))
+  fpParamTypes.push(getType(returns, { flowType }))
 
   return `CurriedFn${arity}<${fpParamTypes.join(', ')}>`
 }
@@ -88,5 +101,5 @@ module.exports = {
   correctTypeCase,
   getParams,
   getType,
-  getFPFnType
+  getFPFnType,
 }

scripts/build/_lib/typings/flow.js

@@ -44,7 +44,7 @@ function generateFlowFnTyping(fn, aliasDeclarations) {
   const { title, args, content } = fn
 
   const params = getParams(args, { leftBorder: '(', rightBorder: ')' })
-  const returns = getType(content.returns[0].type.names)
+  const returns = getType(content.returns[0].type.names, { flowType: true })
 
   const moduleDeclaration = `declare module.exports: ${params} => ${returns}`
 
@@ -60,7 +60,7 @@ function generateFlowFnTyping(fn, aliasDeclarations) {
 function generateFlowFnIndexTyping(fns, aliasDeclarations, constants) {
   const fnsDeclarations = fns.map(({ title, args, content }) => {
     const params = getParams(args, { leftBorder: '(', rightBorder: ')' })
-    const returns = getType(content.returns[0].type.names)
+    const returns = getType(content.returns[0].type.names, { flowType: true })
     return `${title}: ${params} => ${returns}`
   })
 
@@ -81,7 +81,9 @@ function generateFlowFnIndexTyping(fns, aliasDeclarations, constants) {
 function generateFlowFPFnTyping(fn, aliasDeclarations) {
   const { title, args, content } = fn
 
-  const type = getFPFnType(args, content.returns[0].type.names)
+  const type = getFPFnType(args, content.returns[0].type.names, {
+    flowType: true,
+  })
 
   const typingFile = formatFlowFile`
     ${addSeparator(aliasDeclarations, '\n')}
@@ -97,7 +99,9 @@ function generateFlowFPFnTyping(fn, aliasDeclarations) {
 function generateFlowFPFnIndexTyping(fns, aliasDeclarations, constants) {
   const fnsDeclarations = fns.map(
     ({ title, args, content }) =>
-      `${title}: ${getFPFnType(args, content.returns[0].type.names)}`
+      `${title}: ${getFPFnType(args, content.returns[0].type.names, {
+        flowType: true,
+      })}`
   )
 
   const typingFile = formatFlowFile`