Linting, dependency management and code formatting

Question

Linting, dependency management and code formatting

Closed this issue 4 years ago · 12 comments

Rn, the extension doesn't have any dependency management, linting or code formatting. I propose that we:

Initialize the extension as an npm package
Add eslint with the airbnb config, to maintain code consistency
Set up a githook using husky to automatically lint and format code as soon as it's staged.

Answer 1 · 2020-09-25T14:38:25.000Z

Add prettier too. Not sure how well prettier plays with husky though. You might have to the git index stuff we did previously.

Answer 2 · 2020-09-25T15:11:01.000Z

Yep we should add prettier too. I just configured husky to work with prettier and eslint. It was pretty straightforward.

Answer 3 · 2020-09-25T15:55:21.000Z

@AdaephonBen, remember the git index issue we previously had? Can you make sure that isn't the case?

Answer 4 · 2020-10-05T08:13:32.000Z

@TarunNoone, please let me know before you setup ESLint and more importantly, first run. There are a couple of minor Git issues that popup and I don't want you guys to be affected by them down the line.

Answer 5 · 2020-10-05T14:07:40.000Z

Added Husky, ESLint Airbnb Config and Prettier. Pushed to linting_v1 branch. Pre-Commit errors have not been fixed.

Answer 6 · 2020-10-05T14:17:11.000Z

Pre-commit errors?

…

On Mon, Oct 5, 2020, 19:37 Tarun Noone ***@***.***> wrote: Added Husky, ESLint Airbnb Config and Prettier. Pushed to linting_v1 branch. Pre-Commit errors have not been fixed. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#18 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AINGXXMS44VY5LTGKXVNBPLSJHHLZANCNFSM4RZN2FMQ> .

-- Disclaimer:- The information contained in this electronic message and any attachments to this message are intended for the exclusive use of the addressee(s) and may contain proprietary, confidential or privileged information. If you are not the intended recipient, you should not disseminate, distribute or copy this email. Please notify the sender immediately and destroy all copies of this message and any attachments. The views expressed in this E-mail message (including the enclosure/(s) or attachment/(s) if any) are those of the individual sender, except where the sender expressly, and with authority, states them to be the views of IIT Hyderabad. Before opening any mail and attachments please check them for viruses, malware, and the sender email address is indeed from IITH domain. IITH does not accept any liability for malware infected mails.

Answer 7 · 2020-10-05T15:01:34.000Z

ESLint and Prettier errors. There are quite a few of those.

Answer 8 · 2020-10-07T06:29:48.000Z

I've fixed a few eslint errors. #19 took care of the rest. I've added firebase and html2pdf as NPM modules and removed the static imports. There are only 2 errors left.

We'll have to test this before merging to master, but the AIMS course registration page is not active currently. If anyone has a saved older version, please push it to the branch.

We could even have tests based on this saved copy @npalladium

We can also consider adding JQuery as an NPM module and completely dumping our /js folder. Right now, ESLint is not throwing JQuery errors since we've added it as an environment variable to our eslint config.

Answer 9 · 2020-10-07T08:15:42.000Z

All ESLint errors have been resolved.

Answer 10 · 2020-10-07T08:51:06.000Z

@TarunNoone Cool. Apparently, no one has a copy of the AIMS registration page, so we'll have to wait a few days for the Add/Drop period to start. We can close this issue and merge back to master then.

Answer 11 · 2020-10-14T17:43:52.000Z

Initialized as npm package; Code fixed to conform to ESLint Airbnb Config; Lint-staged and Husky set up.

Answer 12 · 2020-10-15T06:03:47.000Z

Good work on this, @TarunNoone