Use scaffolded template for remixd

libs/README.md

@@ -22,7 +22,7 @@ Remix is built out of several different modules. Here is the brief description.
 + [`remix-lib`](remix-lib/README.md): Common place for libraries being used across multiple modules
 + [`remix-tests`](remix-tests/README.md): Unit test Solidity smart contracts. It works as a plugin & as CLI both
 + [`remix-url-resolver`](remix-url-resolver/README.md): Provide helpers for resolving the content from external URL ( including github, swarm, ipfs etc.).
-+ [`remixd`](https://github.com/ethereum/remixd/tree/master): Allow accessing local filesystem from Remix IDE by running a daemon
++ [`remixd`](remixd/README.md): Allow accessing local filesystem from Remix IDE by running a daemon
 
 Each module generally has their own npm package and test suite, as well as basic documentation in their respective `README`s. Usage of modules as plugin is well documented **[here](https://remix-ide.readthedocs.io/en/latest/index.html)**.
 

libs/remixd/.circleci/config.yml

@@ -1,32 +0,0 @@
-# Javascript Node CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-javascript/ for more details
-#
-version: 2
-jobs:
-  remixd:
-    docker:
-      # specify the version you desire here
-      - image: circleci/node:9.11.2
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/mongo:3.4.4
-    environment:
-      - COMMIT_AUTHOR_EMAIL: "yann@ethereum.org"
-      - COMMIT_AUTHOR: "Circle CI"
-      - FILES_TO_PACKAGE: "package.json"
-    working_directory: ~/remixd
-
-    steps:
-      - checkout
-      - run: npm install
-      - run: npm run lint
-      - run: npm run test
-
-workflows:
-  version: 2
-  build_all:
-    jobs:
-      - remixd

libs/remixd/.eslintrc

@@ -1,21 +1 @@
-{
-    "env": {
-        "browser": true,
-        "commonjs": true,
-        "es6": true
-    },
-    "extends": [
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parser": "@typescript-eslint/parser",
-    "plugins": ["@typescript-eslint"],
-    "rules": {
-        "standard/no-callback-literal": 0,
-        "@typescript-eslint/no-var-requires": 0,
-        "@typescript-eslint/ban-types": 0
-    }
-}
+{ "extends": "../../.eslintrc", "rules": {}, "ignorePatterns": ["!**/*"] }

libs/remixd/.gitignore

@@ -1,5 +0,0 @@
-node_modules
-npm-debug.log
-python_modules
-lib
-shared

libs/remixd/.npmignore

@@ -1,11 +0,0 @@
-node_modules
-npm-debug.log
-python_modules
-shared
-/bin
-/src
-.circleci
-tsconfig.json
-nodemon.json
-.eslintrc.json
-/types

libs/remixd/jest.config.js

@@ -1,14 +1,15 @@
-
 /* eslint-disable */
 module.exports = {
-    name: 'remixd',
-    preset: '../../../jest.config.js',
-    transform: {
-      '^.+\\.[tj]sx?$': [
-        'babel-jest',
-        { cwd: __dirname, configFile: './babel-jest.config.json' }
-      ]
-    },
-    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'html'],
-    coverageDirectory: '../../../coverage/libs/remixd'
-}
+  name: 'remixd',
+  preset: '../../jest.config.js',
+  globals: {
+    'ts-jest': {
+      tsConfig: '<rootDir>/tsconfig.spec.json'
+    }
+  },
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest'
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'html'],
+  coverageDirectory: '../../coverage/libs/remixd'
+};

libs/remixd/src/bin/remixd.ts

@@ -1,15 +1,14 @@
 #!/usr/bin/env node
-import WebSocket from '../src/websocket'
-import * as servicesList from '../src/serviceList'
-import { WS } from '../types/index'
-import { getDomain } from '../src/utils'
+import WebSocket from '../websocket'
+import * as servicesList from '../serviceList'
+import * as WS from 'ws'
+import { getDomain } from '../utils'
 import Axios from 'axios'
 import * as fs from 'fs-extra'
 import * as path from 'path'
