Add prettier (#530)

* add prettier and configuration

* run formatter

* chore: making prettier run transparently

Co-authored-by: Josep M Sobrepere <jm.sobrepere@gmail.com>

Author: wirednkod

.eslintrc.js

@@ -1,33 +1,28 @@
 module.exports = {
   root: true,
   rules: {
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      { "argsIgnorePattern": "^_" }
-    ],
+    "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
     "@typescript-eslint/restrict-plus-operands": [
       "error",
-      { "checkCompoundAssignments": false }
+      { checkCompoundAssignments: false },
     ],
     "@typescript-eslint/restrict-template-expressions": "off",
-    "tsdoc/syntax": "error"
+    "tsdoc/syntax": "error",
   },
   parser: "@typescript-eslint/parser",
   settings: { react: { version: "detect" } },
-  plugins: [
-    "@typescript-eslint",
-    "eslint-plugin-tsdoc"
-  ],
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
   parserOptions: {
     project: "./tsconfig.json",
-    createDefaultProgram: true
+    createDefaultProgram: true,
   },
   extends: [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking"
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "prettier",
   ],
   env: {
-    browser: true
-  }
-};
+    browser: true,
+  },
+}

.husky/pre-commit

@@ -1,4 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn test
+npx lint-staged
+yarn test

.prettierignore

@@ -0,0 +1,79 @@
+dist
+.idea
+
+# misc
+.DS_Store
+
+# testing
+/coverage
+
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Dependency directories
+node_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+.env.test
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.pnp.*
+
+logs
+*.log
+npm-debug.log*
+.DS_Store
+.vscode
+
+.prettierrc
+package-lock.json
+
+# Project specifics
+.chains
+.github
+CONTRIBUTING*
+DEPLOY-RELEASE*
+LICENSE*
+README*
+*coverage*
+polkadot.json*
+kusama.json*
+westend.json*
+*westmint*.json*
+rococo.json*

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "trailingComma": "all",
+  "semi": false
+}

bin/checkSpecs.js

@@ -1,33 +1,32 @@
-const fs = require('fs');
-const path = require('path');
+const fs = require("fs")
+const path = require("path")
 const networks = [
-  'polkadot',
-  'kusama',
-  'westend',
-  'rococo' //, 'tick', 'track', 'trick'
-];
+  "polkadot",
+  "kusama",
+  "westend",
+  "rococo", //, 'tick', 'track', 'trick'
+]
 
-const chainDir = '../../.chains';
+const chainDir = "../../.chains"
 
 const paths = {
-  'connect': 'src/specs',
-  'extension': 'public/assets'
+  connect: "src/specs",
+  extension: "public/assets",
 }
 
-const workspace = path.resolve().split('/').pop();
-const workspacePath = `${path.resolve()}/${paths[workspace]}`;
-const pathExist = fs.existsSync(workspacePath);
+const workspace = path.resolve().split("/").pop()
+const workspacePath = `${path.resolve()}/${paths[workspace]}`
+const pathExist = fs.existsSync(workspacePath)
 
 // check if path exist. If not create it
-if (!pathExist) fs.mkdirSync(workspacePath);
+if (!pathExist) fs.mkdirSync(workspacePath)
 
-networks.forEach(network => {
-  const file = `${workspacePath}/${network}.json`; 
+networks.forEach((network) => {
+  const file = `${workspacePath}/${network}.json`
   if (!fs.existsSync(file)) {
-    console.log(`File ${file} does not exist. Copying...`);
-    fs.copyFile(
-      `${chainDir}/${network}.json`, file,
-      (err) => { if (err) throw err }
-    );
+    console.log(`File ${file} does not exist. Copying...`)
+    fs.copyFile(`${chainDir}/${network}.json`, file, (err) => {
+      if (err) throw err
+    })
   }
-});
+})

bin/downloadSpecs.js

@@ -1,53 +1,58 @@
-const http = require('https');
-const fs = require('fs');
+const http = require("https")
+const fs = require("fs")
 
-const specsRepo = 'https://raw.githubusercontent.com/paritytech/smoldot/main/bin';
-const chainDir = '.chains';
+const specsRepo =
+  "https://raw.githubusercontent.com/paritytech/smoldot/main/bin"
+const chainDir = ".chains"
 
 const networks = [
-  'polkadot',
-  'kusama',
-  'westend',
-  'rococo' //, 'tick', 'track', 'trick'
-];
-
-const paths = [
-  'packages/connect/src/specs',
-  'projects/extension/public/assets',
+  "polkadot",
+  "kusama",
+  "westend",
+  "rococo", //, 'tick', 'track', 'trick'
 ]
 
