4.0.0-beta.0: Updated date parsing and imports (#72)

* 4.0.0-beta.0: Updated date parsing and imports. See changelog for full details

* Fix build out of date

* Format files prettier

* Fixed prettier and README

* Fix function definitions

* Fix rollup transform

* Move to typescript and revert name change

* Fix types

* Change to alpha

* Fixes for named imports

Author: taylorhakes

.babelrc

@@ -0,0 +1,8 @@
+{
+    "presets": [
+      [
+        "@babel/preset-env"
+      ]
+    ],
+    "plugins": ["@babel/plugin-proposal-optional-chaining"]
+}

.browserslistrc

@@ -0,0 +1 @@
+defaults

.eslintrc.js

@@ -1,29 +1,16 @@
 module.exports = {
-  "env": {
-    "browser": true,
-    "node": true,
-    "amd": true
-  },
-  "extends": "eslint:recommended",
-  "rules": {
-    "indent": [
-      "error",
-      2
-    ],
-    "linebreak-style": [
-      "error",
-      "unix"
-    ],
-    "quotes": [
-      "error",
-      "single"
-    ],
-    "semi": [
-      "error",
-      "always"
-    ]
-  },
-  "parserOptions": {
-    "sourceType": "module"
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier/@typescript-eslint',
+  ],
+  rules: {
+    "@typescript-eslint/ban-ts-ignore": "off"
   }
 };

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 coverage
-.nyc_output
+.nyc_output
+ts-out

.nycrc

@@ -0,0 +1,3 @@
+{
+    "extends": "@istanbuljs/nyc-config-typescript"
+}

.travis.yml

@@ -1,3 +1,3 @@
 language: node_js
 node_js:
-  - 8.9.0
+  - 12.14

CHANGELOG.md

@@ -1,3 +1,39 @@
+## 4.0.0-alpha.0
+** Major Features and  Breaking changes in this version**
+
+#### Improvements
+- *Valid date parsing* - By default fecha will check validity of dates. Previously `2019-55-01` or `2019-01-42` would parse correctly, since Javascript can handle it. Now invalid dates will return `null` instead
+- *ES Module and Tree Shaking Support* - You can now import fecha `parse` or `format` independently
+```js
+import {format, parse} from 'fecha';
+
+format(...);
+parse(...)
+
+
+#### Breaking changes
+- `parseDate` may return `null` when previously returned a `Date`. See improvements above, but invalid dates will return `null` now
+- Change to how to set masks and i18n
+Previously
+```js
+import fecha from 'fecha';
+
+fecha.i18n = { ... }
+fecha.masks.myMask = 'DD , MM, YYYY' 
+```
+
+New
+```js
+import {parse, format, setGlobalDateI18n, setGlobalDateMasks} from 'fecha';
+
+setGlobalDateI18n({
+    // ...
+})
+setGlobalDateMasks({
+  myMask: 'DD , MM, YYYY'
+});
+```
+
 ### 3.0.3
 - Fixed bug when using brackets when parsing dates
 ### 3.0.2

README.md

@@ -46,58 +46,99 @@ npm install fecha --save
 ## Use it
 
 #### Formatting
-`fecha.format` accepts a Date object (or timestamp) and a string format and returns a formatted string. See below for
+`format` accepts a Date object (or timestamp) and a string format and returns a formatted string. See below for
 available format tokens.
 
-Note: `fecha.format` will throw an error when passed invalid parameters
+Note: `format` will throw an error when passed invalid parameters
 ```js
-fecha.format(<Date Object>, <String Format>);
+import { format } from 'fecha';
+
+type format = (date: Date, format?: string, i18n?: I18nSettings) => str;
 
 // Custom formats
-fecha.format(new Date(2015, 10, 20), 'dddd MMMM Do, YYYY'); // 'Friday November 20th, 2015'
-fecha.format(new Date(1998, 5, 3, 15, 23, 10, 350), 'YYYY-MM-DD hh:mm:ss.SSS A'); // '1998-06-03 03:23:10.350 PM'
+format(new Date(2015, 10, 20), 'dddd MMMM Do, YYYY'); // 'Friday November 20th, 2015'
+format(new Date(1998, 5, 3, 15, 23, 10, 350), 'YYYY-MM-DD hh:mm:ss.SSS A'); // '1998-06-03 03:23:10.350 PM'
 
 // Named masks
-fecha.format(new Date(2015, 10, 20), 'mediumDate'); // 'Nov 20, 2015'
-fecha.format(new Date(2015, 2, 10, 5, 30, 20), 'shortTime'); // '05:30'
+format(new Date(2015, 10, 20), 'mediumDate'); // 'Nov 20, 2015'
+format(new Date(2015, 2, 10, 5, 30, 20), 'shortTime'); // '05:30'
 
 // Literals
-fecha.format(new Date(2001, 2, 5, 6, 7, 2, 5), '[on] MM-DD-YYYY [at] HH:mm'); // 'on 03-05-2001 at 06:07'
+format(new Date(2001, 2, 5, 6, 7, 2, 5), '[on] MM-DD-YYYY [at] HH:mm'); // 'on 03-05-2001 at 06:07'
 ```
 
 #### Parsing
-`fecha.parse` accepts a Date string and a string format and returns a Date object. See below for available format tokens.
+`parse` accepts a Date string and a string format and returns a Date object. See below for available format tokens. 
 
-Note: `fecha.parse` will throw an error when passed invalid parameters
+*NOTE*: `parse` will throw an error when passed invalid string format or missing format. You MUST specify a format.
 ```js
+import { parse } from 'fecha';
+
+type parse = (dateStr: string, format: string, i18n?: I18nSettingsOptional) => Date|null;
+
 // Custom formats
-fecha.parse('February 3rd, 2014', 'MMMM Do, YYYY'); // new Date(2014, 1, 3)
-fecha.parse('10-12-10 14:11:12', 'YY-MM-DD HH:mm:ss'); // new Date(2010, 11, 10, 14, 11, 12)
+parse('February 3rd, 2014', 'MMMM Do, YYYY'); // new Date(2014, 1, 3)
+parse('10-12-10 14:11:12', 'YY-MM-DD HH:mm:ss'); // new Date(2010, 11, 10, 14, 11, 12)
 
 // Named masks
-fecha.parse('5/3/98', 'shortDate'); // new Date(1998, 4, 3)
-fecha.parse('November 4, 2005', 'longDate'); // new Date(2005, 10, 4)
+parse('5/3/98', 'shortDate'); // new Date(1998, 4, 3)
+parse('November 4, 2005', 'longDate'); // new Date(2005, 10, 4)
+
+// Override i18n
+parse('4 de octubre de 2005', 'M de MMMM de YYYY', {
+  monthNames: [
+    'enero',
+    'febrero',
+    'marzo',
+    'abril',
+    'mayo',
+    'junio',
+    'julio',
+    'agosto',
+    'septiembre',
+    'octubre',
+    'noviembre',
+    'diciembre'
+  ]
+});
 ```
 
 #### i18n Support
 ```js
-// Override fecha.i18n to support any language
-fecha.i18n = {
+// Default Global Settings
+{
 	dayNamesShort: ['Sun', 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat'],
+	dayNames: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
+	monthNamesShort: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
+	monthNames: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
+	amPm: ['am', 'pm'],
+	// D is the day of the month, function returns something like...  3rd or 11th
+	DoFn(dayOfMonth) {
+		return dayOfMonth + [ 'th', 'st', 'nd', 'rd' ][ dayOfMonth % 10 > 3 ? 0 : (dayOfMonth - dayOfMonth % 10 !== 10) * dayOfMonth % 10 ];
+  }
+}
+
+// Override global settings
+import {setGlobalDateI18n} from 'fecha';
+
+setGlobalDateI18n({
+  dayNamesShort: ['Sun', 'Mon', 'Tue', 'Wed', 'Thur', 'Fri', 'Sat'],
 	dayNames: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'],
 	monthNamesShort: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'],
 	monthNames: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
 	amPm: ['am', 'pm'],
 	// D is the day of the month, function returns something like...  3rd or 11th
 	DoFn: function (D) {
 		return D + [ 'th', 'st', 'nd', 'rd' ][ D % 10 > 3 ? 0 : (D - D % 10 !== 10) * D % 10 ];
-    }
-}
+  }
+});
+
 ```
 
 #### Custom Named Masks
 ```js
-fecha.masks = {
+// Default global masks
+{
 	default: 'ddd MMM DD YYYY HH:mm:ss',
 	shortDate: 'M/D/YY',
 	mediumDate: 'MMM D, YYYY',
@@ -106,13 +147,17 @@ fecha.masks = {
 	shortTime: 'HH:mm',
 	mediumTime: 'HH:mm:ss',
 	longTime: 'HH:mm:ss.SSS'
-};
+}
 
 // Create a new mask
-fecha.masks.myMask = 'HH:mm:ss YY/MM/DD';
+import { format, setGlobalDateMasks } from 'fecha';
+
+setGlobalDateMasks({
+  myMask: 'HH:mm:ss YY/MM/DD';
+});
 
 // Use it
-fecha.format(new Date(2014, 5, 6, 14, 10, 45), 'myMask'); // '14:10:45 14/06/06'
+format(new Date(2014, 5, 6, 14, 10, 45), 'myMask'); // '14:10:45 14/06/06'
 ```
 
 ### Formatting Tokens