cron-converter-u2q 0.1.3 → 0.1.9

package/.eslintrc.yml

@@ -0,0 +1,14 @@
+env:
+  browser: true
+  es2021: true
+extends:
+  - eslint:recommended
+  - plugin:@typescript-eslint/recommended
+parser: "@typescript-eslint/parser"
+parserOptions:
+  ecmaVersion: latest
+  sourceType: module
+plugins:
+  - "@typescript-eslint"
+rules:
+  "@typescript-eslint/no-unused-vars": "off"

package/.github/workflows/integration.yml

@@ -0,0 +1,37 @@
+name: Build
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    name: Build and Test
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Clean Install Dependencies
+        run: npm ci
+
+      - name: Run Tests
+        run: npm test
+
+      - name: Linting
+        run: npm run lint
+
+      - name: Run build
+        run: npm run build --if-present

package/README.md

@@ -1,14 +1,14 @@
 # cron-converter-u2q
-Easily convert cron expressions between Unix and Quartz formats with the `cron-converter-u2q` package
 
+Easily convert cron expressions between Unix and Quartz formats with the `cron-converter-u2q` package
 
+![example event parameter](https://github.com/rahu619/cron-converter-u2q/actions/workflows/integration.yml/badge.svg?event=push)
+[![NPM version](https://badge.fury.io/js/cron-conveter-u2q.svg)](https://www.npmjs.com/package/cron-conveter-u2q)
 
 ### Features
 
 :arrows_counterclockwise: Two-way conversion: from Unix to Quartz and Quartz to Unix.
 
-:zap: Lightweight.
-
 ### Installation
 
 Using npm:
@@ -24,28 +24,37 @@ yarn add cron-converter
 ```
 
 ### Usage
+
 Firstly, import the CronConverterU2Q module:
+
 ```javascript
-import { CronConverterU2Q as c2q } from 'cron-converter';
+var cron_converter_u2q = require("cron-converter-u2q");
+
+var c2q = cron_converter_u2q.CronConverterU2Q;
 ```
 
 If you're using ES6 Modules
+
 ```javascript
-import { CronConverterU2Q as c2q } from 'cron-converter';
+import { CronConverterU2QModule as c2q } from "cron-converter-u2q";
 ```
+
 Convert from Unix to Quartz
+
 ```javascript
-const quartzExpression = c2q.unixToQuartz('5 * * * *');
+const quartzExpression = c2q.unixToQuartz("5 * * * *");
 ```
+
 Convert from Quartz to Unix
+
 ```javascript
-const unixExpression = c2q.quartzToUnix('* */5 * ? * * *');
+const unixExpression = c2q.quartzToUnix("* */5 * ? * * *");
 ```
 
 ### Development Notice
+
 This package is still under active development. Some methods and features might not be stable yet. We're working diligently to improve and stabilize the package. Any feedback, suggestions, or contributions are highly appreciated!
 
 ## License
 
 This project is licensed under the [MIT License](https://opensource.org/license/mit/)
-

package/lib/converter.d.ts

@@ -0,0 +1,18 @@
+export declare class CronConverterU2Q {
+    static readonly delimiter = " ";
+    static readonly unixExpressionLength = 5;
+    static readonly quartzExpressionLengths: number[];
+    /**
+     * Converts a unix cron expression to a quartz cron expression by adding '0' seconds
+     * @param unixExpression - the unix expression
+     * @returns the corresponding quartz expression
+     */
+    static unixToQuartz(unixExpression: string): string;
+    /**
+     * Converts a quartz cron expression to a unix cron expression
+     * @param quartzExpression - the quartz expression
+     * @returns the corresponding unix expression
+     */
+    static quartzToUnix(quartzExpression: string): string;
+    private static validateIfNullOrEmpty;
+}

package/lib/converter.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronConverterU2Q = void 0;
+class CronConverterU2Q {
+    /**
+     * Converts a unix cron expression to a quartz cron expression by adding '0' seconds
+     * @param unixExpression - the unix expression
+     * @returns the corresponding quartz expression
+     */
+    static unixToQuartz(unixExpression) {
+        this.validateIfNullOrEmpty(unixExpression);
+        const parts = unixExpression.split(this.delimiter);
+        if (parts.length !== this.unixExpressionLength)
+            throw new Error(`Invalid unix cron format`);
+        const [min, hour, dom, month, dow] = parts;
+        let quartzDom = dom;
+        let quartzDow = dow;
+        if (dom === '*' && (dow === '*' || dow !== '*'))
+            quartzDom = '?';
+        else if (dom !== '*' && dow === '*')
+            quartzDow = '?';
+        return `0 ${min} ${hour} ${quartzDom} ${month} ${quartzDow}`;
+    }
+    /**
+     * Converts a quartz cron expression to a unix cron expression
+     * @param quartzExpression - the quartz expression
+     * @returns the corresponding unix expression
+     */
+    static quartzToUnix(quartzExpression) {
+        this.validateIfNullOrEmpty(quartzExpression);
+        const parts = quartzExpression.split(this.delimiter);
+        if (!this.quartzExpressionLengths.includes(parts.length))
+            throw new Error(`Invalid quartz cron format`);
+        const [_, min, hour, dom, month, dow] = parts;
+        let unixDom = dom;
+        let unixDow = dow;
+        if (dom === '?' && dow === '*')
+            unixDom = '*';
+        else if (dow === '?' && dom === '*')
+            unixDow = '*';
+        else if (dom !== '?' && dom === '?')
+            unixDom = '*';
+        return `${min} ${hour} ${unixDom} ${month} ${unixDow}`;
+    }
+    static validateIfNullOrEmpty(cronExpression) {
+        if (!cronExpression || cronExpression.trim() === '')
+            throw new Error('Empty or null expression');
+    }
+}
+exports.CronConverterU2Q = CronConverterU2Q;
+CronConverterU2Q.delimiter = ' ';
+CronConverterU2Q.unixExpressionLength = 5;
+CronConverterU2Q.quartzExpressionLengths = [6, 7];

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './converter';

package/lib/index.js

@@ -1,57 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CronConverterU2Q = void 0;
-class CronConverterU2Q {
-    constructor() {
-        this.delimiter = ' ';
-        this.unixExpressionLength = 5;
-        this.quartzExpressionLengths = [6, 7];
-    }
-    /**
-     * Converts a unix cron expression to a quartz cron expression by adding '0' seconds
-     * @param unixExpression - the unix expression
-     * @returns the corresponding quartz expression
-     */
-    unixToQuartz(unixExpression) {
-        this.validateIfNullOrEmpty(unixExpression);
-        const parts = unixExpression.split(this.delimiter);
-        if (parts.length !== this.unixExpressionLength)
-            throw new Error(`Invalid unix cron format`);
-        const [min, hour, dom, month, dow] = parts;
-        let quartzDom = dom;
-        let quartzDow = dow;
-        if (dom === '*' && (dow === '*' || dow !== '*'))
-            quartzDom = '?';
-        else if (dom !== '*' && dow === '*')
-            quartzDow = '?';
-        return `0 ${min} ${hour} ${quartzDom} ${month} ${quartzDow}`;
-    }
-    /**
-     * Converts a quartz cron expression to a unix cron expression
-     * @param quartzExpression - the quartz expression
-     * @returns the corresponding unix expression
-     */
-    quartzToUnix(quartzExpression) {
-        this.validateIfNullOrEmpty(quartzExpression);
-        const parts = quartzExpression.split(this.delimiter);
-        if (!this.quartzExpressionLengths.includes(parts.length))
-            throw new Error(`Invalid quartz cron format`);
-        const [_, min, hour, dom, month, dow] = parts;
-        let unixDom = dom;
-        let unixDow = dow;
-        if (dom === '?' && dow === '*')
-            unixDom = '*';
-        else if (dow === '?' && dom === '*')
-            unixDow = '*';
-        else if (dom !== '?' && dom === '?')
-            unixDom = '*';
-        return `${min} ${hour} ${unixDom} ${month} ${unixDow}`;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    validateIfNullOrEmpty(cronExpression) {
-        if (!cronExpression || cronExpression.trim() === '')
-            throw new Error('Empty or null expression');
-    }
-}
-exports.CronConverterU2Q = CronConverterU2Q;
-// if (process.env.NODE_ENV === 'development') {
-// }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./converter"), exports);

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "cron-converter-u2q",
-  "version": "0.1.3",
+  "version": "0.1.9",
   "description": "Converts cron expressions between unix and quartz formats",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "jest --no-watchman --coverage"
+    "test": "jest --no-watchman --coverage",
+    "lint": "npx eslint src/**/*.ts --fix"
   },
   "author": "BitBundler <rahu619@gmail.com>",
   "keywords": [
@@ -21,6 +22,9 @@
     "@types/jest": "^29.5.3",
     "@types/mocha": "^10.0.1",
     "@types/node": "^20.4.9",
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
+    "@typescript-eslint/parser": "^6.3.0",
+    "eslint": "^8.46.0",
     "jest": "^29.6.2",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",

package/src/converter.ts

@@ -0,0 +1,57 @@
+export class CronConverterU2Q {
+
+    static readonly delimiter = ' ';
+    static readonly unixExpressionLength = 5;
+    static readonly quartzExpressionLengths = [6, 7];
+
+    /**
+     * Converts a unix cron expression to a quartz cron expression by adding '0' seconds
+     * @param unixExpression - the unix expression
+     * @returns the corresponding quartz expression
+     */
+    public static unixToQuartz(unixExpression: string): string {
+
+        this.validateIfNullOrEmpty(unixExpression);
+
+        const parts = unixExpression.split(this.delimiter);
+        if (parts.length !== this.unixExpressionLength) throw new Error(`Invalid unix cron format`);
+
+        const [min, hour, dom, month, dow] = parts;
+        let quartzDom = dom;
+        let quartzDow = dow;
+
+        if (dom === '*' && (dow === '*' || dow !== '*')) quartzDom = '?';
+        else if (dom !== '*' && dow === '*') quartzDow = '?';
+
+        return `0 ${min} ${hour} ${quartzDom} ${month} ${quartzDow}`;
+    }
+
+    /**
+     * Converts a quartz cron expression to a unix cron expression
+     * @param quartzExpression - the quartz expression
+     * @returns the corresponding unix expression
+     */
+    public static quartzToUnix(quartzExpression: string): string {
+
+        this.validateIfNullOrEmpty(quartzExpression);
+
+        const parts = quartzExpression.split(this.delimiter);
+
+        if (!this.quartzExpressionLengths.includes(parts.length)) throw new Error(`Invalid quartz cron format`);
+
+        const [_, min, hour, dom, month, dow] = parts;
+        let unixDom = dom;
+        let unixDow = dow;
+
+        if (dom === '?' && dow === '*') unixDom = '*';
+        else if (dow === '?' && dom === '*') unixDow = '*';
+        else if (dom !== '?' && dom === '?') unixDom = '*';
+
+        return `${min} ${hour} ${unixDom} ${month} ${unixDow}`;
+    }
+
+    private static validateIfNullOrEmpty(cronExpression: string | undefined | null): void {
+        if (!cronExpression || cronExpression.trim() === '') throw new Error('Empty or null expression');
+    }
+
+}

package/src/index.ts

@@ -1,64 +1,3 @@
-export class CronConverterU2Q {
+export * from './converter';
 
-    static readonly delimiter = ' ';
-    static readonly unixExpressionLength = 5;
-    static readonly quartzExpressionLengths = [6, 7];
-
-    /**
-     * Converts a unix cron expression to a quartz cron expression by adding '0' seconds
-     * @param unixExpression - the unix expression
-     * @returns the corresponding quartz expression
-     */
-    public static unixToQuartz(unixExpression: string): string {
-
-        this.validateIfNullOrEmpty(unixExpression);
-
-        const parts = unixExpression.split(this.delimiter);
-        if (parts.length !== this.unixExpressionLength) throw new Error(`Invalid unix cron format`);
-
-        const [min, hour, dom, month, dow] = parts;
-        let quartzDom = dom;
-        let quartzDow = dow;
-
-        if (dom === '*' && (dow === '*' || dow !== '*')) quartzDom = '?';
-        else if (dom !== '*' && dow === '*') quartzDow = '?';
-
-        return `0 ${min} ${hour} ${quartzDom} ${month} ${quartzDow}`;
-    }
-
-    /**
-     * Converts a quartz cron expression to a unix cron expression
-     * @param quartzExpression - the quartz expression
-     * @returns the corresponding unix expression
-     */
-    public static quartzToUnix(quartzExpression: string): string {
-
-        this.validateIfNullOrEmpty(quartzExpression);
-
-        const parts = quartzExpression.split(this.delimiter);
-
-        if (!this.quartzExpressionLengths.includes(parts.length)) throw new Error(`Invalid quartz cron format`);
-
-        const [_, min, hour, dom, month, dow] = parts;
-        let unixDom = dom;
-        let unixDow = dow;
-
-        if (dom === '?' && dow === '*') unixDom = '*';
-        else if (dow === '?' && dom === '*') unixDow = '*';
-        else if (dom !== '?' && dom === '?') unixDom = '*';
-
-        return `${min} ${hour} ${unixDom} ${month} ${unixDow}`;
-    }
-
-    private static validateIfNullOrEmpty(cronExpression: string | undefined | null): void {
-        if (!cronExpression || cronExpression.trim() === '') throw new Error('Empty or null expression');
-    }
-
-}
-
-export const CronConverterU2QModule = CronConverterU2Q;
-
-
-// if (process.env.NODE_ENV === 'development') {
-// }
 

package/tsconfig.json

@@ -5,6 +5,7 @@
     "module": "commonjs" /* Specify what module code is generated. */,
     "outDir": "./lib" /* Specify an output folder for all emitted files. */,
     "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    "declaration": true,
     // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
     "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,