buidler-typechain - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

 {
   "name": "buidler-typechain",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Buidler TypeScript plugin boilerplate",
@@ -25,3 +25,3 @@ "repository": "github:rhlsthrm/buidler-typechain.git",
   "files": [
-    "dist/src/",
+    "dist/",
     "src/",
@@ -28,0 +28,0 @@ "LICENSE",

README.md

@@ -24,17 +24,7 @@ [![buidler](https://buidler.dev/buidler-plugin-badge.svg?1)](https://buidler.dev)
 
-<_A description of each task added by this plugin. If it just overrides internal 
-tasks, this may not be needed_>
-
 This plugin adds the _typechain_ task to Buidler:
 ```
-output of npx buidler help example
+Generate Typechain typings for compiled contracts
 ``` 
 
-## Environment extensions
-
-<_A description of each extension to the Buidler Runtime Environment_>
-
-This plugin extends the Buidler Runtime Environment by adding an `example` field
-whose type is `ExampleBuidlerRuntimeEnvironmentField`.
-
 ## Configuration
@@ -44,4 +34,3 @@
 
-This plugin extends the `BuidlerConfig`'s `ProjectPaths` object with an optional 
-`newPath` field.
+This plugin extends the `BuidlerConfig` optional `typechain` object. The object contains two fields, `outDir` and `target`. `outDir` is the output directory of the artifacts that TypeChain creates (defaults to `typechain`). `target` is one of the targets specified by the TypeChain [docs](https://github.com/ethereum-ts/TypeChain#cli) (defaults to `ethers`).
 
@@ -52,4 +41,5 @@ This is an example of how to set it:
 module.exports = {
-  paths: {
-    newPath: "./new-path"
+  typechain: {
+    outDir: "src/types",
+    target: "web3-v1"
   }
@@ -61,9 +51,4 @@ };
 
-<_A description of how to use this plugin. How to use the tasks if there are any, etc._>
+`npx buidler typechain` - Compiles and generates Typescript typings for your contracts.
 
-There are no additional steps you need to take for this plugin to work.
-
-Install it and access ethers through the Buidler Runtime Environment anywhere 
-you need it (tasks, scripts, tests, etc).
-
 ## TypeScript support
@@ -70,0 +55,0 @@

New alerts

Filesystem access

Supply chain risk

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

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

14864

increased by122.42%

Number of package files

27

increased by285.71%

Lines of code

173

increased by147.14%

Worsened metrics

Number of lines in readme file

56

decreased by-21.13%

Number of low supply chain risk alerts

2

increased by100%

No dependency changes