edge.js - npm Package Compare versions

Comparing version 1.1.4 to 2.0.0

package.json

 {
   "name": "edge.js",
-  "version": "1.1.4",
-  "description": "Node.js logical templating engine with fresh air",
-  "main": "index.js",
+  "version": "2.0.0",
+  "description": "Template engine",
+  "main": "build/index.js",
+  "files": [
+    "build/src",
+    "build/index.d.ts",
+    "build/index.js"
+  ],
   "scripts": {
-    "lint": "standard",
     "pretest": "npm run lint",
-    "posttest": "npm run coverage",
-    "test:local": "FORCE_COLOR=true node bin/index.js --local",
-    "test": "./node_modules/.bin/nyc npm run test:local",
-    "test:win": "set FORCE_COLOR=true && node bin/index.js --win",
-    "coverage": "nyc report --reporter=text-lcov | coveralls"
+    "test": "node japaFile.js",
+    "mrm": "mrm --preset=@adonisjs/mrm-preset",
+    "commit": "git-cz",
+    "test:win": "./node_modules/japa-cli/index.js",
+    "clean": "del build",
+    "compile": "npm run lint && npm run clean && tsc",
+    "build": "npm run compile",
+    "lint": "tslint --project tsconfig.json",
+    "release": "np",
+    "version": "npm run build"
   },
-  "author": "amanvirk,adonisjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/poppinss/edge.git"
+  },
+  "author": "virk",
   "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/poppinss/edge/issues"
+  },
+  "homepage": "https://github.com/poppinss/edge#readme",
   "devDependencies": {
-    "benchmark": "^2.1.4",
-    "cheerio": "^1.0.0-rc.2",
-    "coveralls": "^3.0.0",
-    "cz-conventional-changelog": "^2.1.0",
-    "dedent-js": "^1.0.1",
-    "japa": "^1.0.6",
-    "japa-cli": "^1.0.1",
-    "node-req": "^2.1.0",
-    "nunjucks": "^3.0.1",
-    "nyc": "^11.4.1",
-    "semver": "^5.5.0",
-    "standard": "^10.0.3",
-    "zombie": "^5.0.7"
+    "@adonisjs/mrm-preset": "^2.1.0",
+    "@poppinss/dev-utils": "^1.0.1",
+    "@types/node": "^12.7.5",
+    "commitizen": "^4.0.3",
+    "cz-conventional-changelog": "^3.0.2",
+    "dedent": "^0.7.0",
+    "del-cli": "^3.0.0",
+    "doctoc": "^1.4.0",
+    "fs-extra": "^8.1.0",
+    "husky": "^3.0.5",
+    "japa": "^3.0.1",
+    "mrm": "^1.2.2",
+    "np": "^5.1.0",
+    "ts-node": "^8.3.0",
+    "tslint": "^5.20.0",
+    "tslint-eslint-rules": "^5.4.0",
+    "typedoc": "^0.15.0",
+    "typedoc-clarity-theme": "^1.1.0",
+    "typedoc-plugin-external-module-name": "^2.1.0",
+    "typescript": "^3.6.3",
+    "yorkie": "^2.0.0"
   },
-  "dependencies": {
-    "debug": "^3.1.0",
-    "encodeurl": "^1.0.2",
-    "escape-html": "^1.0.3",
-    "esprima": "^4.0.0",
-    "indent-string": "^3.2.0",
-    "lodash": "^4.17.4",
-    "node-exceptions": "^3.0.0",
-    "require-uncached": "^1.0.3",
-    "upcast": "^2.1.1"
-  },
   "config": {
     "commitizen": {
-      "path": "./node_modules/cz-conventional-changelog"
+      "path": "cz-conventional-changelog"
     }
+  },
+  "nyc": {
+    "exclude": [
+      "test"
+    ],
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@poppinss/utils": "^2.0.0",
+    "debug": "^4.1.1",
+    "edge-error": "^1.0.3",
+    "edge-parser": "^2.0.10",
+    "he": "^1.2.0",
+    "import-fresh": "^3.1.0",
+    "lodash": "^4.17.15",
+    "macroable": "^2.0.2",
+    "node-exceptions": "^4.0.1"
+  },
+  "gitHooks": {
+    "commit-msg": "node ./node_modules/@adonisjs/mrm-preset/validateCommit/conventional/validate.js"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "doctoc README.md --title='## Table of contents' && git add README.md",
+      "commit-msg": "node ./node_modules/@adonisjs/mrm-preset/validateCommit/conventional/validate.js"
+    }
+  },
+  "directories": {
+    "example": "examples",
+    "test": "test"
+  },
+  "keywords": [
+    "template",
+    "mustache",
+    "edge"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "np": {
+    "contents": ".",
+    "anyBranch": false
   }
 }

