@verdaccio/types - npm Package Compare versions

Comparing version 10.4.2 to 10.5.0

package.json

 {
   "name": "@verdaccio/types",
-  "version": "10.4.2",
+  "version": "10.5.0",
   "description": "verdaccio types definitions",
@@ -13,2 +13,5 @@ "keywords": [
   "homepage": "https://verdaccio.org",
+  "files": [
+    "./build"
+  ],
   "repository": {
@@ -25,6 +28,9 @@ "type": "git",
   },
-  "main": "index.d.ts",
-  "types": "index.d.ts",
+  "main": "build/types.d.ts",
+  "types": "build/types.d.ts",
   "devDependencies": {
-    "@types/node": "14.18.0"
+    "@types/node": "12.12.6",
+    "typedoc": "^0.22.17",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typedoc-umlclass": "^0.6.1"
   },
@@ -36,6 +42,8 @@ "funding": {
   "scripts": {
+    "clean": "rimraf ./build",
     "test": "exit 0",
-    "build": "exit 0"
+    "build": "tsc --emitDeclarationOnly -p tsconfig.json",
+    "docs": "typedoc --options ./typedoc.json --excludeExternals"
   },
-  "readme": "# Typescript types for Verdaccio\n\nTypescript definitions for verdaccio plugins and internal code\n\n# Typescript\nFor usage with the library, the `tsconfig.json` should looks like this.\n\n```\n//tsconfig.json\n{\n  \"compilerOptions\": {\n    \"target\": \"esnext\",\n    \"module\": \"commonjs\",\n    \"declaration\": true,\n    \"noImplicitAny\": false,\n    \"strict\": true,\n    \"outDir\": \"lib\",\n    \"allowSyntheticDefaultImports\": true,\n    \"esModuleInterop\": true,\n    \"typeRoots\": [\n      \"./node_modules/@verdaccio/types/lib/verdaccio\",\n      \"./node_modules/@types\"\n    ]\n  },\n  \"include\": [\n    \"src/*.ts\",\n    \"types/*.d.ts\"\n  ]\n}\n```\n\n### Imports\n\n```\nimport type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';\n\n class LocalData implements ILocalData {\n\n  path: string;\n  logger: Logger;\n  data: LocalStorage;\n  config: Config;\n  locked: boolean;\n  ...\n}\n```\n\n\n"
+  "readme": "# Typescript types\n\nTypescript definitions for verdaccio plugins and internal code\n\n## Usage\n\nFor usage with the library, the `tsconfig.json` should looks like this.\n\n```\n//tsconfig.json\n{\n  \"compilerOptions\": {\n    \"target\": \"esnext\",\n    \"module\": \"commonjs\",\n    \"declaration\": true,\n    \"noImplicitAny\": false,\n    \"strict\": true,\n    \"outDir\": \"lib\",\n    \"allowSyntheticDefaultImports\": true,\n    \"esModuleInterop\": true,\n    \"typeRoots\": [\n      \"./node_modules/@verdaccio/types/lib/verdaccio\",\n      \"./node_modules/@types\"\n    ]\n  },\n  \"include\": [\n    \"src/*.ts\",\n    \"types/*.d.ts\"\n  ]\n}\n```\n\n### Example\n\n```typescript\nimport type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';\n\n class LocalData implements ILocalData {\n\n  path: string;\n  logger: Logger;\n  data: LocalStorage;\n  config: Config;\n  locked: boolean;\n  ...\n}\n```\n\n#### Plugins\n"
 }

README.md

@@ -1,6 +0,7 @@
-# Typescript types for Verdaccio
+# Typescript types
 
 Typescript definitions for verdaccio plugins and internal code
 
-# Typescript
+## Usage
+
 For usage with the library, the `tsconfig.json` should looks like this.
@@ -32,5 +33,5 @@
 
-### Imports
+### Example
 
-```
+```typescript
 import type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';
@@ -49,2 +50,2 @@
 
-
+#### Plugins

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

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

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

Number of lines in readme file

50

increased by2.04%

Worsened metrics

Total package byte prevSize

4114

decreased by-89.78%

Dev dependency count

4

increased by300%

Number of package files

4

decreased by-20%

Lines of code

4

decreased by-99.2%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes