Update to @metamask/eslint-config@v6 (#21)

Gudahtt · web-flow · commit 179fe0f470d8 · 2021-06-01T15:52:34.000-02:30
Update to the new ESLint config, which includes `prettier`. The lint
scripts have been updated to match the `metamask-module-template`, and
`yarn lint:fix` has been run to make any required lint changes. The one
manual change required was to add an ESLint ignore comment in the test
where the `dist` directory is imported.

The ESLint config was updated to make TypeScript an override, which
allowed re-enabling a few rules that had been disabled.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -3,30 +3,12 @@ module.exports = {
   parserOptions: {
     ecmaVersion: 2017,
   },
-  extends: [
-    '@metamask/eslint-config',
-    '@metamask/eslint-config/config/nodejs',
-    '@metamask/eslint-config/config/typescript',
-  ],
-  plugins: [
-    'json',
-  ],
-  overrides: [{
-    files: [
-      '*.js',
-      '*.json',
-    ],
-    parserOptions: {
-      sourceType: 'script',
-    },
-    rules: {
-      '@typescript-eslint/no-require-imports': 'off',
-      '@typescript-eslint/no-var-requires': 'off',
+  extends: ['@metamask/eslint-config', '@metamask/eslint-config-nodejs'],
+  overrides: [
+    {
+      files: ['*.ts'],
+      extends: ['@metamask/eslint-config-typescript'],
     },
-  }],
-  ignorePatterns: [
-    '!eslintrc.js',
-    'dist/',
-    'node_modules/',
   ],
+  ignorePatterns: ['!eslintrc.js', 'dist/', 'node_modules/'],
 };
diff --git a/README.md b/README.md
@@ -6,21 +6,21 @@ Simple stream multiplexing for `objectMode`.
 
 ```js
 // create multiplexer
-const mux = new ObjMultiplex()
+const mux = new ObjMultiplex();
 
 // setup substreams
-const streamA = mux.createStream('hello')
-const streamB = mux.createStream('world')
+const streamA = mux.createStream("hello");
+const streamB = mux.createStream("world");
 
 // pipe over transport (and back)
-mux.pipe(transport).pipe(mux)
+mux.pipe(transport).pipe(mux);
 
 // send values over the substreams
-streamA.write({ thisIsAn: 'object' })
-streamA.write(123)
+streamA.write({ thisIsAn: "object" });
+streamA.write(123);
 
 // or pipe together normally
-streamB.pipe(evilAiBrain).pipe(streamB)
+streamB.pipe(evilAiBrain).pipe(streamB);
 ```
 
 ## Contributing
diff --git a/package.json b/package.json
@@ -17,8 +17,10 @@
     "setup": "yarn install && yarn allow-scripts",
     "build:clean": "rimraf dist && yarn build",
     "build": "tsc --project .",
-    "lint": "eslint . --ext ts,js,json",
-    "lint:fix": "yarn lint --fix",
+    "lint:eslint": "eslint . --cache --ext js,ts",
+    "lint:misc": "prettier '**/*.json' '**/*.md' '!CHANGELOG.md' '**/*.yml' --ignore-path .gitignore",
+    "lint": "yarn lint:eslint && yarn lint:misc --check",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write",
     "test": "yarn build && node test",
     "prepublishOnly": "yarn build:clean && yarn test"
   },
@@ -32,17 +34,21 @@
   "devDependencies": {
     "@lavamoat/allow-scripts": "^1.0.6",
     "@metamask/auto-changelog": "^2.3.0",
-    "@metamask/eslint-config": "^4.1.0",
+    "@metamask/eslint-config": "^6.0.0",
+    "@metamask/eslint-config-nodejs": "^6.0.0",
+    "@metamask/eslint-config-typescript": "^6.0.0",
     "@types/end-of-stream": "^1.4.0",
     "@types/node": "^14.14.9",
     "@types/once": "^1.4.0",
     "@types/readable-stream": "^2.3.9",
-    "@typescript-eslint/eslint-plugin": "^4.8.2",
-    "@typescript-eslint/parser": "^4.8.2",
-    "eslint": "^7.14.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-json": "^2.1.2",
+    "@typescript-eslint/eslint-plugin": "^4.26.0",
+    "@typescript-eslint/parser": "^4.26.0",
+    "eslint": "^7.27.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "prettier": "^2.3.0",
     "pump": "^1.0.2",
     "rimraf": "^3.0.2",
     "tape": "^4.8.0",
diff --git a/src/ObjectMultiplex.ts b/src/ObjectMultiplex.ts
@@ -11,7 +11,6 @@ interface Chunk {
 }
 
 export class ObjectMultiplex extends Duplex {
-
   private _substreams: Record<string, Substream | typeof IGNORE_SUBSTREAM>;
 
   constructor(opts: Record<string, unknown> = {}) {
@@ -39,7 +38,9 @@ export class ObjectMultiplex extends Duplex {
     }
 
     if (this._substreams[name]) {
-      throw new Error(`ObjectMultiplex - Substream for name "${name}" already exists`);
+      throw new Error(
+        `ObjectMultiplex - Substream for name "${name}" already exists`,
+      );
     }
 
     // create substream
@@ -61,7 +62,9 @@ export class ObjectMultiplex extends Duplex {
       throw new Error('ObjectMultiplex - name must not be empty');
     }
     if (this._substreams[name]) {
-      throw new Error(`ObjectMultiplex - Substream for name "${name}" already exists`);
+      throw new Error(
+        `ObjectMultiplex - Substream for name "${name}" already exists`,
+      );
     }
     // set
     this._substreams[name] = IGNORE_SUBSTREAM;
@@ -76,7 +79,6 @@ export class ObjectMultiplex extends Duplex {
     _encoding: BufferEncoding,
     callback: (error?: Error | null) => void,
   ): void {
-
     const { name, data } = chunk;
 
     if (!name) {
@@ -101,7 +103,10 @@ export class ObjectMultiplex extends Duplex {
 }
 
 // util
-function anyStreamEnd(stream: ObjectMultiplex, _cb: (error?: Error | null) => void) {
+function anyStreamEnd(
+  stream: ObjectMultiplex,
+  _cb: (error?: Error | null) => void,
+) {
   const cb = once(_cb);
   eos(stream, { readable: false }, cb);
   eos(stream, { writable: false }, cb);
diff --git a/src/Substream.ts b/src/Substream.ts
@@ -7,7 +7,6 @@ export interface SubstreamOptions {
 }
 
 export class Substream extends Duplex {
-
   private readonly _parent: ObjectMultiplex;
 
   private readonly _name: string;
diff --git a/test/index.js b/test/index.js
@@ -2,15 +2,13 @@ const test = require('tape');
 const pump = require('pump');
 const { PassThrough, Transform } = require('readable-stream');
 const endOfStream = require('end-of-stream');
+// eslint-disable-next-line import/no-unresolved
 const ObjMultiplex = require('../dist');
 
 test('basic - string', (t) => {
   t.plan(2);
 
-  const {
-    inTransport,
-    inStream, outStream,
-  } = basicTestSetup();
+  const { inTransport, inStream, outStream } = basicTestSetup();
   bufferToEnd(outStream, (err, results) => {
     t.error(err, 'should not error');
     t.deepEqual(results, ['haay', 'wuurl'], 'results should match');
@@ -28,13 +26,14 @@ test('basic - string', (t) => {
 test('basic - obj', (t) => {
   t.plan(2);
 
-  const {
-    inTransport,
-    inStream, outStream,
-  } = basicTestSetup();
+  const { inTransport, inStream, outStream } = basicTestSetup();
   bufferToEnd(outStream, (err, results) => {
     t.error(err, 'should not error');
-    t.deepEqual(results, [{ message: 'haay' }, { message: 'wuurl' }], 'results should match');
+    t.deepEqual(
+      results,
+      [{ message: 'haay' }, { message: 'wuurl' }],
+      'results should match',
+    );
     t.end();
   });
   // pass in messages
@@ -48,10 +47,7 @@ test('basic - obj', (t) => {
 test('roundtrip', (t) => {
   t.plan(2);
 
-  const {
-    outTransport,
-    inStream, outStream,
-  } = basicTestSetup();
+  const { outTransport, inStream, outStream } = basicTestSetup();
   const doubler = new Transform({
     objectMode: true,
     transform(chunk, _end, callback) {
@@ -60,11 +56,7 @@ test('roundtrip', (t) => {
     },
   });
 
-  pump(
-    outStream,
-    doubler,
-    outStream,
-  );
+  pump(outStream, doubler, outStream);
 
   bufferToEnd(inStream, (err, results) => {
     t.error(err, 'should not error');
@@ -104,7 +96,6 @@ test('error on createStream if ended', (t) => {
 // util
 
 function basicTestSetup() {
-
   // setup multiplex and Transport
   const inMux = new ObjMultiplex();
   const outMux = new ObjMultiplex();
@@ -115,20 +106,16 @@ function basicTestSetup() {
   const inStream = inMux.createStream('hello');
   const outStream = outMux.createStream('hello');
 
-  pump(
-    inMux,
+  pump(inMux, inTransport, outMux, outTransport, inMux);
+
+  return {
     inTransport,
-    outMux,
     outTransport,
     inMux,
-  );
-
-  return {
-    inTransport, outTransport,
-    inMux, outMux,
-    inStream, outStream,
+    outMux,
+    inStream,
+    outStream,
   };
-
 }
 
 function bufferToEnd(stream, callback) {
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,22 +1,15 @@
-{
-    "compilerOptions": {
-      "declaration": true,
-      "esModuleInterop": true,
-      "module": "CommonJS",
-      "moduleResolution": "Node",
-      "sourceMap": true,
-      "strict": true,
-      "target": "ES2017",
-      "typeRoots": [
-        "./node_modules/@types",
-      ],
-      "outDir": "dist"
-    },
-    "include": [
-      "src/**/*.ts"
-    ],
-    "exclude": [
-      "node_modules",
-      "dist"
-    ]
-  }
+{
+  "compilerOptions": {
+    "declaration": true,
+    "esModuleInterop": true,
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2017",
+    "typeRoots": ["./node_modules/@types"],
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@ export interface SubstreamOptions {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`export class Substream extends Duplex {`
`10`		`-`
`11`	`10`	`private readonly _parent: ObjectMultiplex;`
`12`	`11`
`13`	`12`	`private readonly _name: string;`