typescript-parser - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "typescript-parser",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Parser for typescript (and javascript) files, that compiles those files and generates a human understandable AST.",
@@ -46,5 +46,6 @@ "main": "index.js",
   "dependencies": {
+    "coveralls": "^2.13.1",
     "tslib": "^1.7.1",
     "typescript": "^2.4.1"
   }
-}
+}

README.md

 # node typescript parser
 
+This package is a TypeScript and ECMAScript parser. It uses the underlying typescript parser to generate
+a more or less human readable AST out of .js or .ts files.
+
+[![Build Status](https://travis-ci.org/TypeScript-Heroes/node-typescript-parser.svg)](https://travis-ci.org/TypeScript-Heroes/node-typescript-parser)
+[![npm](https://img.shields.io/npm/v/typescript-parser.svg?maxAge=3600)](https://www.npmjs.com/package/typescript-parser)
+[![Coverage status](https://img.shields.io/coveralls/TypeScript-Heroes/node-typescript-parser.svg?maxAge=3600)](https://coveralls.io/github/TypeScript-Heroes/node-typescript-parser)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+
 ## How to use
+
+After you install the package via:
+
+[![NPM](https://nodei.co/npm/typescript-parser.png?downloads=true&stars=true)](https://nodei.co/npm/typescript-parser/)
+
+You can use the parser with:
+
+```typescript
+const parser = new TypescriptParser();
+
+// either:
+const parsed = await parser.parseSource(/* typescript source code as string */);
+
+// or a filepath
+const parsed = await parser.parseSource('/user/myfile.ts', 'workspace root');
+```
+
+You can also parse multiple files at ones.
+
+To use the declaration index (which is basically a list of symbols for your files)
+instantiate an index first and throw him some files.
+
+After the parsing is done, you'll get an index with resolved
+exports and declarations.
+
+Keep in mind, that the index'll only contain exported declarations.
+
+## Changelog
+
+The changelog is generated by [semantic release](https://github.com/semantic-release/semantic-release) and is located under the 
+[release section](https://github.com/TypeScript-Heroes/node-typescript-parser/releases).
+
+## Licence
+
+This software is licenced under the [MIT](LICENSE) licence.

New alerts

Filesystem access

Supply chain risk

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

Found 1 instance in 1 package

Fixed alerts

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

Improved metrics

Total package byte prevSize

249746

increased by138.23%

Number of package files

208

increased by181.08%

Lines of code

7051

increased by142.72%

Number of lines in readme file

47

increased by1075%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dependency count

3

increased by50%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedcoveralls@^2.13.1

• + Addedansi-regex@2.1.1(transitive)

• + Addedansi-styles@2.2.1(transitive)

• + Addedargparse@1.0.10(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@0.2.01.0.0(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.6.0(transitive)

• + Addedaws4@1.13.2(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedboom@2.10.1(transitive)

• + Addedcaseless@0.11.0(transitive)

• + Addedchalk@1.1.3(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedcommander@2.20.3(transitive)

• + Addedcore-util-is@1.0.2(transitive)

• + Addedcoveralls@2.13.3(transitive)

• + Addedcryptiles@2.0.5(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedesprima@2.7.3(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.1.4(transitive)

• + Addedgenerate-function@2.3.1(transitive)

• + Addedgenerate-object-property@1.2.0(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedhar-validator@2.0.6(transitive)

• + Addedhas-ansi@2.0.0(transitive)

• + Addedhawk@3.1.3(transitive)

• + Addedhoek@2.16.3(transitive)

• + Addedhttp-signature@1.1.1(transitive)

• + Addedis-my-ip-valid@1.0.1(transitive)

• + Addedis-my-json-valid@2.20.6(transitive)

• + Addedis-property@1.0.2(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjs-yaml@3.6.1(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsonpointer@5.0.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedlcov-parse@0.0.10(transitive)

• + Addedlog-driver@1.2.5(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedminimist@1.2.0(transitive)

• + Addedoauth-sign@0.8.2(transitive)

• + Addedpinkie@2.0.4(transitive)

• + Addedpinkie-promise@2.0.1(transitive)

• + Addedpunycode@1.4.1(transitive)

• + Addedqs@6.3.3(transitive)

• + Addedrequest@2.79.0(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsntp@1.0.9(transitive)

• + Addedsprintf-js@1.0.3(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedstringstream@0.0.6(transitive)

• + Addedstrip-ansi@3.0.1(transitive)

• + Addedsupports-color@2.0.0(transitive)

• + Addedtough-cookie@2.3.4(transitive)

• + Addedtunnel-agent@0.4.3(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)

• + Addedxtend@4.0.2(transitive)