README.md

@@ -1,82 +0,62 @@
-# Edge
-> Templating with some fresh air
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of contents
 
-Edge is a logical templating engine for Node.js. The syntax language is naturally similar to Javascript, making it simpler to write and remember.
+- [Edge](#edge)
+  - [Features](#features)
+  - [Change log](#change-log)
+  - [Contributing](#contributing)
+  - [Authors & License](#authors--license)
 
-<br />
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
+# Edge
+> Template engine for Node.js with a breath of fresh air
 
-[![NPM Version][npm-image]][npm-url]
-[![Build Status][travis-image]][travis-url]
-[![Downloads Stats][npm-downloads]][npm-url]
-[![Appveyor][appveyor-image]][appveyor-url]
+[![travis-image]][travis-url]
+[![appveyor-image]][appveyor-url]
+[![coveralls-image]][coveralls-url]
+[![npm-image]][npm-url]
+![](https://img.shields.io/badge/Uses-Typescript-294E80.svg?style=flat-square&colorA=ddd)
 
-<br />
+Edge is logical template engine for Node.js and has supports for all [Javascript expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators#Expressions).
 
----
-
-<br />
-
 ## Features
 
-1. Beautiful Syntax
-2. Encourages component based layout
-3. Runtime debugging via chrome devtools.
-4. Helpful error messages
-5. Support for Layouts
-6. Extraction markup via Partials.
+- Minimal core, functionality added via `Tags`.
+- Simple developer API to add your own Tags.
+- Support for **layouts**, **partials** and **components**.
+- Support for all valid Javascript expressions.
+- Identical to Javascript.
+- Small learning curve.
 
-The official documentation will soon be published on http://edge.adonisjs.com
+Make sure to read [official docs](https://edge.adonisjs.com)
 
-### Usage
+## Change log
 
-```js
-const edge = require('edge.js')
+The change log can be found in the [CHANGELOG.md](https://github.com/poppinss/edge/CHANGELOG.md) file.
 
-// configure cache
-edge.configure({
-  cache: process.env.NODE_EV === 'production'
-})
+## Contributing
 
-// register views
-edge.registerViews(path.join(__dirname, 'views'))
+Everyone is welcome to contribute. Please go through the following guides, before getting started.
 
-// render view
-edge.render('welcome')
-```
+1. [Contributing](https://adonisjs.com/contributing)
+2. [Code of conduct](https://adonisjs.com/code-of-conduct)
 
-## Running Tests
 
-```bash
-# just the tests
-npm run test:local
+## Authors & License
+[thetutlage](https://github.com/thetutlage) and [contributors](https://github.com/poppinss/edge/graphs/contributors).
 
-# tests + report coverage on coveralls
-npm run test
+MIT License, see the included [MIT](LICENSE.md) file.
 
-# run tests on windows
-npm run test:win
+[travis-image]: https://img.shields.io/travis/poppinss/edge/master.svg?style=flat-square&logo=travis
+[travis-url]: https://travis-ci.org/poppinss/edge "travis"
 
-# tests with local coverage report
-npm run coverage
-```
+[appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/edge/master.svg?style=flat-square&logo=appveyor
+[appveyor-url]: https://ci.appveyor.com/project/thetutlage/edge "appveyor"
 
-## Running Benchmarks
+[coveralls-image]: https://img.shields.io/coveralls/poppinss/edge/master.svg?style=flat-square
+[coveralls-url]: https://coveralls.io/github/poppinss/edge "coveralls"
 
-Make sure to install `nunjucks` before running benchmarks in comparison to nunjucks.
-
-```
-node benchmarks/loop.js
-node benchmarks/conditionals.js
-```
-
-[appveyor-image]: https://ci.appveyor.com/api/projects/status/github/poppinss/edge?branch=master&svg=true&passingText=Passing%20On%20Windows
-[appveyor-url]: https://ci.appveyor.com/project/thetutlage/edge
-
-[npm-image]: https://img.shields.io/npm/v/edge.js.svg?style=flat-square
-[npm-url]: https://npmjs.org/package/edge.js
-
-[travis-image]: https://img.shields.io/travis/poppinss/edge/master.svg?style=flat-square
-[travis-url]: https://travis-ci.org/poppinss/edge
-
-[npm-downloads]: https://img.shields.io/npm/dm/edge.js.svg?style=flat-square
+[npm-image]: https://img.shields.io/npm/v/edge.svg?style=flat-square&logo=npm
+[npm-url]: https://www.npmjs.com/package/edge.js "npm"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Number of low maintenance alerts

0

decreased by-100%

Number of low quality alerts

0

decreased by-100%

Number of low supply chain risk alerts

1

decreased by-66.67%

Worsened metrics

Total package byte prevSize

53452

decreased by-90.15%

Dev dependency count

21

increased by61.54%

Number of package files

58

decreased by-36.26%

Lines of code

1064

decreased by-81.59%

Number of lines in readme file

63

decreased by-24.1%

Number of medium supply chain risk alerts

4

increased by100%

Dependency changes

• + Added@poppinss/utils@^2.0.0

• + Addededge-error@^1.0.3

• + Addededge-parser@^2.0.10

• + Addedhe@^1.2.0

• + Addedimport-fresh@^3.1.0

• + Addedmacroable@^2.0.2

• + Added@poppinss/utils@2.5.10(transitive)

• + Addedacorn@7.4.1(transitive)

• + Addedastring@1.9.0(transitive)

• + Addedbuffer-alloc@1.2.0(transitive)

• + Addedbuffer-alloc-unsafe@1.1.0(transitive)

• + Addedbuffer-fill@1.0.0(transitive)

• + Addedcallsites@3.1.0(transitive)

• + Addeddebug@4.3.7(transitive)

• + Addededge-error@1.0.5(transitive)

• + Addededge-lexer@2.2.0(transitive)

• + Addededge-parser@2.1.2(transitive)

• + Addedfast-safe-stringify@2.1.1(transitive)

• + Addedfs-readdir-recursive@1.1.0(transitive)

• + Addedhe@1.2.0(transitive)

• + Addedimport-fresh@3.3.0(transitive)

• + Addedklona@2.0.6(transitive)

• + Addedmacroable@2.0.2(transitive)

• + Addednode-exceptions@4.0.1(transitive)

• + Addedparent-module@1.0.1(transitive)

• + Addedrequire-all@3.0.0(transitive)

• + Addedresolve-from@4.0.05.0.0(transitive)

• - Removedencodeurl@^1.0.2

• - Removedescape-html@^1.0.3

• - Removedesprima@^4.0.0

• - Removedindent-string@^3.2.0

• - Removedrequire-uncached@^1.0.3

• - Removedupcast@^2.1.1

• - Removedcaller-path@0.1.0(transitive)

• - Removedcallsites@0.2.0(transitive)

• - Removedcross-env@5.2.1(transitive)

• - Removedcross-spawn@6.0.5(transitive)

• - Removeddebug@3.2.7(transitive)

• - Removedencodeurl@1.0.2(transitive)

• - Removedescape-html@1.0.3(transitive)

• - Removedesprima@4.0.1(transitive)

• - Removedindent-string@3.2.0(transitive)

• - Removedisexe@2.0.0(transitive)

• - Removednice-try@1.0.5(transitive)

• - Removednode-exceptions@3.0.0(transitive)

• - Removedpath-key@2.0.1(transitive)

• - Removedrequire-uncached@1.0.3(transitive)

• - Removedresolve-from@1.0.1(transitive)

• - Removedsemver@5.7.2(transitive)

• - Removedshebang-command@1.2.0(transitive)

• - Removedshebang-regex@1.0.0(transitive)

• - Removedupcast@2.1.2(transitive)

• - Removedwhich@1.3.1(transitive)

• Updateddebug@^4.1.1

• Updatedlodash@^4.17.15

• Updatednode-exceptions@^4.0.1