Merge pull request #137 from Crypto-Punkers/ritave/lint

ritave · web-flow · commit aa15ba13b55d · 2019-04-12T14:14:06.000+02:00
Added linting
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,27 +1,50 @@
 version: 2
 jobs:
-  build:
-    docker:
-        - image: circleci/node:10.15
-    steps:
-        - checkout
-        - restore_cache:
-            name: Restore yarn cache
-            key: node-modules-{{ .Branch }}-{{ checksum "yarn.lock" }}
-        - run:
-            name: Install modules
-            command: yarn --frozen-lockfile install
-        - save_cache:
-            name: Save yarn cache
-            key: node-modules-{{ .Branch }}-{{ checksum "yarn.lock" }}
-            paths:
-                - node_modules
-        - run:
-            name: Build
-            command: yarn build
-        - run:
-            name: Tests
-            command: yarn test
-        - run: # TODO(ritave): Move into seperate workspace that lints everything
-            name: Prettier
-            command: yarn prettier
+    test:
+        docker:
+            - image: circleci/node:10.15
+        steps:
+            - checkout
+            - restore_cache:
+                name: Restore yarn cache
+                key: node-modules-{{ .Branch }}-{{ checksum "yarn.lock" }}
+            - run:
+                name: Install modules
+                command: yarn --frozen-lockfile install
+            - save_cache:
+                name: Save yarn cache
+                key: node-modules-{{ .Branch }}-{{ checksum "yarn.lock" }}
+                paths:
+                    - node_modules
+            - run:
+                name: Build
+                command: yarn build
+            - run:
+                name: Tests
+                command: yarn test
+    lint:
+        docker:
+            - image: circleci/node:10.15
+        steps:
+            - checkout
+            - restore_cache:
+                name: Restore yarn cache
+                key: node-modules-{{ .Branch }}-{{ checksum "yarn.lock" }}
+            - run:
+                name: Install modules
+                command: yarn --frozen-lockfile install
+            - save_cache:
+                name: Save yarn cache
+                key: node-modules-{{ .Branch }}-{{ checksum "yarn.lock" }}
+                paths:
+                    - node_modules
+            - run:
+                name: Lint
+                command: yarn lint
+
+workflows:
+    version: 2
+    main:
+        jobs:
+            - test
+            - lint
diff --git a/README.md b/README.md
@@ -41,9 +41,7 @@ resolver
 ```typescript
 import { parsers, resolvers, ResolverEngine } from "@resolver-engine/core";
 
-const resolver = new ResolverEngine<string>()
-  .addResolver(resolvers.UriResolver())
-  .addParser(parsers.UrlParser());
+const resolver = new ResolverEngine<string>().addResolver(resolvers.UriResolver()).addParser(parsers.UrlParser());
 
 resolver.resolve("https://pastebin.com/raw/D8ziKX0a").then(console.log);
 ```