+import * as program from 'commander'
 
 (async () => {
-  const program = require('commander')
-  
   program
   .usage('-s <shared folder>')
   .description('Provide a two-way connection between the local computer and Remix IDE')
@@ -19,7 +18,7 @@ import * as path from 'path'
   .on('--help', function(){
     console.log('\nExample:\n\n    remixd -s ./ --remix-ide http://localhost:8080')
   }).parse(process.argv)
-
+  // eslint-disable-next-line
   const killCallBack: Array<Function> = []
 
   if (!program.remixIde) {
@@ -85,6 +84,7 @@ import * as path from 'path'
       return data.includes(origin) ? data.includes(origin) : data.includes(domain)
     } catch (e) {
       try {
+        // eslint-disable-next-line
         const origins = require('./origins.json')
         const { data } = origins
         

libs/remixd/src/services/remixdClient.ts

@@ -1,10 +1,10 @@
 import { PluginClient } from '@remixproject/plugin'
-import { SharedFolderArgs, TrackDownStreamUpdate, WS, Filelist, ResolveDirectory, FileContent } from '../../types'
+import { SharedFolderArgs, TrackDownStreamUpdate, Filelist, ResolveDirectory, FileContent } from '../types'
+import * as WS from 'ws'
 import * as utils from '../utils'
 import * as chokidar from 'chokidar'
 import * as fs from 'fs-extra'
-
-const isbinaryfile = require('isbinaryfile')
+import * as isbinaryfile from 'isbinaryfile'
 
 export class RemixdClient extends PluginClient {
   methods: ['folderIsReadOnly', 'resolveDirectory', 'get', 'exists', 'isFile', 'set', 'list', 'isDirectory']

libs/remixd/src/types/index.ts

@@ -1,4 +1,4 @@
-import * as ServiceList from '../src/serviceList'
+import * as ServiceList from '../serviceList'
 import * as Websocket from 'ws'
 
 type ServiceListKeys = keyof typeof ServiceList;

libs/remixd/src/utils.ts

@@ -1,10 +1,7 @@
-import { ResolveDirectory, Filelist } from '../types'
-
-const fs = require('fs-extra')
-const path = require('path')
-const isbinaryfile = require('isbinaryfile')
-const pathModule = require('path')
-
+import { ResolveDirectory, Filelist } from './types'
+import * as fs from 'fs-extra'
+import * as isbinaryfile from 'isbinaryfile'
+import * as pathModule from 'path'
 /**
  * returns the absolute path of the given @arg path
  *
@@ -45,7 +42,7 @@ function walkSync (dir: string, filelist: Filelist, sharedFolder: string): Filel
 
   filelist = filelist || {}
   files.forEach(function (file) {
-    const subElement = path.join(dir, file)
+    const subElement = pathModule.join(dir, file)
 
     if (!fs.lstatSync(subElement).isSymbolicLink()) {
       if (fs.statSync(subElement).isDirectory()) {
@@ -65,7 +62,7 @@ function resolveDirectory (dir: string, sharedFolder: string): ResolveDirectory
   const files: string[] = fs.readdirSync(dir)
 
   files.forEach(function (file) {
-    const subElement = path.join(dir, file)
+    const subElement = pathModule.join(dir, file)
 
     if (!fs.lstatSync(subElement).isSymbolicLink()) {
       const relative: string = relativePath(subElement, sharedFolder)
@@ -83,6 +80,7 @@ function resolveDirectory (dir: string, sharedFolder: string): ResolveDirectory
  * @return {String} extracted domain name from url
  */
 function getDomain(url: string) {
+  // eslint-disable-next-line
   const domainMatch = url.match(/^(?:https?:\/\/)?(?:[^@\n]+@)?(?:www\.)?([^:\/\n?]+)/img)
 
   return domainMatch ? domainMatch[0] : null

libs/remixd/src/websocket.ts

@@ -1,17 +1,15 @@
 import * as WS from 'ws'
 import * as http from 'http'
-import { WebsocketOpt, SharedFolderClient } from '../types'
+import { WebsocketOpt, SharedFolderClient } from './types'
 import { getDomain } from './utils'
-
-const { createClient } = require('@remixproject/plugin-ws')
-
+import { createClient } from '@remixproject/plugin-ws'
 export default class WebSocket {
   server: http.Server
   wsServer: WS.Server
 
   constructor (public port: number, public opt: WebsocketOpt, public sharedFolder: SharedFolderClient) {}
 
-  start (callback?: Function): void {
+  start (callback?: (ws: WS) => void): void {
     this.server = http.createServer((request, response) => {
       console.log((new Date()) + ' Received request for ' + request.url)
       response.writeHead(404)
@@ -20,7 +18,7 @@ export default class WebSocket {
     const loopback = '127.0.0.1'
 
     this.server.listen(this.port, loopback, function () {
-      console.log((new Date()) + ' Remixd is listening on ' + loopback + ':65520')
+      console.log((new Date()) + ' remixd is listening on ' + loopback + ':65520')
     })
     this.wsServer = new WS.Server({
       server: this.server,
@@ -36,7 +34,7 @@ export default class WebSocket {
     this.wsServer.on('connection', (ws) => {
       const { sharedFolder } = this
 
-      createClient(ws, sharedFolder)
+      createClient(ws, sharedFolder as any)
       if(callback) callback(ws)
     })
   }
@@ -56,6 +54,7 @@ function originIsAllowed (origin: string, self: WebSocket): boolean {
     return origin === self.opt.remixIdeUrl || origin === getDomain(self.opt.remixIdeUrl)
   } else {
     try {
+      // eslint-disable-next-line
       const origins = require('../bin/origins.json')
       const domain = getDomain(origin)
       const { data } = origins

libs/remixd/tsconfig.json

@@ -1,9 +1,13 @@
 {
   "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "types": ["node"],
-    "module": "commonjs",
-    "esModuleInterop": true 
-  },
-  "include": ["**/*.ts"]
-}
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/remixd/tsconfig.lib.json

@@ -1,11 +1,13 @@
-{   
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-      /* Basic Options */
-      "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-      "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-      "strict": true,                         /* Enable all strict type-checking options. */
-      "strictPropertyInitialization": false  /* Enable strict checking of property initialization in classes. */
-    },
-    "include": ["bin", "src", "bin/origins.json"]
-}
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "target": "es6",
+    "module": "commonjs",
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "rootDir": "./src",
+    "types": ["node"]
+  },
+  "exclude": ["**/*.spec.ts"],
+  "include": ["bin", "src", "bin/origins.json"]
+}

libs/remixd/tsconfig.spec.json

@@ -1,14 +1,15 @@
-
 {
-    "extends": "./tsconfig.json",
-    "compilerOptions": {
-      "outDir": "../../../dist/out-tsc",
-      "module": "commonjs",
-      "types": ["jest", "node"]
-    },
-    "include": [
-      "**/*.spec.ts",
-      "**/*.spec.js",
-      "**/*.d.ts"
-    ]
-}
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "**/*.spec.ts",
+    "**/*.spec.tsx",
+    "**/*.spec.js",
+    "**/*.spec.jsx",
+    "**/*.d.ts"
+  ]
+}

package.json

@@ -43,9 +43,9 @@
     "workspace-schematic": "nx workspace-schematic",
     "dep-graph": "nx dep-graph",
     "help": "nx help",
-    "lint:libs": "nx run-many --target=lint --projects=remix-analyzer,remix-astwalker,remix-debug,remix-lib,remix-simulator,remix-solidity,remix-tests,remix-url-resolver",
-    "build:libs": "nx run-many --target=build --parallel=false --with-deps=true --projects=remix-analyzer,remix-astwalker,remix-debug,remix-lib,remix-simulator,remix-solidity,remix-tests,remix-url-resolver",
-    "test:libs": "nx run-many --target=test --projects=remix-analyzer,remix-astwalker,remix-debug,remix-lib,remix-simulator,remix-solidity,remix-tests,remix-url-resolver",
+    "lint:libs": "nx run-many --target=lint --projects=remix-analyzer,remix-astwalker,remix-debug,remix-lib,remix-simulator,remix-solidity,remix-tests,remix-url-resolver,remixd",
+    "build:libs": "nx run-many --target=build --parallel=false --with-deps=true --projects=remix-analyzer,remix-astwalker,remix-debug,remix-lib,remix-simulator,remix-solidity,remix-tests,remix-url-resolver,remixd",
+    "test:libs": "nx run-many --target=test --projects=remix-analyzer,remix-astwalker,remix-debug,remix-lib,remix-simulator,remix-solidity,remix-tests,remix-url-resolver,remixd",
     "publish:libs": "npm run build:libs; lerna publish --skip-git; npm run bumpVersion:libs",
     "bumpVersion:libs": "gulp; gulp syncLibVersions;",
     "browsertest": "sleep 5 && npm run nightwatch_local",
@@ -270,6 +270,7 @@
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "4.2.1",
     "eslint-plugin-standard": "4.0.1",
-    "nodemon": "^2.0.4"
+    "nodemon": "^2.0.4",
+    "@types/jest": "25.1.4"
   }
 }

tsconfig.json

@@ -23,7 +23,10 @@
       "@remix-project/remix-simulator": ["dist/libs/remix-simulator/index.js"],
       "@remix-project/remix-solidity": ["dist/libs/remix-solidity/index.js"],
       "@remix-project/remix-tests": ["dist/libs/remix-tests/src/index.js"],
-      "@remix-project/remix-url-resolver": ["dist/libs/remix-url-resolver/index.js"]
+      "@remix-project/remix-url-resolver": [
+        "dist/libs/remix-url-resolver/index.js"
+      ],
+      "@remix-project/remixd": ["libs/remixd/src/index.ts"]
     }
   },
   "exclude": ["node_modules", "tmp"]

workspace.json

@@ -55,7 +55,8 @@
           "options": {
             "buildTarget": "remix-ide:build",
             "port": 8080,
-            "exclude": ["**/node_modules/**",
+            "exclude": [
+              "**/node_modules/**",
               "apps/remix-ide/build/**/*.js",
               "apps/remix-ide/src/app/editor/mode-solidity.js",
               "apps/remix-ide/soljson.js",
@@ -74,9 +75,7 @@
           "options": {
             "linter": "eslint",
             "config": "apps/remix-ide/.eslintrc",
-            "files": [
-              "apps/remix-ide/src/**/*.js"
-            ],
+            "files": ["apps/remix-ide/src/**/*.js"],
             "exclude": [
               "**/node_modules/**",
               "apps/remix-ide/src/app/editor/mode-solidity.js",
@@ -104,18 +103,18 @@
         "build": {
           "builder": "@nrwl/workspace:run-commands",
           "options": {
-              "commands": [
-                "node_modules/.bin/tsc -p apps/remix-ide-e2e/tsconfig.e2e.json"
-              ]
+            "commands": [
+              "node_modules/.bin/tsc -p apps/remix-ide-e2e/tsconfig.e2e.json"
+            ]
           }
         },
         "e2e": {
           "builder": "@nrwl/workspace:run-commands",
           "options": {
-              "commands": [
-                "TEST_SCRIPT='node_modules/.bin/nightwatch --config dist/apps/remix-ide-e2e/nightwatch.js'; if [ {args.env} != undefined ]; then TEST_SCRIPT=${TEST_SCRIPT}' --env {args.env}'; else TEST_SCRIPT=${TEST_SCRIPT}' --env chrome'; fi; if [ {args.filePath} != undefined ]; then TEST_SCRIPT=${TEST_SCRIPT}' {args.filePath}'; fi; eval $TEST_SCRIPT;"
-              ],
-              "parallel": false
+            "commands": [
+              "TEST_SCRIPT='node_modules/.bin/nightwatch --config dist/apps/remix-ide-e2e/nightwatch.js'; if [ {args.env} != undefined ]; then TEST_SCRIPT=${TEST_SCRIPT}' --env {args.env}'; else TEST_SCRIPT=${TEST_SCRIPT}' --env chrome'; fi; if [ {args.filePath} != undefined ]; then TEST_SCRIPT=${TEST_SCRIPT}' {args.filePath}'; fi; eval $TEST_SCRIPT;"
+            ],
+            "parallel": false
           }
         },
         "lint": {
@@ -215,9 +214,7 @@
           "options": {
             "linter": "eslint",
             "config": "libs/remix-debug/.eslintrc",
-            "files": [
-              "libs/remix-debug/**/*.js"
-            ],
+            "files": ["libs/remix-debug/**/*.js"],
             "exclude": ["**/node_modules/**", "libs/remix-debug/test/**/*"]
           }
         },
@@ -240,8 +237,16 @@
             "packageJson": "libs/remix-debug/package.json",
             "main": "libs/remix-debug/index.js",
             "assets": [
-              { "glob": "rdb", "input": "libs/remix-debug/bin/", "output": "bin/" },
-              { "glob": "*.md", "input": "libs/remix-debug/", "output": "/" }
+              {
+                "glob": "rdb",
+                "input": "libs/remix-debug/bin/",
+                "output": "bin/"
+              },
+              {
+                "glob": "*.md",
+                "input": "libs/remix-debug/",
+                "output": "/"
+              }
             ]
           }
         }
@@ -296,9 +301,7 @@
           "options": {
             "linter": "eslint",
             "config": "libs/remix-simulator/.eslintrc",
-            "files": [
-              "libs/remix-simulator/**/*.js"
-            ],
+            "files": ["libs/remix-simulator/**/*.js"],
             "exclude": ["**/node_modules/**", "libs/remix-simulator/test/**/*"]
           }
         },
@@ -321,8 +324,16 @@
             "packageJson": "libs/remix-simulator/package.json",
             "main": "libs/remix-simulator/index.js",
             "assets": [
-              { "glob": "ethsim", "input": "libs/remix-simulator/bin/", "output": "bin/" },
-              { "glob": "*.md", "input": "libs/remix-simulator/", "output": "/" }
+              {
+                "glob": "ethsim",
+                "input": "libs/remix-simulator/bin/",
+                "output": "bin/"
+              },
+              {
+                "glob": "*.md",
+                "input": "libs/remix-simulator/",
+                "output": "/"
+              }
             ]
           }
         }
@@ -339,9 +350,7 @@
           "options": {
             "linter": "eslint",
             "config": "libs/remix-solidity/.eslintrc",
-            "tsConfig": [
-              "libs/remix-solidity/tsconfig.lib.json"
-            ],
+            "tsConfig": ["libs/remix-solidity/tsconfig.lib.json"],
             "exclude": ["**/node_modules/**"]
           }
         },
@@ -379,9 +388,7 @@
           "options": {
             "linter": "eslint",
             "config": "libs/remix-tests/.eslintrc",
-            "tsConfig": [
-              "libs/remix-tests/tsconfig.lib.json"
-            ],
+            "tsConfig": ["libs/remix-tests/tsconfig.lib.json"],
             "exclude": ["**/node_modules/**", "libs/remix-tests/tests/**/*"]
           }
         },
@@ -400,8 +407,16 @@
             "packageJson": "libs/remix-tests/package.json",
             "main": "libs/remix-tests/src/index.ts",
             "assets": [
-              { "glob": "remix-tests", "input": "libs/remix-tests/bin/", "output": "bin/" },
-              { "glob": "*.md", "input": "libs/remix-tests/", "output": "/" }
+              {
+                "glob": "remix-tests",
+                "input": "libs/remix-tests/bin/",
+                "output": "bin/"
+              },
+              {
+                "glob": "*.md",
+                "input": "libs/remix-tests/",
+                "output": "/"
+              }
             ]
           }
         }
@@ -418,10 +433,11 @@
           "options": {
             "linter": "eslint",
             "config": "libs/remix-url-resolver/.eslintrc",
-            "tsConfig": [
-              "libs/remix-url-resolver/tsconfig.lib.json"
-            ],
-            "exclude": ["**/node_modules/**", "libs/remix-url-resolver/tests/**/*"]
+            "tsConfig": ["libs/remix-url-resolver/tsconfig.lib.json"],
+            "exclude": [
+              "**/node_modules/**",
+              "libs/remix-url-resolver/tests/**/*"
+            ]
           }
         },
         "test": {
@@ -449,7 +465,7 @@
     },
     "remixd": {
       "root": "libs/remixd",
-      "sourceRoot": "libs/remixd/src/",
+      "sourceRoot": "libs/remixd/src",
       "projectType": "library",
       "schematics": {},
       "architect": {
@@ -457,15 +473,11 @@
           "builder": "@nrwl/linter:lint",
           "options": {
             "linter": "eslint",
-            "config": "libs/remixd/.eslintrc",
             "tsConfig": [
-              "libs/remixd/tsconfig.lib.json"
-            ],
-            "files": [
-              "libs/remixd/src/**/*.ts",
-              "libs/remixd/bin/**/*.ts"
+              "libs/remixd/tsconfig.lib.json",
+              "libs/remixd/tsconfig.spec.json"
             ],
-            "exclude": ["**/node_modules/**"]
+            "exclude": ["**/node_modules/**", "!libs/remixd/**/*"]
           }
         },
         "test": {