@louis.jln/extract-date 3.0.0 → 4.0.0

package/package.json

@@ -1,19 +1,7 @@
 {
   "author": "Gajus Kuizinas <gajus@gajus.com> (http://gajus.com)",
-  "ava": {
-    "babel": {
-      "compileAsTests": [
-        "test/helpers/**/*"
-      ]
-    },
-    "files": [
-      "test/extract-date/**/*"
-    ],
-    "require": [
-      "@babel/register"
-    ]
-  },
   "dependencies": {
+    "@louis.jln/extract-date": "^3.0.1",
     "cartesian": "^1.0.1",
     "date-fns": "^2.9.0",
     "moment": "^2.24.0",
@@ -22,35 +10,16 @@
   },
   "description": "Extracts date from an arbitrary text input.",
   "devDependencies": {
-    "@ava/babel": "^1.0.0",
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.8.4",
-    "@babel/node": "^7.8.4",
-    "@babel/plugin-transform-flow-strip-types": "^7.8.3",
-    "@babel/preset-env": "^7.8.4",
-    "@babel/register": "^7.8.3",
-    "ava": "^3.1.0",
-    "babel-plugin-istanbul": "^6.0.0",
-    "coveralls": "^3.0.9",
-    "esbuild": "^0.24.0",
-    "eslint": "^6.8.0",
-    "eslint-config-canonical": "^18.1.0",
-    "flow-bin": "^0.117.0",
-    "flow-copy-source": "^2.0.9",
-    "gitdown": "^3.1.2",
-    "husky": "^4.2.1",
-    "nyc": "^15.0.0",
-    "semantic-release": "^17.0.2",
-    "sinon": "^8.1.1"
+    "@types/node": "^20.0.0",
+    "esbuild": "^0.27.3",
+    "eslint": "^10.0.2",
+    "husky": "^9.1.7",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.1",
+    "vitest": "^4.0.18"
   },
   "engines": {
-    "node": ">6"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run lint && npm run test && npm run build",
-      "pre-push": "gitdown ./.README/README.md --output-file ./README.md --check"
-    }
+    "node": ">=20"
   },
   "keywords": [
     "date",
@@ -59,38 +28,26 @@
     "parse"
   ],
   "license": "BSD-3-Clause",
-  "main": "./dist/index.js",
+  "main": "./index.js",
   "name": "@louis.jln/extract-date",
-  "nyc": {
-    "include": [
-      "src/**/*.js"
-    ],
-    "instrument": false,
-    "reporter": [
-      "text-lcov"
-    ],
-    "require": [
-      "@babel/register"
-    ],
-    "sourceMap": false
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/gajus/extract-date.git"
+    "url": "git+https://github.com/LouisJULIEN/extract-date.git"
   },
   "scripts": {
-    "build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps && flow-copy-source src dist",
-    "create-readme": "gitdown ./.README/README.md --output-file ./README.md",
-    "lint": "eslint ./src ./test && flow",
-    "test": "NODE_ENV=test ava --verbose --serial",
-    "bundle": "esbuild dist/index.js --bundle --outfile=bundle/extract-date.js --format=esm"
-  },
-  "version": "3.0.0",
+    "build": "rm -fr ./dist && tsc --project tsconfig.json",
+    "lint": "eslint ./src ./test",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "npm-publish": "rm -rf build; npm run build; cp package.json dist/package.json; cd dist; npm publish --access public",
+    "prepare": "husky"
+  },
+  "version": "4.0.0",
   "directories": {
     "test": "test"
   },
   "bugs": {
-    "url": "https://github.com/gajus/extract-date/issues"
+    "url": "https://github.com/LouisJULIEN/extract-date/issues"
   },
-  "homepage": "https://github.com/gajus/extract-date#readme"
+  "homepage": "https://github.com/LouisJULIEN/extract-date"
 }

package/src/calculateSpecificity.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (dateFnsFormat: string) => number;
+export default _default;

package/src/calculateSpecificity.js

