redweb 0.0.1 → 0.0.3

package/index.js

@@ -5,19 +5,19 @@ const path = require('path');
 const DEFAULT_OPTIONS = {
     port: 80,
     bind: '0.0.0.0',
-    public: ['./public'],
+    publicPaths: ['./public'],
     services: [],
     listenCallback: undefined
 }
 
 /**
- * To get started with WebExpress, simply initialize your WebExpress instance:
+ * To get started with RedWeb, simply initialize your RedWeb instance:
  * ```javascript
- *  const app = new WebExpress();
+ *  const app = new RedWeb();
  * ```
  * You can also configure it according to your needs:
  * ```javascript
- *  const app = new WebExpress({
+ *  const app = new RedWeb({
  *      port: 3000,
  *      public: [
  *          './pages/my_public_html',
@@ -28,12 +28,15 @@ const DEFAULT_OPTIONS = {
  * ```
  * 
  * @param {{port: Number, bind: String, public: Array<String>, services: []}} options 
- * @return WebExpress
+ * @return RedWeb
  */
-export function WebExpress(options = DEFAULT_OPTIONS) {
+function RedWeb(options = DEFAULT_OPTIONS) {
     const app = express();
+    const { publicPaths, port, listenCallback, services } = options;
     app.use(bodyParser.json());
-    options.public.forEach((public_path) => app.use(express.static(path.join(__dirname, public_path))));
-    app.listen(options.port, listenCallback ? listenCallback : () => console.log('WebExpress listening on port ' + options.port));
+    publicPaths.forEach((public_path) => app.use(express.static(path.join(__dirname, public_path))));
+    app.listen(port, listenCallback ? listenCallback : () => console.log('RedWeb listening on port ' + options.port));
     return this;
-}
+}
+
+module.exports = { RedWeb }

package/index.test.js

@@ -0,0 +1,14 @@
+const { RedWeb } = require('.');
+
+jest.mock('express', () => {
+    const self = () => ({
+        use: jest.fn(),
+        listen: jest.fn()
+    });
+    self.static = jest.fn();
+    return self;
+})
+
+test('it should create a RedWeb instance', () => {
+    expect(RedWeb()).toBeDefined();
+})

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "redweb",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "A way to quickly set up an express server",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest"
   },
   "keywords": [],
   "author": "",
@@ -13,6 +13,8 @@
     "express": "^4.19.2"
   },
   "devDependencies": {
-    "@types/express": "^4.17.21"
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0"
   }
 }