+const paths = ["packages/connect/src/specs", "projects/extension/public/assets"]
+
 // check if paths exist. If not create them
-paths.forEach(p => {
-  (!fs.existsSync(p)) && fs.mkdirSync(p);  
-});
+paths.forEach((p) => {
+  !fs.existsSync(p) && fs.mkdirSync(p)
+})
 
 // Initialiaze download of specs from smoldot (for now)
 // and create promises to be executed
-let promises = [];
-console.log(`Init downloading of specs for chains ${networks.join(', ')}.`);
+let promises = []
+console.log(`Init downloading of specs for chains ${networks.join(", ")}.`)
 networks.forEach((network) => {
-  let url = `${specsRepo}/${network}.json`;
+  let url = `${specsRepo}/${network}.json`
   let promise = new Promise((resolve, reject) => {
-      http.get(url, function (response) {
-      console.log(`Downloading '${network}.json' in '${chainDir}' dir`);
-      let path = `${chainDir}/${network}.json`;
-      const stream = response.pipe(fs.createWriteStream(path, { flags: 'w' }));
-      stream.on('finished', () => resolve());
-      stream.on('error', () => reject());
-    });
-  });
-  promises.push(promise);
-});
+    http.get(url, function (response) {
+      console.log(`Downloading '${network}.json' in '${chainDir}' dir`)
+      let path = `${chainDir}/${network}.json`
+      const stream = response.pipe(fs.createWriteStream(path, { flags: "w" }))
+      stream.on("finished", () => resolve())
+      stream.on("error", () => reject())
+    })
+  })
+  promises.push(promise)
+})
 
 //Execute downloading of files and copy files to specific directoies
-Promise.all(promises).then(() => {
-  paths.forEach(path => {
-    networks.forEach(network => {
-      fs.copyFile(
-        `${chainDir}/${network}.json`, `${path}/${network}.json`,
-        (err) => { if (err) throw err }
-      );
-      console.log(`Successfully moved '${chainDir}/${network}.json' to '${path}'`);
-    });
-  });
-}).catch(err => console.log('Error:', err));
+Promise.all(promises)
+  .then(() => {
+    paths.forEach((path) => {
+      networks.forEach((network) => {
+        fs.copyFile(
+          `${chainDir}/${network}.json`,
+          `${path}/${network}.json`,
+          (err) => {
+            if (err) throw err
+          },
+        )
+        console.log(
+          `Successfully moved '${chainDir}/${network}.json' to '${path}'`,
+        )
+      })
+    })
+  })
+  .catch((err) => console.log("Error:", err))

package.json

@@ -29,7 +29,7 @@
     "api-docs": "typedoc",
     "deep-clean": "yarn workspaces -s run deep-clean && rm -rf .parcel-cache && rm -rf node_modules",
     "clean": " yarn workspaces run clean",
-    "lint": "yarn workspaces -s run lint",
+    "lint": "prettier --check . && yarn workspaces -s run lint",
     "build": "yarn workspaces -s run build",
     "test": "yarn workspaces -s run test",
     "dev:burnr": "yarn workspace @substrate/burnr run dev",
@@ -42,17 +42,25 @@
     "deploy:ipfs:smoldot-browser-demo": "yarn workspace @substrate/smoldot-browser-demo run deploy:ipfs",
     "deploy": "./deploy.sh",
     "postinstall": "husky install",
-    "connect-tester": "yarn workspace @substrate/extension-provider run build && yarn workspace @substrate/connect run build && yarn run dev:smoldot-browser-demo"
+    "connect-tester": "yarn workspace @substrate/extension-provider run build && yarn workspace @substrate/connect run build && yarn run dev:smoldot-browser-demo",
+    "format": "prettier --write .",
+    "prepare": "husky install"
   },
   "devDependencies": {
     "@parcel/transformer-image": "2.0.0",
     "copyfiles": "^2.3.0",
-    "husky": "^5.0.8",
+    "eslint-config-prettier": "^8.3.0",
+    "husky": "^6.0.0",
+    "lint-staged": ">=10",
     "parcel": "2.0.0",
+    "prettier": "^2.4.1",
     "typedoc": "^0.21.0",
     "typescript": "^4.3.2"
   },
   "dependencies": {
     "@wasm-tool/wasm-pack-plugin": "^1.3.1"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,json,md}": "prettier --write"
   }
 }