feat: esm only build

* Test against active LTS versions of Node
* Switch from jest to vitest
* Upgrade dev dependencies

BREAKING CHANGE: The package is now ESM only. A CommonJS or IIFE build is no longer provided.
BREAKING CHANGE: The minimum required version of Node.js is now 14
BREAKING CHANGE: utils are no longer exposed
BREAKING CHANGE: schedulers are no longer exposed in the default entry point.
Import them from `cron-schedule/schedulers/interval-based.js` and
`cron-schedule/schedulers/timer-based.js` instead.

Signed-off-by: Pascal Sthamer <[email protected]>

.circleci/config.yml

@@ -1,12 +1,12 @@
 version: 2.1
 
 orbs:
-  node: circleci/[email protected].2
+  node: circleci/[email protected].3
 
 jobs:
   release:
     docker:
-      - image: circleci/node:16
+      - image: circleci/node:18
     steps:
       - checkout
       - run:
@@ -20,12 +20,13 @@ workflows:
       - node/test:
           pkg-manager: yarn
           override-ci-command: yarn install --immutable
+          run-command: test:run
           matrix:
             parameters:
               version:
-                - "12.18"
-                - "14.13"
-                - "16.12"
+                - "14.21"
+                - "16.20"
+                - "18.15"
       - release:
           requires:
             - node/test

.eslintrc.js → .eslintrc.cjs

@@ -9,18 +9,17 @@ module.exports = {
   ignorePatterns: ['node_modules/', 'dist/'],
   root: true,
   env: {
-    es2017: true,
-    browser: false,
-    node: false,
+    es6: true,
   },
   plugins: ['security'],
   rules: {
     'no-console': 'error',
     'no-bitwise': 'error',
     'import/order': 'error',
-    // Allow unresolved imports. TypeScript already checks this and nuxt webpack aliases are not supported.
-    'import/no-unresolved': 'off',
-    'security/detect-object-injection': 'off',
+  },
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
   },
   overrides: [
     {
@@ -32,10 +31,11 @@ module.exports = {
       plugins: ['@typescript-eslint'],
       parser: '@typescript-eslint/parser',
       parserOptions: {
-        ecmaVersion: 2020,
-        sourceType: 'module',
         project: './tsconfig.eslint.json',
       },
+      rules: {
+        'import/no-unresolved': 'off', // Leads to false-positives and Typescript already checks imports.
+      }
     },
   ],
 }

.github/workflows/codeql-analysis.yml

@@ -1,21 +1,9 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
 name: "CodeQL"
 
 on:
   push:
     branches: [ master ]
   pull_request:
-    # The branches below must be a subset of the branches above
     branches: [ master ]
   schedule:
     - cron: '36 14 * * 3'
