marilena - npm Package Compare versions

Comparing version 1.0.8 to 1.0.9

dist/create-example.js

@@ -56,7 +56,7 @@ "use strict";
   I created a basic working example for you :). Check "marilena.config.mjs" file and "example folder.
-  Now you can setup you script like:
+  Now you can setup you script like this and run start command:
   "scripts": {
-    "run-example": "marilena --server"
+    "start": "marilena --server"
   }
   `
 );

package.json

 {
   "name": "marilena",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "a tool to build emails with cool tools like mjml and different template engine like handlebars or eta.js",
@@ -21,7 +21,6 @@ "scripts": {
     "prepare": "husky install",
-    "release": "release-it",
+    "release": "dotenv release-it",
     "generate-types": "tsc --declaration --declarationDir ./dist --outDir temp ./src/types.ts && rm -rf temp",
     "prettier:check": "npx prettier --check .",
-    "prettier:fix": "npx prettier --write .",
-    "postinstall": "node dist/create-example.js"
+    "prettier:fix": "npx prettier --write ."
   },
@@ -49,3 +48,3 @@ "types": "dist/types.d.ts",
   ],
-  "author": "diego tonini <[e-mail]>",
+  "author": "Diego Tonini <[e-mail]>",
   "license": "ISC",
@@ -70,3 +69,3 @@ "dependencies": {
     "@jest/globals": "^29.5.0",
-    "@release-it/keep-a-changelog": "^3.1.0",
+    "@release-it/keep-a-changelog": "^4.0.0",
     "@types/js-yaml": "^4.0.5",
@@ -77,2 +76,3 @@ "@types/minimist": "^1.2.2",
     "cypress": "^12.16.0",
+    "dotenv-cli": "^7.2.1",
     "esbuild": "0.18.11",
@@ -85,3 +85,3 @@ "handlebars": "^4.7.7",
     "prettier": "^3.0.0",
-    "release-it": "^15.10.1",
+    "release-it": "^16.1.0",
     "rimraf": "^5.0.1",
@@ -93,3 +93,3 @@ "start-server-and-test": "^2.0.0",
   "engines": {
-    "node": ">=18"
+    "node": ">=16"
   },
@@ -104,5 +104,10 @@ "lint-staged": {
     "npm": {
-      "publish": false
+      "publish": true
+    },
+    "hooks": {
+      "before:init": [
+        "npm run build"
+      ]
     }
   }
 }

README.md

@@ -7,3 +7,3 @@ # Intro
 
-### Install (require node >=18)
+### Install (require node >=16)
 
@@ -22,2 +22,3 @@ ```sh
   "build": "marilena --build",
+  "example": "marilena --create-example", // if you run this script, it generate a basic working example, and then you can run start
   ...other
@@ -109,3 +110,3 @@ },
 | name | required | description | default |
-|--------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
+| ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
 | inputFolder | X | folder where email are in the project. Path is relative to `marilena.config.mjs` | input |
@@ -115,4 +116,4 @@ | outputFolder | X | folder used for generated email (when run build command). Path is relative to `marilena.config.mjs` | output |
 | templateOptions | | if you chose to use one of supported engines, this part is mandatory to setup custom partial and other settings for the template engine selected. Read below for some use cases | empty |
-| mjmlParsingOptions | | options passed to mjml render. See: [mjml options](https://www.npmjs.com/package/mjml)
-| textVersion | | function of type `(emailName: string, locale: string) => string`. If set, this function allow to generate text version of email stripping all html. The function must return file name `es: ${emailName}-${locale}-text-version.txt`
+| mjmlParsingOptions | | options passed to mjml render. See: [mjml options](https://www.npmjs.com/package/mjml) |
+| textVersion | | function of type `(emailName: string, locale: string) => string`. If set, this function allow to generate text version of email stripping all html. The function must return file name `es: ${emailName}-${locale}-text-version.txt` |
 
@@ -119,0 +120,0 @@ ## About templateOptions

Fixed alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

68049

increased by0.4%

Number of lines in readme file

178

increased by0.56%

Number of high supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

20

increased by5.26%

No dependency changes