diff --git a/integration-tests/package.json b/integration-tests/package.json
@@ -6,18 +6,19 @@
   "author": "Crypto Punkers <hello@punkers.co>",
   "license": "LGPL-3.0-or-later",
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "lint": "tslint -c ./tslint.json -p ./"
   },
   "devDependencies": {
     "@types/debug": "^4.1.1",
+    "@types/jest": "^24.0.6",
     "@types/nock": "^9.3.1",
     "@types/node": "^11.9.4",
-    "@types/jest": "^24.0.6",
     "jest": "<25.0.0",
-    "ts-jest": "^24.0.0",
     "memfs": "^2.15.0",
     "nock": "^10.0.6",
     "rimraf": "^2.6.2",
+    "ts-jest": "^24.0.0",
     "typescript": "^3.2.4"
   },
   "dependencies": {
diff --git a/integration-tests/src/__tests__/determineProvider.spec.ts b/integration-tests/src/__tests__/determineProvider.spec.ts
@@ -7,7 +7,7 @@ import mockedFS from "../__mocks__/MockedFs";
 type input_t = [string, string | undefined];
 type output_t = [string, string];
 
-const data: [input_t, output_t][] = [
+const data: Array<[input_t, output_t]> = [
   [
     ["https://github.com/Crypto-Punkers/resolver-engine/examples/github.ts", undefined],
     ["https://raw.githubusercontent.com/Crypto-Punkers/resolver-engine/master/examples/github.ts", "github"],
diff --git a/integration-tests/src/__tests__/findImports.spec.ts b/integration-tests/src/__tests__/findImports.spec.ts
@@ -1,7 +1,7 @@
 import { findImports, ImportFile } from "@resolver-engine/imports";
 
 describe("findImports", function() {
-  let providedFile: ImportFile = { url: "", source: "", provider: "" };
+  const providedFile: ImportFile = { url: "", source: "", provider: "" };
 
   describe("Double quotes", function() {
     it('finds statements like: import "file";', function() {
diff --git a/integration-tests/src/__tests__/gatherSources.spec.ts b/integration-tests/src/__tests__/gatherSources.spec.ts
@@ -1,13 +1,15 @@
 jest.mock("fs");
-import nock from "nock";
-import { vol } from "memfs";
-import { ImportsFsEngine } from "@resolver-engine/imports-fs";
 import { gatherSources, ImportFile } from "@resolver-engine/imports";
+import { ImportsFsEngine } from "@resolver-engine/imports-fs";
+import { vol } from "memfs";
+import nock from "nock";
 
-type dictionary = { [s: string]: string };
+interface Dictionary {
+  [s: string]: string;
+}
 
-function expectedOutput(filesObj: dictionary, provider: string, namePrefix: string): ImportFile[] {
-  let result: ImportFile[] = [];
+function expectedOutput(filesObj: Dictionary, provider: string, namePrefix: string): ImportFile[] {
+  const result: ImportFile[] = [];
   let prefix = namePrefix;
   if (namePrefix !== "") {
     prefix += "/";
@@ -16,13 +18,13 @@ function expectedOutput(filesObj: dictionary, provider: string, namePrefix: stri
     result.push({
       url: prefix + k,
       source: filesObj[k],
-      provider: provider,
+      provider,
     });
   }
   return result;
 }
 
-const data: [string, dictionary, string[], string, string][] = [
+const data: Array<[string, Dictionary, string[], string, string]> = [
   [
     "gathers files included by given file",
     {
@@ -130,22 +132,22 @@ describe("gatherSources function", function() {
     vol.reset();
   });
 
-  it.each(data)("%s", async function(message, test_fs, input, cwd, provider) {
-    const EXPECTED_FILES = expectedOutput(test_fs, provider, cwd);
+  it.each(data)("%s", async function(message, testFs, input, cwd, provider) {
+    const EXPECTED_FILES = expectedOutput(testFs, provider, cwd);
 
-    vol.fromJSON(test_fs);
+    vol.fromJSON(testFs);
     const fileList = await gatherSources(input, cwd, resolver);
     expect(fileList.sort((a, b) => a.url.localeCompare(b.url))).toEqual(
       EXPECTED_FILES.sort((a, b) => a.url.localeCompare(b.url)),
     );
   });
 
   it("throws when imported file doesn't exist", async function() {
-    const test_fs: dictionary = {
+    const testFs: Dictionary = {
       "main.sol": 'import "./otherfile.sol";\nrestoffileblahblah',
     };
 
-    vol.fromJSON(test_fs);
+    vol.fromJSON(testFs);
     await expect(gatherSources(["main.sol"], __dirname, resolver)).rejects.toThrowError();
   });
 
diff --git a/integration-tests/tslint.json b/integration-tests/tslint.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../tslint.json"],
+  "rules": { "only-arrow-functions": false }
+}
diff --git a/package.json b/package.json
@@ -7,7 +7,6 @@
   "repository": "git@github.com:Crypto-Punkers/resolver-engine.git",
   "author": "Crypto Punkers <hello@punkers.co>",
   "scripts": {
-    "prepare": "run-s clean build",
     "build": "tsc -b tsproject.json",
     "build:core": "wsrun -p core --stages build",
     "build:fs": "wsrun -p fs --stages build",
@@ -17,7 +16,8 @@
     "clean": "wsrun --exclude-missing clean",
     "prettier": "prettier --config .prettierrc.yaml --write --list-different './**/*.{ts,tsx,json,md}'",
     "test": "run-s build test:execute",
-    "test:execute": "wsrun --parallel --collect-logs test"
+    "test:execute": "wsrun --parallel --collect-logs test",
+    "lint": "wsrun --parallel --collect-logs lint"
   },
   "devDependencies": {
     "@types/debug": "^4.1.1",
@@ -32,6 +32,9 @@
     "prettier": "1.16.4",
     "rimraf": "^2.6.2",
     "ts-jest": "^24.0.0",
+    "tslint": "^5.15.0",
+    "tslint-config-prettier": "^1.18.0",
+    "tslint-plugin-prettier": "^2.0.1",
     "typescript": "^3.2.4",
     "wsrun": "^3.6.2"
   },
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -10,7 +10,8 @@
     "build": "tsc",
     "tsc": "tsc",
     "clean": "rimraf build/",
-    "test": "jest"
+    "test": "jest",
+    "lint": "tslint -c ../../tslint.json -p ./"
   },
   "dependencies": {
     "debug": "^3.1.0",
diff --git a/packages/core/src/parsers/urlparser.ts b/packages/core/src/parsers/urlparser.ts
@@ -8,6 +8,8 @@ export function UrlParser(): SubParser<string> {
   return (url: string): Promise<string | null> =>
     new Promise((resolve, reject) => {
       try {
+        // We're using this line for the side-effects
+        // tslint:disable-next-line:no-unused-expression
         new URL(url);
       } catch (err) {
         // Not an actual browser url, might be filesystem
diff --git a/packages/core/src/resolverengine.ts b/packages/core/src/resolverengine.ts
@@ -14,7 +14,7 @@ export interface Options {
 
 export class ResolverEngine<R> {
   private resolvers: SubResolver[] = [];
-  private parsers: SubParser<R>[] = [];
+  private parsers: Array<SubParser<R>> = [];
 
   constructor(options?: Options) {
     const opts: Options = { ...options };
@@ -51,7 +51,7 @@ export class ResolverEngine<R> {
       cwd: workingDir,
     };
 
-    const url = await firstResult(this.resolvers, resolver => resolver(uri, ctx));
+    const url = await firstResult(this.resolvers, currentResolver => currentResolver(uri, ctx));
 
     if (url === null) {
       throw resolverError(uri);
diff --git a/packages/fs/package.json b/packages/fs/package.json
@@ -10,7 +10,8 @@
     "build": "tsc",
     "tsc": "tsc",
     "clean": "rimraf build/",
-    "test": "jest"
+    "test": "jest",
+    "lint": "tslint -c ../../tslint.json -p ./"
   },
   "dependencies": {
     "@resolver-engine/core": "0.3.0",
diff --git a/packages/fs/src/resolvers/fsresolver.ts b/packages/fs/src/resolvers/fsresolver.ts
@@ -1,10 +1,10 @@
 import { Context, SubResolver } from "@resolver-engine/core";
-import * as fs from "fs";
-import * as path from "path";
+import * as fsSys from "fs";
+import * as pathSys from "path";
 
-const statAsync = (path: string): Promise<fs.Stats> =>
-  new Promise<fs.Stats>((resolve, reject) => {
-    fs.stat(path, (err, stats) => {
+const statAsync = (path: string): Promise<fsSys.Stats> =>
+  new Promise<fsSys.Stats>((resolve, reject) => {
+    fsSys.stat(path, (err, stats) => {
       if (err) {
         reject(err);
       }
@@ -19,8 +19,8 @@ export function FsResolver(): SubResolver {
     const cwd = ctx.cwd || process.cwd();
 
     let myPath: string;
-    if (!path.isAbsolute(resolvePath)) {
-      myPath = path.join(cwd, resolvePath);
+    if (!pathSys.isAbsolute(resolvePath)) {
+      myPath = pathSys.join(cwd, resolvePath);
     } else {
       myPath = resolvePath;
     }
diff --git a/packages/imports-fs/package.json b/packages/imports-fs/package.json
@@ -10,7 +10,8 @@
     "build": "tsc",
     "tsc": "tsc",
     "clean": "rimraf build/",
-    "test": "jest"
+    "test": "jest",
+    "lint": "tslint -c ../../tslint.json -p ./"
   },
   "dependencies": {
     "@resolver-engine/fs": "0.3.0",
diff --git a/packages/imports/package.json b/packages/imports/package.json
@@ -10,7 +10,8 @@
     "build": "tsc",
     "tsc": "tsc",
     "clean": "rimraf build/",
-    "test": "jest"
+    "test": "jest",
+    "lint": "tslint -c ../../tslint.json -p ./"
   },
   "dependencies": {
     "@resolver-engine/core": "0.3.0",
diff --git a/packages/imports/src/importsengine.ts b/packages/imports/src/importsengine.ts
@@ -5,15 +5,10 @@ import { IPFSResolver } from "./resolvers/ipfsresolver";
 import { SwarmResolver } from "./resolvers/swarmresolver";
 
 export function ImportsEngine(): ResolverEngine<ImportFile> {
-  return (
-    new ResolverEngine<ImportFile>()
-      //.addResolver(FsResolver())
-      //.addResolver(EthPmResolver())
-      //.addResolver(NodeResolver())
-      .addResolver(GithubResolver())
-      .addResolver(SwarmResolver())
-      .addResolver(IPFSResolver())
-      .addResolver(resolvers.UriResolver())
-      .addParser(ImportParser([parsers.UrlParser()]))
-  );
+  return new ResolverEngine<ImportFile>()
+    .addResolver(GithubResolver())
+    .addResolver(SwarmResolver())
+    .addResolver(IPFSResolver())
+    .addResolver(resolvers.UriResolver())
+    .addParser(ImportParser([parsers.UrlParser()]));
 }
diff --git a/packages/imports/src/parsers/importparser.ts b/packages/imports/src/parsers/importparser.ts
@@ -7,10 +7,9 @@ export interface ImportFile {
   url: string;
   source: string;
   provider: string;
-  //internalImportURis: string[];
 }
 
-export function ImportParser(sourceParsers: SubParser<string>[]): SubParser<ImportFile> {
+export function ImportParser(sourceParsers: Array<SubParser<string>>): SubParser<ImportFile> {
   return async (url: string, ctx: Context): Promise<ImportFile | null> => {
     const source = await firstResult(sourceParsers, parser => parser(url, ctx));
     if (!source) {
diff --git a/packages/imports/src/utils.ts b/packages/imports/src/utils.ts
diff --git a/tslint.json b/tslint.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import mockedFS from "../__mocks__/MockedFs";`
`7`	`7`	`type input_t = [string, string \| undefined];`
`8`	`8`	`type output_t = [string, string];`
`9`	`9`
`10`		`-const data: [input_t, output_t][] = [`
	`10`	`+const data: Array<[input_t, output_t]> = [`
`11`	`11`	`[`
`12`	`12`	`["https://github.com/Crypto-Punkers/resolver-engine/examples/github.ts", undefined],`
`13`	`13`	`["https://raw.githubusercontent.com/Crypto-Punkers/resolver-engine/master/examples/github.ts", "github"],`