edge-lexer - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

build/src/Contracts/index.d.ts

@@ -29,3 +29,3 @@ export declare enum MustacheTypes {
 };
-export declare type TagDefination = {
+export declare type TagDefinition = {
     block: boolean;
@@ -73,3 +73,3 @@ seekable: boolean;
 export declare type Tags = {
-    [name: string]: TagDefination;
+    [name: string]: TagDefinition;
 };

LICENSE.md

 # The MIT License
 
-Copyright 2019 thetutlage, contributors
+Copyright 2019 Harminder virk, contributors
 
@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

package.json

 {
   "name": "edge-lexer",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "Parses raw markup files to converts them to Edge tokens",
-  "main": "build/src/Tokenizer/index.js",
-  "typings": "build/src/Tokenizer/index.d.ts",
+  "main": "build/index.js",
+  "files": [
+    "build/src",
+    "build/index.d.ts",
+    "build/index.js"
+  ],
   "scripts": {
     "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "nyc node japaFile.js",
-    "build": "npm run compile",
+    "test": "node japaFile.js",
+    "build": "npm run compile && typedoc --theme markdown --excludePrivate --mdHideSources && git add docs",
     "commit": "git-cz",
-    "prepublishOnly": "npm run build",
     "test:win": "node ./node_modules/japa-cli/index.js",
     "clean": "del build",
     "compile": "npm run lint && npm run clean && tsc",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
+    "release": "np",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build",
     "lint": "tslint --project tsconfig.json"
   },
-  "files": [
-    "build/src",
-    "README.md",
-    "LICENSE.md"
-  ],
   "keywords": [
@@ -33,24 +33,25 @@ "edge",
   "devDependencies": {
-    "@adonisjs/mrm-preset": "^1.0.16",
-    "@types/node": "^10.12.18",
+    "@adonisjs/mrm-preset": "^2.0.3",
+    "@types/node": "^12.6.2",
     "benchmark": "^2.1.4",
-    "commitizen": "^3.0.5",
-    "coveralls": "^3.0.2",
+    "commitizen": "^3.1.1",
     "cz-conventional-changelog": "^2.1.0",
     "dedent": "^0.7.0",
-    "del-cli": "^1.1.0",
+    "del-cli": "^2.0.0",
     "doctoc": "^1.4.0",
-    "japa": "^2.0.7",
+    "husky": "^3.0.0",
+    "japa": "^2.0.10",
     "japa-cli": "^1.0.1",
-    "mrm": "^1.2.1",
-    "nyc": "^13.1.0",
-    "pkg-ok": "^2.3.1",
-    "ts-node": "^7.0.1",
-    "tslint": "^5.12.1",
+    "mrm": "^1.2.2",
+    "np": "^5.0.3",
+    "ts-node": "^8.3.0",
+    "tslint": "^5.18.0",
     "tslint-eslint-rules": "^5.4.0",
-    "typescript": "^3.2.2",
-    "yorkie": "^2.0.0"
+    "typedoc": "^0.14.2",
+    "typedoc-plugin-external-module-name": "^2.1.0",
+    "typedoc-plugin-markdown": "^2.0.8",
+    "typescript": "^3.5.3"
   },
   "dependencies": {
-    "edge-error": "^1.0.1"
+    "edge-error": "^1.0.2"
   },
@@ -73,3 +74,13 @@ "config": {
     "pre-commit": "doctoc README.md --title='## Table of contents' && git add README.md"
+  },
+  "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"
+    }
+  },
+  "np": {
+    "contents": ".",
+    "anyBranch": false
   }
 }

README.md

 # Edge lexer
-
 > Generating high level tokens from Edge whitelisted markup
 
-[![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)
+[![circleci-image]][circleci-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]
 
-<br />
-<br />
-
 Edge lexer produces a list of `tokens` by scanning for [Edge whitelisted syntax](https://github.com/edge-js/syntax). 
@@ -44,5 +36,4 @@
 - [Example](#example)
-- [Change log](#change-log)
-- [Contributing](#contributing)
-- [Authors & License](#authors--license)
+- [API Docs](#api-docs)
+- [Maintainers](#maintainers)
 
@@ -105,3 +96,3 @@ <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 | Tag | tag | Tags are used to define logical blocks in the template engine. For example `if tag` or `include tag`. |
-| Escaped Tag | e__tag | Escaped tag, Edge will not evaluate it at rutime. |
+| Escaped Tag | e__tag | Escaped tag, Edge will not evaluate it at runtime. |
 | Mustache | mustache | Javascript expression wrapped in curly braces. `{{ }}`|
@@ -420,30 +411,19 @@ | Safe Mustache | s__mustache | Safe mustache, that doesn't escape the output `{{{ }}}`|
 ```
+## API Docs
+Following are the autogenerated files via Typedoc
 
-## Change log
+* [API](docs/README.md)
 
-The change log can be found in the [CHANGELOG.md](CHANGELOG.md) file.
+## Maintainers
+[Harminder virk](https://github.com/thetutlage)
 
-## Contributing
+[circleci-image]: https://img.shields.io/circleci/project/github/edge-js/lexer/master.svg?style=for-the-badge&logo=circleci
+[circleci-url]: https://circleci.com/gh/edge-js/lexer "circleci"
 
-Everyone is welcome to contribute. Please go through the following guides, before getting started.
+[npm-image]: https://img.shields.io/npm/v/edge-lexer.svg?style=for-the-badge&logo=npm
+[npm-url]: https://npmjs.org/package/edge-lexer "npm"
 
-1. [Contributing](https://adonisjs.com/contributing)
-2. [Code of conduct](https://adonisjs.com/code-of-conduct)
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
 
-
-## Authors & License
-[thetutlage](https://github.com/thetutlage) and [contributors](https://github.com/edge-js/lexer/graphs/contributors).
-
-MIT License, see the included [MIT](LICENSE.md) file.
-
-[travis-image]: https://img.shields.io/travis/edge-js/lexer/master.svg?style=flat-square&logo=travis
-[travis-url]: https://travis-ci.org/edge-js/lexer "travis"
-
-[appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/lexer/master.svg?style=flat-square&logo=appveyor
-[appveyor-url]: https://ci.appveyor.com/project/thetutlage/lexer "appveyor"
-
-[coveralls-image]: https://img.shields.io/coveralls/edge-js/lexer/master.svg?style=flat-square
-[coveralls-url]: https://coveralls.io/github/edge-js/lexer "coveralls"
-
-[npm-image]: https://img.shields.io/npm/v/edge-lexer.svg?style=flat-square&logo=npm
-[npm-url]: https://npmjs.org/package/edge-lexer "npm"
+[license-url]: LICENSE.md
+[license-image]: https://img.shields.io/aur/license/pac.svg?style=for-the-badge

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

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

Improved metrics

Total package byte prevSize

32270

increased by0.2%

Number of package files

16

increased by14.29%

Lines of code

543

increased by1.12%

Worsened metrics

Dev dependency count

20

increased by5.26%

Number of lines in readme file

427

decreased by-4.47%

Dependency changes

• Updatededge-error@^1.0.2