@@ -1,21 +1,16 @@
-// @flow
-
-export default (dateFnsFormat: string): number => {
-  let specificity = 0;
-
-  if (dateFnsFormat.includes('yyyy')) {
-    specificity += 40;
-  } else if (dateFnsFormat.includes('yy')) {
-    specificity += 20;
-  }
-
-  if (dateFnsFormat.includes('M')) {
-    specificity += 20;
-  }
-
-  if (/d/.test(dateFnsFormat)) {
-    specificity += 20;
-  }
-
-  return specificity + dateFnsFormat.length;
+export default (dateFnsFormat) => {
+    let specificity = 0;
+    if (dateFnsFormat.includes('yyyy')) {
+        specificity += 40;
+    }
+    else if (dateFnsFormat.includes('yy')) {
+        specificity += 20;
+    }
+    if (dateFnsFormat.includes('M')) {
+        specificity += 20;
+    }
+    if (/d/.test(dateFnsFormat)) {
+        specificity += 20;
+    }
+    return specificity + dateFnsFormat.length;
 };

package/src/createFormats.d.ts

@@ -0,0 +1,13 @@
+type FormatEntry = {
+    dateFnsFormat: string;
+    direction?: string;
+    test?: boolean;
+};
+type Format = FormatEntry & {
+    localised: boolean;
+    specificity: number;
+    wordCount: number;
+    yearIsExplicit: boolean;
+};
+declare const _default: () => Format[];
+export default _default;

package/src/createFormats.js

@@ -1,373 +1,140 @@
-// @flow
-
 import cartesian from 'cartesian';
-import calculateSpecificity from './calculateSpecificity';
-
-const formatCombinaison = (combination) => combination.join(' ').replace(' ,', ',').replace(/ +/, ' ').replace(/ $/, '')
-
+import calculateSpecificity from '@/calculateSpecificity';
+const formatCombinaison = (combination) => combination.join(' ').replace(' ,', ',').replace(/ +/, ' ').replace(/ $/, '');
 export default () => {
-  // The reason `yearFirstDashSeparator` and `yearFirstSlashSeparator` formats do not have direction is because
-  // there are no known regions that use yyyy-dd-MM format.
-  // https://en.wikipedia.org/wiki/Date_format_by_country
-  const yearFirstDashSeparator = [
-    {
-      dateFnsFormat: 'yyyy-MM-dd',
-    },
-    {
-      dateFnsFormat: 'yyyy-M-d',
-    },
-  ];
-
-  const yearFirstSlashSeparator = [
-    {
-      dateFnsFormat: 'yyyy/MM/dd',
-    },
-    {
-      dateFnsFormat: 'yyyy/M/d',
-    },
-  ];
-
-  const yearFirstDotSeparator = [
-    {
-      dateFnsFormat: 'yyyy.MM.dd',
-      direction: 'YMD',
-    },
-    {
-      dateFnsFormat: 'yyyy.M.d',
-      direction: 'YMD',
-    },
-    {
-      dateFnsFormat: 'yyyy.dd.MM',
-      direction: 'YDM',
-    },
-    {
-      dateFnsFormat: 'yyyy.d.M',
-      direction: 'YDM',
-    },
-  ];
-
-  const yearLastDashSeparator = [
-    {
-      dateFnsFormat: 'dd-MM-yyyy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'd-M-yyyy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'MM-dd-yyyy',
-      direction: 'MDY',
-    },
-    {
-      dateFnsFormat: 'M-d-yyyy',
-      direction: 'MDY',
-    },
-  ];
-
-  const yearLastDotSeparator = [
-    {
-      dateFnsFormat: 'dd.MM.yyyy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'd.M.yyyy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'MM.dd.yyyy',
-      direction: 'MDY',
-    },
-    {
-      dateFnsFormat: 'M.d.yyyy',
-      direction: 'MDY',
-    },
-    {
-      dateFnsFormat: 'dd.MM.yy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'd.M.yy',
-      direction: 'DMY',
-    },
-  ];
-
-  const yearLastSlashSeparator = [
-    {
-      dateFnsFormat: 'dd/MM/yyyy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'd/M/yyyy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'MM/dd/yyyy',
-      direction: 'MDY',
-    },
-    {
-      dateFnsFormat: 'M/d/yyyy',
-      direction: 'MDY',
-    },
-    {
-      dateFnsFormat: 'MM/dd/yy',
-      direction: 'MDY',
-    },
-    {
-      dateFnsFormat: 'dd/MM/yy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'd/M/yy',
-      direction: 'DMY',
-    },
-    {
-      dateFnsFormat: 'M/d/yy',
-      direction: 'MDY',
-    },
-  ];
-
-  const localised = [
-    ...cartesian([
-      ['MMMM'],
-      ['d', 'do'],
-      [',', ''],
-      ['yyyy'],
-      [',', ''],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: formatCombinaison(combination),
-        };
-      }),
-    ...cartesian([
-      [
-        'do',
-        'd',
-      ],
-      [
-        'MMMM',
-        'MMM',
-      ],
-      [
-        'yyyy',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: formatCombinaison(combination),
-        };
-      }),
-    ...cartesian([
-      [
-        'MMMM',
-        'MMM',
-      ],
-      [
-        'yyyy',
-      ],
-      [
-        'do',
-        'd',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: formatCombinaison(combination),
-        };
-      }),
-    {
-      dateFnsFormat: 'MMMM yyyy EEE do',
-    },
-    {
-      dateFnsFormat: 'MMMM yyyy EEE d',
-    },
-  ];
-
-  const impliedYearLocalised = [
-    ...cartesian([
-      [
-        'EEEE',
-        'EEE',
-      ],
-      [
-        '',
-        ',',
-      ],
-      [
-        'MMMM',
-        'MMM',
-      ],
-      [
-        'dd',
-        'do',
-        'd',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: formatCombinaison(combination),
-        };
-      }),
-    ...cartesian([
-      [
-        'EEEE',
-        'EEE',
-      ],
-      [
-        '',
-        ',',
-      ],
-      [
-        'dd',
-        'do',
-        'd',
-      ],
-      [
-        'MMMM',
-        'MMM',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: formatCombinaison(combination),
-        };
-      }),
-    ...cartesian([
-      [
-        'MMMM',
-        'MMM',
-      ],
-      [
-        'dd',
-        'do',
-        'd',
-      ],
-      [
-        ',',
-        '',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: formatCombinaison(combination),
-        };
-      }),
-    ...cartesian([
-      [
-        'dd',
-        'do',
-        'd',
-      ],
-      [
-        'MMMM',
-        'MMM',
-      ],
-      [
-        ',',
-        '',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: formatCombinaison(combination),
-        };
-      }),
-  ];
-
-  const impliedYear = [
-    ...cartesian([
-      [
-        'dd',
-        'd',
-      ],
-      [
-        '/',
-        '-',
-        '.',
-      ],
-      [
-        'MM',
-        'M',
-      ],
-      [
-        ',',
-        '',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: combination.join('').replace(' ,', ',').replace(/ +/, ' '),
-          direction: 'DM',
-        };
-      }),
-    ...cartesian([
-      [
-        'MM',
-        'M',
-      ],
-      [
-        '/',
-        '-',
-        '.',
-      ],
-      [
-        'dd',
-        'd',
-      ],
-      [
-        ',',
-        '',
-      ],
-    ])
-      .map((combination) => {
-        return {
-          dateFnsFormat: combination.join('').replace(' ,', ',').replace(/ +/, ' '),
-          direction: 'MD',
-        };
-      }),
-  ];
-
-  const relative = [
-    {
-      dateFnsFormat: 'R',
-      test: false,
-    }
-  ];
-
-  return [
-    {
-      dateFnsFormat: 'yyyyMMdd',
-    },
-    ...yearFirstDashSeparator,
-    ...yearFirstDotSeparator,
-    ...yearFirstSlashSeparator,
-    ...yearLastDashSeparator,
-    ...yearLastDotSeparator,
-    ...yearLastSlashSeparator,
-    ...localised,
-    ...impliedYearLocalised,
-    ...impliedYear,
-    ...relative,
-  ]
-    .map((format) => {
-      return {
+    const yearFirstDashSeparator = [
+        { dateFnsFormat: 'yyyy-MM-dd' },
+        { dateFnsFormat: 'yyyy-M-d' },
+    ];
+    const yearFirstSlashSeparator = [
+        { dateFnsFormat: 'yyyy/MM/dd' },
+        { dateFnsFormat: 'yyyy/M/d' },
+    ];
+    const yearFirstDotSeparator = [
+        { dateFnsFormat: 'yyyy.MM.dd', direction: 'YMD' },
+        { dateFnsFormat: 'yyyy.M.d', direction: 'YMD' },
+        { dateFnsFormat: 'yyyy.dd.MM', direction: 'YDM' },
+        { dateFnsFormat: 'yyyy.d.M', direction: 'YDM' },
+    ];
+    const yearLastDashSeparator = [
+        { dateFnsFormat: 'dd-MM-yyyy', direction: 'DMY' },
+        { dateFnsFormat: 'd-M-yyyy', direction: 'DMY' },
+        { dateFnsFormat: 'MM-dd-yyyy', direction: 'MDY' },
+        { dateFnsFormat: 'M-d-yyyy', direction: 'MDY' },
+    ];
+    const yearLastDotSeparator = [
+        { dateFnsFormat: 'dd.MM.yyyy', direction: 'DMY' },
+        { dateFnsFormat: 'd.M.yyyy', direction: 'DMY' },
+        { dateFnsFormat: 'MM.dd.yyyy', direction: 'MDY' },
+        { dateFnsFormat: 'M.d.yyyy', direction: 'MDY' },
+        { dateFnsFormat: 'dd.MM.yy', direction: 'DMY' },
+        { dateFnsFormat: 'd.M.yy', direction: 'DMY' },
+    ];
+    const yearLastSlashSeparator = [
+        { dateFnsFormat: 'dd/MM/yyyy', direction: 'DMY' },
+        { dateFnsFormat: 'd/M/yyyy', direction: 'DMY' },
+        { dateFnsFormat: 'MM/dd/yyyy', direction: 'MDY' },
+        { dateFnsFormat: 'M/d/yyyy', direction: 'MDY' },
+        { dateFnsFormat: 'MM/dd/yy', direction: 'MDY' },
+        { dateFnsFormat: 'dd/MM/yy', direction: 'DMY' },
+        { dateFnsFormat: 'd/M/yy', direction: 'DMY' },
+        { dateFnsFormat: 'M/d/yy', direction: 'MDY' },
+    ];
+    const localised = [
+        ...cartesian([
+            ['MMMM'],
+            ['d', 'do'],
+            [',', ''],
+            ['yyyy'],
+            [',', ''],
+        ]).map((combination) => ({ dateFnsFormat: formatCombinaison(combination) })),
+        ...cartesian([
+            ['do', 'd'],
+            ['MMMM', 'MMM'],
+            ['yyyy'],
+        ]).map((combination) => ({ dateFnsFormat: formatCombinaison(combination) })),
+        ...cartesian([
+            ['MMMM', 'MMM'],
+            ['yyyy'],
+            ['do', 'd'],
+        ]).map((combination) => ({ dateFnsFormat: formatCombinaison(combination) })),
+        { dateFnsFormat: 'MMMM yyyy EEE do' },
+        { dateFnsFormat: 'MMMM yyyy EEE d' },
+    ];
+    const impliedYearLocalised = [
+        ...cartesian([
+            ['EEEE', 'EEE'],
+            ['', ','],
+            ['MMMM', 'MMM'],
+            ['dd', 'do', 'd'],
+        ]).map((combination) => ({ dateFnsFormat: formatCombinaison(combination) })),
+        ...cartesian([
+            ['EEEE', 'EEE'],
+            ['', ','],
+            ['dd', 'do', 'd'],
+            ['MMMM', 'MMM'],
+        ]).map((combination) => ({ dateFnsFormat: formatCombinaison(combination) })),
+        ...cartesian([
+            ['MMMM', 'MMM'],
+            ['dd', 'do', 'd'],
+            [',', ''],
+        ]).map((combination) => ({ dateFnsFormat: formatCombinaison(combination) })),
+        ...cartesian([
+            ['dd', 'do', 'd'],
+            ['MMMM', 'MMM'],
+            [',', ''],
+        ]).map((combination) => ({ dateFnsFormat: formatCombinaison(combination) })),
+    ];
+    const impliedYear = [
+        ...cartesian([
+            ['dd', 'd'],
+            ['/', '-', '.'],
+            ['MM', 'M'],
+            [',', ''],
+        ]).map((combination) => ({
+            dateFnsFormat: combination.join('').replace(' ,', ',').replace(/ +/, ' '),
+            direction: 'DM',
+        })),
+        ...cartesian([
+            ['MM', 'M'],
+            ['/', '-', '.'],
+            ['dd', 'd'],
+            [',', ''],
+        ]).map((combination) => ({
+            dateFnsFormat: combination.join('').replace(' ,', ',').replace(/ +/, ' '),
+            direction: 'MD',
+        })),
+    ];
+    const relative = [
+        { dateFnsFormat: 'R', test: false },
+    ];
+    return [
+        { dateFnsFormat: 'yyyyMMdd' },
+        ...yearFirstDashSeparator,
+        ...yearFirstDotSeparator,
+        ...yearFirstSlashSeparator,
+        ...yearLastDashSeparator,
+        ...yearLastDotSeparator,
+        ...yearLastSlashSeparator,
+        ...localised,
+        ...impliedYearLocalised,
+        ...impliedYear,
+        ...relative,
+    ]
+        .map((format) => ({
         localised: /eee|mmm/i.test(format.dateFnsFormat),
         specificity: calculateSpecificity(format.dateFnsFormat),
         wordCount: format.dateFnsFormat.replace(/[^ ]/g, '').length + 1,
         yearIsExplicit: format.dateFnsFormat.includes('yyyy'),
         ...format,
-      };
-    })
-    .sort((a, b) => {
-      if (a.wordCount !== b.wordCount) {
-        return b.wordCount - a.wordCount;
-      }
-
-      if (b.specificity === a.specificity) {
-        return a.dateFnsFormat.localeCompare(b.dateFnsFormat);
-      }
-
-      return b.specificity - a.specificity;
+    }))
+        .sort((a, b) => {
+        if (a.wordCount !== b.wordCount) {
+            return b.wordCount - a.wordCount;
+        }
+        if (b.specificity === a.specificity) {
+            return a.dateFnsFormat.localeCompare(b.dateFnsFormat);
+        }
+        return b.specificity - a.specificity;
     });
 };

package/src/createMovingChunks.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (haystack: readonly string[], sliceLength: number) => readonly (readonly string[])[];
+export default _default;