Merge pull request #42 from ilovepixelart/feature/esm-support

ESM support

.eslintrc

@@ -25,7 +25,10 @@
     "sourceType": "module"
   },
   "rules": {
-    "comma-dangle": ["error", "never"],
+    "comma-dangle": [
+      "error",
+      "never"
+    ],
     "@typescript-eslint/array-type": "error",
     "@typescript-eslint/consistent-type-imports": "error",
     "@typescript-eslint/method-signature-style": "error",
@@ -86,6 +89,19 @@
         "plugin:@typescript-eslint/stylistic-type-checked"
       ],
       "rules": {
+        "@typescript-eslint/member-delimiter-style": [
+          "error",
+          {
+            "multiline": {
+              "delimiter": "none",
+              "requireLast": true
+            },
+            "singleline": {
+              "delimiter": "comma",
+              "requireLast": false
+            }
+          }
+        ],
         "@typescript-eslint/consistent-type-exports": "error",
         "@typescript-eslint/explicit-function-return-type": "error",
         "@typescript-eslint/explicit-module-boundary-types": "error",

.gitignore

@@ -1,3 +1,7 @@
+# System files
+.DS_Store
+Thumbs.db
+
 # Dependency directory
 node_modules
 dist

.vscode/settings.json

@@ -32,6 +32,7 @@
     "npmignore",
     "parens",
     "rhysd",
+    "singleline",
     "sonarcloud",
     "sonarjs",
     "sonarsource",

README.md

@@ -15,11 +15,30 @@ Lightweight rule engine, written in typescript
 
 [![npm](https://nodei.co/npm/ts-rule-engine.png)](https://www.npmjs.com/package/ts-rule-engine)
 
+## Supports and tested with
+
+```json
+{
+  "node": "16.x || 18.x || 20.x",
+}
+```
+
+## Features
+
+- [x] Structure for rule definition
+- [x] Rerun rules after fact is updated
+- [x] Stop rule engine on any rule from executing further
+- [x] Infinite loop prevention with max iterations limit
+- [x] One time rule execution in sequence
+- [x] Rule weight for priority
+- [x] Supports ESM and CommonJS
+
 ## Installation
 
 ```bash
 npm install ts-rule-engine
 yarn add ts-rule-engine
+pnpm add ts-rule-engine
 ```
 
 ### 1. Defining a Rule

bash/esm.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# Define the directory to start the search
+root_directory="dist/esm"
+
+echo "Adding .js extension to relative imports in files:"
+# Find all JavaScript files and iterate through them and add the .js extension to relative imports
+find "$root_directory" -type f -name "*.js" | while read -r file; do
+    if awk '!/export {};|\/\/# sourceMappingURL:|^[[:space:]]*\/\//' "$file" | grep -q "import .* from '[.]\{0,2\}\/[^']*'"; then
+        sed -i.bak -E "s/(import .* from '[.]{0,2}\/[^']*)'/\1.js'/g" "$file" && echo "- $file"
+    fi
+done
+
+# Remove all backup files
+find "$root_directory" -type f -name "*.bak" -exec rm {} +
+
+echo -e "\nCreating package.json file in $root_directory"
+# Create a package.json file to indicate that this is an ESM package
+echo '{ "type": "module" }' > "$root_directory/package.json"

config/tsconfig.cjs.json

@@ -4,7 +4,6 @@
     "rootDir": "../src",
     "outDir": "../dist/cjs",
     "declarationDir": "../dist/cjs/types",
-    "module": "commonjs",
-    "moduleResolution": "node",
+    "module": "CommonJS"
   }
 }

config/tsconfig.esm.json

@@ -4,7 +4,6 @@
     "rootDir": "../src",
     "outDir": "../dist/esm",
     "declarationDir": "../dist/esm/types",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
+    "module": "ESNext"
   }
 }