Merge pull request #3 from oyve/dev

Support commonjs and ESM

Author: oyve

README.md

@@ -80,9 +80,8 @@ If you are using a CommonJS project, you can dynamically import the package:
 ```javascript
 (async () => {
   const weatherFormulas = await import('weather-formulas');
-  const { temperature } = weatherFormulas;
-  const RH = temperature.relativeHumidity(TEMPERATURE, DEW_POINT);
-  console.log(`Relative Humidity: ${RH}%`);
+  const { humidity } = weatherFormulas;
+  const RH = humidity.relativeHumidity(TEMPERATURE, DEW_POINT);
 })();
 ```
 

add-js-extensions.cjs

@@ -0,0 +1,34 @@
+const fs = require("fs");
+const path = require("path");
+
+const esmDir = path.join(__dirname, "dist/esm");
+
+function addJsExtensions(dir) {
+    const files = fs.readdirSync(dir);
+    for (const file of files) {
+        const fullPath = path.join(dir, file);
+
+        // If it's a directory, recursively process it
+        if (fs.statSync(fullPath).isDirectory()) {
+            addJsExtensions(fullPath);
+        } 
+        // If it's a .js file, process its content
+        else if (file.endsWith(".js")) {
+            let content = fs.readFileSync(fullPath, "utf8");
+
+            // Replace import/export paths without .js extensions
+            content = content.replace(/from\s+['"](\..*?[^.])['"]/g, (match, p1) => {
+                if (!p1.endsWith(".js")) {
+                    return `from '${p1}.js'`;
+                }
+                return match;
+            });
+
+            // Write the updated content back to the file
+            fs.writeFileSync(fullPath, content, "utf8");
+        }
+    }
+}
+
+// Run the script on the esm directory
+addJsExtensions(esmDir);

package.json

@@ -1,20 +1,27 @@
 {
   "name": "weather-formulas",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A collection of atmospheric, meteorological weather calculations",
   "type": "module",
-  "main": "dist/index.js",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.cjs",
+      "import": "./dist/esm/index.js"
+    }
+  },
   "files": [
     "dist",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "build": "tsc",
-    "watch": "tsc --watch",
-    "test": "jest"
-  },
+  "build": "tsc && tsc --project tsconfig.cjs.json && node rename-cjs-files.cjs && node add-js-extensions.cjs",
+  "watch": "tsc --watch",
+  "test": "jest"
+},
   "repository": {
     "type": "git",
     "url": "git+https://github.com/oyve/weather-formulas.git"
@@ -23,23 +30,24 @@
     "weather",
     "atmospheric",
     "calculations",
-    "calculation",
     "temperature",
     "dew point",
     "wind chill",
-    "australian apparent temperature",
     "heat index",
     "humidex",
     "relative humidity",
     "specific humidity",
-    "mixing ratio",
     "vapor pressure",
     "potential temperature",
     "virtual temperature",
     "pressure altitude",
     "density altitude",
-    "saturation vapor pressure",
-    "adjust pressure to sea level"
+    "barometric formula",
+    "adjust pressure to sea level",
+    "lapse rate",
+    "dynamic lapse rate",
+    "temperature inversion",
+    "weighted average temperature"
   ],
   "author": "Øyvind Hansen <oyve-github@outlook.com>",
   "license": "GPL-3.0-or-later",

rename-cjs-files.cjs

@@ -0,0 +1,34 @@
+const fs = require("fs");
+const path = require("path");
+
+const cjsDir = path.join(__dirname, "dist/cjs");
+
+function renameJsToCjs(dir) {
+    const files = fs.readdirSync(dir);
+    for (const file of files) {
+        const fullPath = path.join(dir, file);
+
+        // If it's a directory, recursively process it
+        if (fs.statSync(fullPath).isDirectory()) {
+            renameJsToCjs(fullPath);
+        } 
+        // If it's a .js file, rename it to .cjs
+        else if (file.endsWith(".js")) {
+            const newFullPath = fullPath.replace(/\.js$/, ".cjs");
+            fs.renameSync(fullPath, newFullPath);
+
+            // Update require statements in the renamed file
+            let content = fs.readFileSync(newFullPath, "utf8");
+            content = content.replace(/require\(['"](\..*?)['"]\)/g, (match, p1) => {
+                if (!p1.endsWith(".cjs")) {
+                    return `require('${p1}.cjs')`;
+                }
+                return match;
+            });
+            fs.writeFileSync(newFullPath, content, "utf8");
+        }
+    }
+}
+
+// Run the script on the cjs directory
+renameJsToCjs(cjsDir);

src/formulas/humidity.ts

@@ -1,4 +1,4 @@
-import c from '../../src/constants';
+import c from '../constants';
 
 /**
  * Calculate Relative Humidity

tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+      "module": "CommonJS",
+      "outDir": "./dist/cjs"
+    }
+}

tsconfig.json

@@ -11,7 +11,7 @@
     // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
 
     /* Language and Environment */
-    "target": "ESNext",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "target": "ES2020",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
     // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
     // "jsx": "preserve",                                /* Specify what JSX code is generated. */
     // "libReplacement": true,                           /* Enable lib replacement. */
@@ -26,9 +26,9 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
 
     /* Modules */
-    "module": "CommonJS",                                /* Specify what module code is generated. */
-    "rootDir": "src",                                    /* Specify the root folder within your source files. */
-     "moduleResolution": "node",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    "module": "ESNext",                                  /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Ensure the directory structure is preserved. */
+    "moduleResolution": "node",                         /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     //"rootDirs": ["./src"],                                   /* Allow multiple folders to be treated as one when resolving modules. */
@@ -54,12 +54,12 @@
     /* Emit */
     "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    "emitDeclarationOnly": false,                        /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "dist",                                  /* Specify an output folder for all emitted files. */
+    "outDir": "./dist/esm",                              /* Specify an output folder for all emitted files. */
     // "removeComments": true,                           /* Disable emitting comments. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
     // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
@@ -72,7 +72,7 @@
     // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
     // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
     // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-     "declarationDir": "dist/types",                   /* Specify the output directory for generated declaration files. */
+    "declarationDir": "./dist/types",                    /* Specify the output directory for generated declaration files. */
 
     /* Interop Constraints */
     // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
@@ -108,10 +108,8 @@
 
     /* Completeness */
     //"skipDefaultLibCheck": true,                         /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+    "skipLibCheck": true                                  /* Skip type checking all .d.ts files. */
   },
-  "exclude": [
-    "**/*.test.ts",
-    "./dist/**/*"
-  ]
+  "include": ["src/**/*"], // Include all files in the src directory
+  "exclude": ["node_modules", "dist"] // Exclude unnecessary files
 }