Prettier - ESLint (#531)

* eslint and prettier

* working on eslint

* working on eslint

* fixed travis

* rolled back md changes

* Added unit tests

* improved NamespaceHttp

Author: fboucquez

.eslintrc.js

@@ -0,0 +1,22 @@
+module.exports = {
+    parser: "@typescript-eslint/parser", // Specifies the ESLint parser
+    extends: [
+        "plugin:@typescript-eslint/recommended", // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+        "prettier/@typescript-eslint", // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
+        "plugin:prettier/recommended" // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+    ],
+    parserOptions: {
+        ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
+        sourceType: "module" // Allows for the use of imports
+    },
+    rules: {
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/interface-name-prefix": "off",
+        "@typescript-eslint/camelcase": "off",
+        // TODO fix all the warnings
+        "@typescript-eslint/explicit-function-return-type": "warn",
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-inferrable-types": "warn",
+        "@typescript-eslint/no-use-before-define": "warn"
+    }
+};

.github/issue_template.md

@@ -2,4 +2,4 @@
 
 2. Steps to reproduce the problem.
 
-3. Specifications like the version of the project, operating system, or hardware.
+3. Specifications like the version of the project, operating system, or hardware.

.prettierrc.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2020 NEM
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module.exports = {
+    semi: true,
+    trailingComma: "all",
+    singleQuote: true,
+    printWidth: 140,
+    tabWidth: 4
+};

.travis.yml

@@ -1,36 +1,39 @@
 language: node_js
 node_js:
-  - "8"
-  - "9"
-  - "10"
+  - '8'
+  - '9'
+  - '10'
+  - '12'
 cache:
   directories:
-    - "node_modules"
+    - 'node_modules'
+    - .eslintcache
 before_script:
   - npm run build
+  - if [ "$TRAVIS_NODE_VERSION" = "10" ] || [ "$TRAVIS_NODE_VERSION" = "12" ]; then npm run lint; fi
 script:
   - npm run test:cov
   - npm install --global typedoc typescript
   - CURRENT_VERSION=$(npm run version --silent)
   - typedoc --out "ts-docs/$CURRENT_VERSION" src
   - touch ./ts-docs/.nojekyll
-  - if [ "$TRAVIS_NODE_VERSION" = "8" ]; then npm run coveralls-report; fi
+  - if [ "$TRAVIS_NODE_VERSION" = "10" ]; then npm run coveralls-report; fi
 deploy:
   - provider: script
     skip_cleanup: true
     script: /bin/sh travis/github-pages.sh
     on:
       branch: master
-      node_js: "9"
+      node_js: '12'
   - provider: script
     skip_cleanup: true
     script: /bin/sh travis/uploadArchives.sh
     on:
       branch: master
-      node_js: "8"
+      node_js: '10'
   - provider: script
     skip_cleanup: true
     script: /bin/sh travis/release.sh
     on:
       branch: $RELEASE_BRANCH
-      node_js: "8"
+      node_js: '10'

e2e/infrastructure/AccountHttp.spec.ts

@@ -120,7 +120,6 @@ describe('AccountHttp', () => {
     });
 
     describe('Setup test AddressAlias', () => {
-
         it('Announce addressAliasTransaction', () => {
             const addressAliasTransaction = AddressAliasTransaction.create(
                 Deadline.create(),
@@ -136,29 +135,29 @@ describe('AccountHttp', () => {
     });
 
     describe('Setup test multisig account', () => {
-
         it('Announce MultisigAccountModificationTransaction', () => {
             const modifyMultisigAccountTransaction = MultisigAccountModificationTransaction.create(
                 Deadline.create(),
                 2,
                 1,
-                [
-                    cosignAccount1.publicAccount,
-                    cosignAccount2.publicAccount,
-                    cosignAccount3.publicAccount,
-                ],
+                [cosignAccount1.publicAccount, cosignAccount2.publicAccount, cosignAccount3.publicAccount],
                 [],
                 networkType,
                 helper.maxFee,
             );
 
-            const aggregateTransaction = AggregateTransaction.createComplete(Deadline.create(),
+            const aggregateTransaction = AggregateTransaction.createComplete(
+                Deadline.create(),
                 [modifyMultisigAccountTransaction.toAggregate(multisigAccount.publicAccount)],
                 networkType,
                 [],
-                helper.maxFee);
-            const signedTransaction = aggregateTransaction
-            .signTransactionWithCosignatories(multisigAccount, [cosignAccount1, cosignAccount2, cosignAccount3], generationHash);
+                helper.maxFee,
+            );
+            const signedTransaction = aggregateTransaction.signTransactionWithCosignatories(
+                multisigAccount,
+                [cosignAccount1, cosignAccount2, cosignAccount3],
+                generationHash,
+            );
 
             return helper.announce(signedTransaction);
         });
@@ -186,8 +185,9 @@ describe('AccountHttp', () => {
 
     describe('getMultisigAccountGraphInfo', () => {
         it('should call getMultisigAccountGraphInfo successfully', async () => {
-            const multisigAccountGraphInfo =
-                await multisigRepository.getMultisigAccountGraphInfo(multisigAccount.publicAccount.address).toPromise();
+            const multisigAccountGraphInfo = await multisigRepository
+                .getMultisigAccountGraphInfo(multisigAccount.publicAccount.address)
+                .toPromise();
             expect(multisigAccountGraphInfo.multisigAccounts.get(0)![0].account.publicKey).to.be.equal(multisigAccount.publicKey);
         });
     });
@@ -213,26 +213,37 @@ describe('AccountHttp', () => {
 
     describe('transactions', () => {
         it('should not return accounts when account does not exist', () => {
-            return accountRepository.getAccountInfo(Account.generateNewAccount(networkType).address).toPromise().then(() => {
-                return Promise.reject('should fail!');
-            }, (err) => {
-                const error = JSON.parse(err.message);
-                expect(error.statusCode).to.be.eq(404);
-                expect(error.errorDetails.statusMessage).to.be.eq('Not Found');
-                return Promise.resolve();
-            });
+            return accountRepository
+                .getAccountInfo(Account.generateNewAccount(networkType).address)
+                .toPromise()
+                .then(
+                    () => {
+                        return Promise.reject('should fail!');
+                    },
+                    (err) => {
+                        const error = JSON.parse(err.message);
+                        expect(error.statusCode).to.be.eq(404);
+                        expect(error.errorDetails.statusMessage).to.be.eq('Not Found');
+                        return Promise.resolve();
+                    },
+                );
         });
     });
 
     describe('transactions', () => {
         it('should call transactions successfully by type', async () => {
-            const transactions = await accountRepository.getAccountTransactions(
-                publicAccount.address, new QueryParams(), new TransactionFilter({
-                    types: [TransactionType.TRANSFER, TransactionType.AGGREGATE_COMPLETE],
-                })).toPromise();
+            const transactions = await accountRepository
+                .getAccountTransactions(
+                    publicAccount.address,
+                    new QueryParams(),
+                    new TransactionFilter({
+                        types: [TransactionType.TRANSFER, TransactionType.AGGREGATE_COMPLETE],
+                    }),
+                )
+                .toPromise();
             expect(transactions.length).to.be.greaterThan(0);
             transactions.forEach((t) => {
-                expect((t.type === TransactionType.TRANSFER || t.type === TransactionType.AGGREGATE_COMPLETE)).to.be.eq(true);
+                expect(t.type === TransactionType.TRANSFER || t.type === TransactionType.AGGREGATE_COMPLETE).to.be.eq(true);
             });
         });
     });
@@ -285,8 +296,7 @@ describe('AccountHttp', () => {
                 -1,
                 0,
                 [],
-                [cosignAccount1.publicAccount,
-                ],
+                [cosignAccount1.publicAccount],
                 networkType,
                 helper.maxFee,
             );
@@ -295,9 +305,7 @@ describe('AccountHttp', () => {
                 0,
                 0,
                 [],
-                [
-                    cosignAccount2.publicAccount,
-                ],
+                [cosignAccount2.publicAccount],
                 networkType,
                 helper.maxFee,
             );
@@ -307,21 +315,27 @@ describe('AccountHttp', () => {
                 -1,
                 -1,
                 [],
-                [
-                    cosignAccount3.publicAccount,
-                ],
+                [cosignAccount3.publicAccount],
                 networkType,
                 helper.maxFee,
             );
 
-            const aggregateTransaction = AggregateTransaction.createComplete(Deadline.create(),
-                [removeCosigner1.toAggregate(multisigAccount.publicAccount),
+            const aggregateTransaction = AggregateTransaction.createComplete(
+                Deadline.create(),
+                [
+                    removeCosigner1.toAggregate(multisigAccount.publicAccount),
                     removeCosigner2.toAggregate(multisigAccount.publicAccount),
-                    removeCosigner3.toAggregate(multisigAccount.publicAccount)],
+                    removeCosigner3.toAggregate(multisigAccount.publicAccount),
+                ],
                 networkType,
-                [], helper.maxFee);
-            const signedTransaction = aggregateTransaction
-            .signTransactionWithCosignatories(cosignAccount1, [cosignAccount2, cosignAccount3], generationHash);
+                [],
+                helper.maxFee,
+            );
+            const signedTransaction = aggregateTransaction.signTransactionWithCosignatories(
+                cosignAccount1,
+                [cosignAccount2, cosignAccount3],
+                generationHash,
+            );
             return helper.announce(signedTransaction);
         });
     });

e2e/infrastructure/BlockHttp.spec.ts

@@ -66,7 +66,6 @@ describe('BlockHttp', () => {
      */
 
     describe('Setup Test Data', () => {
-
         it('Announce TransferTransaction', () => {
             const transferTransaction = TransferTransaction.create(
                 Deadline.create(),
@@ -110,8 +109,9 @@ describe('BlockHttp', () => {
         });
 
         it('should return block transactions data given height with paginated transactionId', async () => {
-            const transactions = await blockRepository.getBlockTransactions(UInt64.fromUint(1),
-                new QueryParams({ pageSize: 10, id: nextId})).toPromise();
+            const transactions = await blockRepository
+                .getBlockTransactions(UInt64.fromUint(1), new QueryParams({ pageSize: 10, id: nextId }))
+                .toPromise();
             expect(transactions[0].transactionInfo!.id).to.be.equal(firstId);
             expect(transactions.length).to.be.greaterThan(0);
         });
@@ -125,24 +125,32 @@ describe('BlockHttp', () => {
     });
     describe('getMerkleReceipts', () => {
         it('should return Merkle Receipts', async () => {
-            const merkleReceipts = await receiptRepository.getBlockReceipts(chainHeight).pipe(
-                mergeMap((_) => {
-                    return receiptRepository.getMerkleReceipts(chainHeight, _.transactionStatements[0].generateHash());
-                })).toPromise();
+            const merkleReceipts = await receiptRepository
+                .getBlockReceipts(chainHeight)
+                .pipe(
+                    mergeMap((_) => {
+                        return receiptRepository.getMerkleReceipts(chainHeight, _.transactionStatements[0].generateHash());
+                    }),
+                )
+                .toPromise();
             expect(merkleReceipts.merklePath).not.to.be.null;
         });
     });
     describe('getMerkleTransaction', () => {
         it('should return Merkle Transaction', async () => {
-            const merkleTransactionss = await blockRepository.getBlockTransactions(chainHeight).pipe(
-                mergeMap((_) => {
-                    const hash = (_[0].transactionInfo as TransactionInfo).hash;
-                    if (hash) {
-                        return blockRepository.getMerkleTransaction(chainHeight, hash);
-                    }
-                    // If reaching this line, something is not right
-                    throw new Error('Tansacation hash is undefined');
-                })).toPromise();
+            const merkleTransactionss = await blockRepository
+                .getBlockTransactions(chainHeight)
+                .pipe(
+                    mergeMap((_) => {
+                        const hash = (_[0].transactionInfo as TransactionInfo).hash;
+                        if (hash) {
+                            return blockRepository.getMerkleTransaction(chainHeight, hash);
+                        }
+                        // If reaching this line, something is not right
+                        throw new Error('Tansacation hash is undefined');
+                    }),
+                )
+                .toPromise();
             expect(merkleTransactionss.merklePath).not.to.be.null;
         });
     });