Feat/ts (#7)

implement bundler in ts

.eslintrc.js

@@ -1,27 +1,53 @@
 module.exports = {
   env: {
-    commonjs: true,
+    browser: false,
     es2021: true,
-    "jest/globals": true,
+    mocha: true,
+    node: true,
+    jest: true,
   },
-  globals: {
-    hre: "readonly",
-  },
-  plugins: ["jest"],
-  extends: ["standard", "prettier"],
-  overrides: [
-    {
-      env: {
-        node: true,
-      },
-      files: [".eslintrc.{js,cjs}"],
-      parserOptions: {
-        sourceType: "script",
-      },
-    },
+
+  root: true,
+
+  plugins: ["@typescript-eslint", "json", "promise", "import", "prettier"],
+
+  extends: [
+    "eslint:recommended",
+    "plugin:node/recommended",
+    "plugin:json/recommended",
+    "plugin:promise/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "prettier",
   ],
+
+  parser: "@typescript-eslint/parser",
+
   parserOptions: {
-    ecmaVersion: "latest",
+    ecmaVersion: 12,
+  },
+
+  rules: {
+    "node/no-missing-import": "off",
+    "node/no-unpublished-import": "off",
+    "prettier/prettier": "warn",
+    "import/order": [
+      "warn",
+      {
+        alphabetize: {
+          order: "asc",
+          caseInsensitive: true,
+        },
+      },
+    ],
+    "sort-vars": ["warn", { ignoreCase: true }],
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      { ignores: ["modules"] },
+    ],
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": "error",
   },
-  rules: {},
+
+  ignorePatterns: ["dist", "**/*.d.ts"],
 };

.github/workflows/quality-gate.yml

@@ -10,6 +10,8 @@ jobs:
       - uses: actions/checkout@v3
       - name: Install modules
         run: npm i
+      - name: Typeccheck
+        run: npm run typecheck;
       - name: Run linitng
         run: npm run lint
       - name: Run unit tests

.github/workflows/release-package.yml

@@ -13,4 +13,5 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: npm ci
+      - run: npm run build:pkg
       - run: npm publish

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 cache
 artifacts
-.vscode
+.vscode
+dist

.husky/pre-push

@@ -2,5 +2,6 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 npm run lint;
+npm run typecheck;
 npm run test:unit;
 npm run test:integration;

.lintstagedrc.json

@@ -1,9 +1,9 @@
 {
-  "src/**/*.js": [
+  "src/**/*.ts": [
     "eslint --fix",
     "prettier --write"
   ],
-  "integration/**/*.js": [
+  "integration/**/*.ts": [
     "eslint --fix",
     "prettier --write"
   ]

README.md

@@ -1,25 +1,33 @@
 # sol-bundler
-Build, update and redeploy smartcontracts with hardhat with one config
-sol-bundler tracks contract changes and redeploys only those where any changes were made
+Build, update and redeploy smart contracts with hardhat with one config.
+`sol-bundler` tracks contract changes and redeploys only those where any changes were made.
 
 ## Installation
-run `npm install @dgma/sol-bundler`
+run `npm install --save-dev @dgma/sol-bundler`
 ## Usage
 1. Create deployment config in hardhat
-```js
-module.exports = {
+```ts
+import { type HardhatUserConfig } from "hardhat/config";
+import "@nomicfoundation/hardhat-ethers";
+import { dynamicAddress } from "./src";
+
+const config: HardhatUserConfig = {
+  solidity: "0.8.17",
+  paths: {
+    sources: "./testData",
+    tests: "./integration",
+  },
   networks: {
     hardhat: {
       deployment: {
-        // omit lockFile if you want to have a fresh deploy each time
         lockFile: "deployment-lock.json",
         config: {
           TestLibrary: {},
           TestContract: {
             args: ["hello"],
             options: {
               libs: {
-                TestLibrary: (_, ctx) => ctx.TestLibrary.address,
+                TestLibrary: dynamicAddress("TestLibrary"),
               },
             },
           },
@@ -28,9 +36,12 @@ module.exports = {
     },
   },
 };
+
+export default config;
 ```
-3. Write deployment script/task
-```js
+2. Write deployment script or task
+```ts
+import hre from "hardhat";
 const { solBundler } = require('@dgma/sol-bundler');
 
 const deploy = () => solBundler(hre)

hardhat.config.js → hardhat.config.ts

@@ -1,10 +1,8 @@
-require("@nomicfoundation/hardhat-ethers");
-require("@nomicfoundation/hardhat-chai-matchers");
+import { type HardhatUserConfig } from "hardhat/config";
+import "@nomicfoundation/hardhat-ethers";
+import { dynamicAddress } from "./src";
 
-const getAddr = (contractName) => (_, ctx) => ctx[contractName].address;
-
-/** @type import('hardhat/config').HardhatUserConfig */
-module.exports = {
+const config: HardhatUserConfig = {
   solidity: "0.8.17",
   paths: {
     sources: "./testData",
@@ -19,7 +17,7 @@ module.exports = {
             args: ["hello"],
             options: {
               libs: {
-                TestLibrary: getAddr("TestLibrary"),
+                TestLibrary: dynamicAddress("TestLibrary"),
               },
             },
           },
@@ -28,3 +26,5 @@ module.exports = {
     },
   },
 };
+
+export default config;

integration/main.test.js → integration/main.test.ts

@@ -1,9 +1,10 @@
-const { expect } = require("chai");
-const { solBundler } = require("../index");
+import { expect } from "chai";
+import hre from "hardhat";
+import { type IGlobalState, solBundler } from "../src";
 
 describe("main", () => {
   it("should deploy contracts based on config file", async () => {
-    const { ctx, deployedContracts } = await solBundler(hre);
+    const { ctx, deployedContracts } = (await solBundler(hre)) as IGlobalState;
     expect(deployedContracts).to.eql(["TestLibrary", "TestContract"]);
     expect(ctx).to.have.property("TestContract");
     expect(ctx).to.have.property("TestLibrary");

jest.config.js

@@ -0,0 +1,6 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testPathIgnorePatterns: ["integration"],
+};