Implement typescript strict mode and ESLint in ipld-eth-client and cache packages (#37)

* Set up typescript build. * Setup eslint in cache package. * Automatic lint fixes. * Fix typescript return types. * Fix typescript argument type warnings. * Set up typescript build and eslint. * Automatic lint fixes. * Fix typescript explicit any warnings. * Add argument types. * Fix return type warnings. * Fix typescript errors. * Implement declaration in types directory. Co-authored-by: nikugogoi <95nikass@gmail.com>
2026-09-08 00:44:06 +00:00 · 2021-06-04 12:04:12 +05:30
parent 47ce52c112
commit 4e0ef7c852
18 changed files with 415 additions and 113 deletions
@@ -0,0 +1,5 @@
+# Don't lint node_modules.
+node_modules
+
+# Don't lint build output.
+dist
@@ -0,0 +1,27 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "extends": [
+        "semistandard",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/explicit-module-boundary-types": [
+            "error",
+            {
+                "allowArgumentsExplicitlyTypedAsAny": true
+            }
+        ]
+    }
+}
@@ -1,45 +1,59 @@
 {
-    "name": "@vulcanize/cache",
-    "version": "0.1.0",
-    "description": "Generic object cache",
-    "private": true,
-    "main": "index.ts",
-    "scripts": {
-      "test": "mocha -r ts-node/register src/**/*.spec.ts"
-    },
-    "repository": {
-      "type": "git",
-      "url": "git+https://github.com/vulcanize/erc20-watcher.git"
-    },
-    "author": "",
-    "license": "UNLICENSED",
-    "bugs": {
-      "url": "https://github.com/vulcanize/erc20-watcher/issues"
-    },
-    "homepage": "https://github.com/vulcanize/erc20-watcher#readme",
-    "dependencies": {
-      "@types/lodash": "^4.14.168",
-      "apollo-type-bigint": "^0.1.3",
-      "canonical-json": "^0.0.4",
-      "debug": "^4.3.1",
-      "ethers": "^5.2.0",
-      "express": "^4.17.1",
-      "express-graphql": "^0.12.0",
-      "fs-extra": "^10.0.0",
-      "graphql": "^15.5.0",
-      "graphql-import-node": "^0.0.4",
-      "graphql-request": "^3.4.0",
-      "graphql-tools": "^7.0.4",
-      "left-pad": "^1.3.0",
-      "level": "^7.0.0",
-      "lodash": "^4.17.21",
-      "toml": "^3.0.0",
-      "yargs": "^17.0.1"
-    },
-    "devDependencies": {
-      "@types/express": "^4.17.11",
-      "@types/yargs": "^17.0.0",
-      "nodemon": "^2.0.7",
-      "ts-node": "^10.0.0"
-    }
+  "name": "@vulcanize/cache",
+  "version": "0.1.0",
+  "description": "Generic object cache",
+  "private": true,
+  "main": "index.ts",
+  "scripts": {
+    "test": "mocha -r ts-node/register src/**/*.spec.ts",
+    "build": "tsc",
+    "lint": "eslint ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vulcanize/erc20-watcher.git"
+  },
+  "author": "",
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/vulcanize/erc20-watcher/issues"
+  },
+  "homepage": "https://github.com/vulcanize/erc20-watcher#readme",
+  "dependencies": {
+    "@types/lodash": "^4.14.168",
+    "apollo-type-bigint": "^0.1.3",
+    "canonical-json": "^0.0.4",
+    "debug": "^4.3.1",
+    "ethers": "^5.2.0",
+    "express": "^4.17.1",
+    "express-graphql": "^0.12.0",
+    "fs-extra": "^10.0.0",
+    "graphql": "^15.5.0",
+    "graphql-import-node": "^0.0.4",
+    "graphql-request": "^3.4.0",
+    "graphql-tools": "^7.0.4",
+    "left-pad": "^1.3.0",
+    "level": "^7.0.0",
+    "lodash": "^4.17.21",
+    "toml": "^3.0.0",
+    "yargs": "^17.0.1"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.5",
+    "@types/express": "^4.17.11",
+    "@types/fs-extra": "^9.0.11",
+    "@types/level": "^6.0.0",
+    "@types/yargs": "^17.0.0",
+    "@typescript-eslint/eslint-plugin": "^4.25.0",
+    "@typescript-eslint/parser": "^4.25.0",
+    "eslint": "^7.27.0",
+    "eslint-config-semistandard": "^15.0.1",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.23.3",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "nodemon": "^2.0.7",
+    "ts-node": "^10.0.0"
  }
+}
@@ -8,12 +8,18 @@ import debug from 'debug';

 const log = debug('vulcanize:cache');

-export const getCache = async (config) => {
+interface Config {
+  name: string;
+  enabled: boolean;
+  deleteOnStart: boolean;
+}
+
+export const getCache = async (config: Config): Promise<undefined | Cache> => {
  let cache;

  // Cache is optional.
  if (config) {
-    log("config", JSON.stringify(config, null, 2));
+    log('config', JSON.stringify(config, null, 2));

    const { name, enabled, deleteOnStart } = config;

@@ -37,23 +43,22 @@ export const getCache = async (config) => {
 };

 export class Cache {
-
  _db: any;
  _name: string;

-  constructor(name, dirPath) {
+  constructor (name: string, dirPath: string) {
    assert(name);
    assert(dirPath);

    this._name = name;
-    this._db = level(dirPath, { valueEncoding: 'json' });;
+    this._db = level(dirPath, { valueEncoding: 'json' });
  }

-  key(obj) {
+  key (obj: any): string {
    return this._cacheKey(obj);
  }

-  async get(obj) {
+  async get (obj: any): Promise<[any, boolean] | undefined> {
    const key = this._cacheKey(obj);

    try {
@@ -66,16 +71,16 @@ export class Cache {
      log(`${this._name}: cache miss ${key}`);

      if (err.notFound) {
-        return [undefined, false]
+        return [undefined, false];
      }
    }
  }

-  async put(obj, value) {
+  async put (obj: any, value: any): Promise<void> {
    await this._db.put(this._cacheKey(obj), value);
  }

-  _cacheKey(obj) {
+  _cacheKey (obj: any): string {
    return ethers.utils.keccak256(Buffer.from(canonicalStringify(obj)));
  }
 }
@@ -0,0 +1,75 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
+    "module": "commonjs",                           /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    "outDir": "dist",                              /* Redirect output structure to the directory. */
+    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                                 /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    "typeRoots": [
+      "./types"
+    ],                                              /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                        /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                           /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true        /* Disallow inconsistently-cased references to the same file. */
+  },
+  "exclude": ["src/**/*.test.ts", "dist"]
+}
@@ -0,0 +1,2 @@
+// https://medium.com/@steveruiz/using-a-javascript-library-without-type-declarations-in-a-typescript-project-3643490015f3
+declare module 'canonical-json'
@@ -0,0 +1,5 @@
+{
+  "name": "common",
+  "version": "0.1.0",
+  "typings": "main.d.ts"
+}