depseek - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "depseek",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Seeks for dependency references in JS/TS code",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -41,3 +41,19 @@ # depseek
 ```
+### Options
+By default `depseek` extracts only `require` and `import` arguments. You can also capture bound comments.
+```ts
+const depsAndComments = await depseek(stream, {comments: true})
 
+[
+  { type: 'dep', value: 'node:fs', index: 17 },
+  { type: 'dep', value: 'foo', index: 34 },
+  { type: 'comment', value: ' @1.0.0', index: 46 }
+  //...
+]
+```
+Stream buffer size set to `1000` by default. You can change the limit by passing `bufferSize`.
+```ts
+const deps = await depseek(stream, {bufferSize: 10000})
+```
+
 ## Refs
@@ -44,0 +60,0 @@ * [browserify/module-deps](https://github.com/browserify/module-deps)

target/dts/depseek.d.ts

@@ -8,3 +8,7 @@ /// <reference types="node" resolution-mode="require"/>
 };
-export declare const depseek: (stream: Readable) => Promise<TCodeRef[]>;
+type TOpts = {
+    comments?: boolean;
+    bufferSize?: number;
+};
+export declare const depseek: (stream: Readable, opts?: TOpts) => Promise<TCodeRef[]>;
 export {};

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

10374

increased by8.56%

Lines of code

163

increased by3.82%

Number of lines in readme file

65

increased by32.65%

No dependency changes