tsd-jsdoc - npm Package Compare versions

Comparing version 2.0.0-beta.1 to 2.0.0-beta.2

package.json

 {
   "name": "tsd-jsdoc",
-  "version": "v2.0.0-beta.1",
+  "version": "v2.0.0-beta.2",
   "description": "Compiles JSDoc annotated javascript into a Typescript Declaration File (.d.ts).",
@@ -13,8 +13,13 @@ "main": "lib/publish.js",
   "scripts": {
+    "clean": "rm -rf *.js *.js.map",
     "lint": "eslint --rulesdir node_modules/@englercj/code-style *.js",
-    "build": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json && mv src/*.js . && mv src/*.js.map .",
+    "prepublish": "npm run build",
     "test": "jsdoc -c test/config.json -d out"
   },
   "files":[
-    "lib"
+    "*.js",
+    "*.js.map",
+    "README.md",
+    "LICENSE"
   ],
@@ -21,0 +26,0 @@ "devDependencies": {

README.md

@@ -43,6 +43,6 @@ # jsdoc2tsd
 
-This library provides almost no validation beyond what jsdoc provides. Meaning if you
+This library provides very little validation beyond what jsdoc provides. Meaning if you
 have invalid jsodc comments, this will likely output an invalid TypeScript Definition File.
 
-Additionally there are things that jsdoc things are fine, that TypeScript does not.
+Additionally there are things that jsdoc allows, that TypeScript does not.
 One example would be a member variable marked with `@constant`. While that is valid
@@ -93,3 +93,4 @@ jsdoc, it is not valid TS:
 Any method or member that has the same name as one in the parent of a child class
-will be ignored.
+will be ignored in the Child class, unless it is a method with different parameters
+that *is not* marked with the `@override` tag.
 
@@ -111,2 +112,10 @@ For example, this JavaScript:
     }
+
+    /**
+     */
+    amethod() {}
+
+    /**
+     */
+    bmethod() {}
 }
@@ -127,2 +136,13 @@
     }
+
+    /**
+     * @override
+     * @param {object} opt - Does stuff.
+     */
+    amethod(opt) {}
+
+    /**
+     * @param {object} opt - Does stuff.
+     */
+    bmethod(opt) {}
 }
@@ -136,5 +156,8 @@ ```
     someprop: boolean;
+
+    amethod(): void;
 }
 
 class Child extends Parent {
+    bmethod(opt): void;
 }
@@ -150,3 +173,3 @@ ```
 - [`@event`](http://usejsdoc.org/tags-event.html) - No TS equivalent
-- [`@exports`](http://usejsdoc.org/tags-exports.html) - **Not Yet Implemented**
+- [`@exports`](http://usejsdoc.org/tags-exports.html) - Everything is exported since it is a definition file.
 - [`@external`](http://usejsdoc.org/tags-external.html) - **Not Yet Implemented**
@@ -156,4 +179,3 @@ - [`@fires`](http://usejsdoc.org/tags-fires.html) - No TS equivalent
 - [`@override`](http://usejsdoc.org/tags-override.html) - No TS equivalent ([issue](https://github.com/Microsoft/TypeScript/issues/2000))
-- [`@readonly`](http://usejsdoc.org/tags-readonly.html) - No TS equivalent in v1 ([implemented in v2](https://github.com/Microsoft/TypeScript/issues/229))
-- [`@this`](http://usejsdoc.org/tags-this.html) - No TS equivalent in v1 ([implemented in v2](https://github.com/Microsoft/TypeScript/issues/12))
+- [`@this`](http://usejsdoc.org/tags-this.html) - **Not Yet Implemented**
 - [`@throws`](http://usejsdoc.org/tags-throws.html) - No TS equivalent
@@ -179,3 +201,3 @@
 
-All other tags *should* work...
+All other jsdoc tags should work fine.
 
@@ -182,0 +204,0 @@ ## Supported ClosureCompiler Tags

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

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

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

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52031

increased by0.48%

Number of lines in readme file

202

increased by12.22%

No dependency changes