@@ -29,39 +17,18 @@ jobs:
       fail-fast: false
       matrix:
         language: [ 'javascript' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
-        # Learn more:
-        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
     - name: Checkout repository
       uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
       uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v2

.husky/pre-commit

@@ -1,5 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn test
+yarn test:run
 yarn lint

README.md

@@ -11,11 +11,11 @@ A zero-dependency cron parser and scheduler for Node.js, Deno and the browser.
 * Get next or previous schedules from a specific starting date.
 * Check if a date matches a cron expression.
 * Schedule a function call based on a cron expression.
-* Supports Node.js, Deno and the browser (IIFE or ESM, ES6 required)
+* Supports Node.js, Deno and the browser (ESM only)
 * [Lightweight](https://bundlephobia.com/result?p=cron-schedule@latest) and tree-shakeable.
 
 ## Installation and usage
-### Node.js (CommonJS)
+### Node.js
 Via npm:
 
 `$ npm install cron-schedule`
@@ -24,7 +24,7 @@ Via yarn:
 
 `$ yarn add cron-schedule`
 
-**We test our code against the following Node.js releases (`12.18`, `14.13`, `16.12`).**
+**We test our code against the following Node.js releases (`14.21`, `16.20`, `18.15`).**
 Other versions of node.js may also work, but this is not tested.
 
 ##### Usage
@@ -35,25 +35,7 @@ console.log(cron.getNextDate(new Date(2020, 10, 20, 18, 32)))
 // 2020-11-20T17:35:00.000Z
 ```
 
-## Browser (IIFE)
-```html
-<script src="https://unpkg.com/cron-schedule@:version"></script>
-```
-
-After the script has been loaded, you can use the global `cronSchedule` object to access the API.
-
-##### Usage
-```html
-<script>
-  const cron = cronSchedule.parseCronExpression('*/5 * * * *')
-  console.log(cron.getNextDate(new Date(2020, 10, 20, 18, 32)))
-  // 2020-11-20T17:35:00.000Z
-</script>
-```
-
-**Requires ES6 (ES2015) browser support. Internet Explorer is not supported.** If you need to support older browsers, get _cron-schedule_ via npm or yarn and transpile it with your bundler.
-
-### Browser (ECMAScript module)
+### Browser via CDN
 ```html
 <script type="module">
   import { parseCronExpression } from 'https://cdn.skypack.dev/cron-schedule@:version'
@@ -65,22 +47,22 @@ After the script has been loaded, you can use the global `cronSchedule` object t
 
 ### Deno
 ```ts
-import { parseCronExpression } from 'https://cdn.skypack.dev/cron-schedule@:version?dts'
+import { parseCronExpression } from 'npm:cron-schedule@:version'
 // TypeScript types are automatically shipped with the X-TypeScript-Types http header.
 const cron = parseCronExpression('*/5 * * * *')
 console.log(cron.getNextDate(new Date(2020, 10, 20, 18, 32)))
 // 2020-11-20T17:35:00.000Z
 ```
 
 ### Note on CDN usage
-The examples above use [unpkg](http://unpkg.com) for IIFE and [Skypack](https://www.skypack.dev) for ESM.
+The examples above use [Skypack](https://www.skypack.dev).
 
-The urls contain `:version` placeholder. Replace `:version` with the desired version. Semver ranges are supported. To always use the latest `2.x` version use `^2.0.0`.
+The urls contain `:version` placeholder. Replace `:version` with the desired version. Semver ranges are supported. To always use the latest `4.x` version use `^4.0.0`.
 See https://www.npmjs.com/package/cron-schedule for a list of available versions.
 
 ## Work with cron expressions
 ```ts
-// Import method to parse a cron expression. In the browser with IIFE: cronSchedule.parseCronExpression
+// Import method to parse a cron expression.
 import { parseCronExpression } from 'cron-schedule'
 
 // Parse a cron expression to return a Cron instance.
@@ -120,8 +102,8 @@ The timer based cron scheduler creates one timer for every scheduled cron.
 When the node timeout limit of ~24 days would be exceeded, it uses multiple consecutive timeouts.
 
 ```ts
-// Import the scheduler. In the browser with IIFE: cronSchedule.TimerBasedCronScheduler
-import { TimerBasedCronScheduler as scheduler } from 'cron-schedule'
+// Import the scheduler.
+import { TimerBasedCronScheduler as scheduler } from 'cron-schedule/schedulers/timer-based.js'
 
 // Create a timeout, which fill fire the task on the next cron date.
 // An optional errorHandler can be provided, which is called when the task throws an error or returns a promise that gets rejected.
@@ -149,8 +131,8 @@ scheduler.clearTimeoutOrInterval(handle: ITimerHandle): void
 The interval based scheduler checks for due task in a fixed interval. So there is only one interval for all tasks assigned to a scheduler.
 You can have multiple instances of an interval based scheduler. 
 ```ts
-// Import the scheduler. In the browser with IIFE: cronSchedule.IntervalBasedCronScheduler
-import { IntervalBasedCronScheduler } from 'cron-schedule'
+// Import the scheduler.
+import { IntervalBasedCronScheduler } from 'cron-schedule/schedulers/interval-based.js'
 
 // Instantiate a new instance of the scheduler with the given interval. In this example, the scheduler would check every 60 seconds.
 const scheduler = new IntervalBasedCronScheduler(60 * 1000)

package.json

@@ -26,13 +26,27 @@
     "schedule-tasks",
     "nodejs"
   ],
-  "main": "dist/cron-schedule.cjs.min.js",
-  "module": "dist/cron-schedule.min.mjs",
-  "unpkg": "dist/cron-schedule.iife.min.js",
+  "type": "module",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts"
+  ],
   "exports": {
-    "require": "./dist/cron-schedule.cjs.min.js",
-    "import": "./dist/cron-schedule.min.mjs"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./schedulers/interval-based.js": {
+      "type": "./dist/schedulerrs/interval-based.d.ts",
+      "default": "./dist/schedulers/interval-based.js"
+    },
+    "./schedulers/timer-based.js": {
+      "type": "./dist/schedulers/timer-based.d.ts",
+      "default": "./dist/schedulers/timer-based.js"
+    }
   },
+  "sideEffects": false,
   "release": {
     "branches": [
       "master",
@@ -58,54 +72,39 @@
       "@semantic-release/git"
     ]
   },
-  "files": [
-    "dist/**/*.js",
-    "dist/**/*.js.map",
-    "dist/**/*.mjs",
-    "dist/**/*.mjs.map",
-    "dist/**/*.d.ts"
-  ],
-  "types": "./dist/index.d.ts",
-  "sideEffects": false,
   "scripts": {
-    "build": "rimraf ./dist && tsc -p ./tsconfig.json --emitDeclarationOnly && node build.js",
+    "build": "rimraf ./dist && tsc -p ./tsconfig.json",
     "tsc:check": "tsc --project ./tsconfig.json --noEmit",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "lint:fix": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\"",
-    "test": "jest -c jest.config.js",
-    "test:watch": "jest -c jest.config.js --watchAll",
+    "test": "vitest",
+    "test:run": "vitest run",
     "prepack": "yarn build",
     "postinstall": "husky install",
     "prepublishOnly": "pinst --disable",
     "postpublish": "pinst --enable"
   },
   "devDependencies": {
-    "@commitlint/cli": "17.5.0",
+    "@commitlint/cli": "17.5.1",
     "@commitlint/config-conventional": "17.4.4",
     "@commitlint/prompt-cli": "17.5.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@types/jest": "29.5.0",
-    "@typescript-eslint/eslint-plugin": "5.56.0",
-    "@typescript-eslint/parser": "5.56.0",
-    "@typescript-eslint/typescript-estree": "5.56.0",
-    "esbuild": "0.17.14",
-    "eslint": "8.36.0",
+    "@typescript-eslint/eslint-plugin": "5.57.0",
+    "@typescript-eslint/parser": "5.57.0",
+    "@typescript-eslint/typescript-estree": "5.57.0",
+    "eslint": "8.37.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-security": "1.7.1",
     "husky": "8.0.3",
-    "jest": "29.5.0",
     "pinst": "3.0.0",
     "prettier": "2.8.7",
     "rimraf": "4.4.1",
     "semantic-release": "21.0.0",
-    "ts-jest": "29.0.5",
-    "typescript": "5.0.2"
-  },
-  "resolutions": {
-    "npm/chalk": "4.1.2"
+    "typescript": "5.0.2",
+    "vitest": "0.29.8"
   },
   "commitlint": {
     "extends": [

src/cron-parser.ts

@@ -1,4 +1,4 @@
-import { Cron } from './cron'
+import { Cron } from './cron.js'
 
 interface IConstraint {
   min: number

src/cron.ts

@@ -2,7 +2,7 @@ import {
   extractDateElements,
   getDaysBetweenWeekdays,
   getDaysInMonth,
-} from './utils'
+} from './utils.js'
 
 /**
  * An object with contains for each element of a date, which values are allowed.