Complete Refactor to TypeScript, Improved Test Coverage, and Bug Fixes

.editorconfig

@@ -0,0 +1,10 @@
+# .editorconfig
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+max_line_length = 160
+
+[*.{js,ts}]
+ij_typescript_spaces_within_imports  = true

.eslintrc.cjs

@@ -0,0 +1,49 @@
+module.exports = {
+  root: true,
+  env: {
+    browser: false,
+    es6: true,
+    node: true,
+    jest: true,
+  },
+  extends: [
+    'eslint:recommended'
+  ],
+  ignorePatterns: [
+    'dist/**',
+    '**/*.json',
+    'coverage/**',
+    'docs/**',
+    'src/index.cjs.js',
+  ],
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  },
+  overrides: [
+    {
+      files: ['**/*.ts'],
+      env: { 'browser': false, 'es6': true, 'node': true },
+      extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/recommended'
+      ],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+      },
+      plugins: ['@typescript-eslint'],
+      rules: {
+        indent: ['error', 2, { SwitchCase: 1 }],
+        quotes: ['error', 'single'],
+        semi: ['error', 'always'],
+        'comma-dangle': ['error', 'always-multiline'],
+        '@typescript-eslint/no-explicit-any': 0,
+        'object-curly-spacing': ['warn', 'always'],
+        'max-len': ['error', { code: 160 }],
+      }
+    }
+  ]
+};

.github/workflows/push.yml

@@ -22,4 +22,5 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
+      - run: npm run build
       - run: npm test

.gitignore

@@ -1,4 +1,4 @@
-node_modules/
+node_modules
 lib-cov
 coverage
 *.seed
@@ -12,10 +12,14 @@ coverage
 pids
 logs
 results
+dist
+testing
 
-npm-debug.log
-
+.run
 .idea
 .history
 .vscode
 .nyc_output
+yarn.lock
+
+!coverage/*.svg

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run precommit

.npmignore

@@ -3,3 +3,21 @@
 .history
 .nyc_output
 node_modules
+src
+tsconfig.cjs.json
+tsconfig.esm.json
+tsconfig.json
+package-lock.json
+yarn.lock
+.github
+docs
+.run
+.husky
+tests
+.editorconfig
+.eslintrc.cjs
+.gitignore
+component.json
+jest.config.js
+notes.md
+

README.md

@@ -2,7 +2,15 @@ cron-parser
 ================
 
 [![Build Status](https://github.com/harrisiirak/cron-parser/actions/workflows/push.yml/badge.svg?branch=master)](https://github.com/harrisiirak/cron-parser/actions/workflows/push.yml)
-[![NPM version](https://badge.fury.io/js/cron-parser.png)](http://badge.fury.io/js/cron-parser)
+[![NPM version](https://badge.fury.io/js/cron-parser.png)](http://badge.fury.io/js/cron-parser)![Statements](./coverage/badge-statements.svg)
+
+[//]: # (![Branches](./coverage/badge-branches.svg))
+
+[//]: # (![Functions](./coverage/badge-functions.svg))
+
+[//]: # (![Lines](./coverage/badge-lines.svg))
+
+
 
 Node.js library for parsing and manipulating crontab instructions. It includes support for timezones and DST transitions.
 
@@ -111,21 +119,42 @@ try {
 }
 ```
 
-Manipulation 
+Manipulation
 
 ```javascript
 var parser = require('cron-parser');
 
 var interval = parser.parseExpression('0 7 * * 0-4');
-var fields = JSON.parse(JSON.stringify(interval.fields)); // Fields is immutable
+var fields = JSON.parse(JSON.stringify(interval.#fields)); // Fields is immutable
 fields.hour = [8];
 fields.minute = [29];
-fields.dayOfWeek = [1,3,4,5,6,7];
+fields.dayOfWeek = [1, 3, 4, 5, 6, 7];
 var modifiedInterval = parser.fieldsToExpression(fields);
 var cronString = modifiedInterval.stringify();
 console.log(cronString); // "29 8 * * 1,3-7"
 ```
 
+Strict Mode
+
+In several implementations of CRON, it's ambiguous to specify both the Day Of Month and Day Of Week parameters simultaneously, as it's unclear which one should take precedence. Despite this ambiguity, this library allows both parameters to be set by default, although the resultant behavior might not align with your expectations.
+
+To resolve this ambiguity, you can activate the strict mode of the library. In strict mode, the library prevents the simultaneous setting of both Day Of Month and Day Of Week, effectively serving as a validation method for user inputs. To enable strict mode, set the `options.strict` flag to true.
+
+Consider the example below:
+
+```javascript
+// Specifies a schedule that occurs at 12:00 on every day-of-month from 1 through 31 and on Monday.
+const options = {
+  currentDate: new CronDate('Mon, 12 Sep 2022 14:00:00', 'UTC'),
+  strict: true,
+};
+const expression = '0 0 12 1-31 * 1';
+// With strict mode enabled, the parser throws an error as both dayOfMonth and dayOfWeek are used together.
+CronExpression.parse(expression, options); // throws: Cannot use both dayOfMonth and dayOfWeek together in strict mode!
+```
+
+In this example, the CRON expression is meant to trigger an event at 12:00 on every day from the 1st through the 31st and on every Monday. However, since strict mode is enabled in the options, an error is thrown, indicating that both the dayOfMonth and dayOfWeek parameters cannot be used together.
+
 Options
 ========
 
@@ -145,7 +174,7 @@ The reason being that those are the formats accepted by the
 [`luxon`](https://moment.github.io/luxon/) library which is being used to handle dates.
 
 Using `Date` as an input can be problematic specially when using the `tz` option. The issue being that, when creating a new `Date` object without
-any timezone information, it will be created in the timezone of the system that is running the code. This (most of times) won't be what the user
+any timezone information, it will be created in the timezone of the system that is running the code. This (most of the times) won't be what the user
 will be expecting. Using one of the supported `string` formats will solve the issue(see timezone example).
 
 * *iterator* - Return ES6 compatible iterator object 

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/assets/highlight.css

@@ -0,0 +1,22 @@
+:root {
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --code-background: var(--dark-code-background);
+}
+
+pre, code { background: var(--code-background); }