Add Linting Software
License and Copyright Notice
By submitting this issue or commenting on this issue, or contributing any content to this issue, you certify under the Developer Certificate of Origin that the content you post may be licensed under GPLv3 (for code) or CC-BY-SA 4.0 International (for non-code content).
What is the goal or the problem, and why is it important?
- The goal of this issue is to implement a listing software at the root of PlaceOrderModule.
- After consulting with the other teams and taking our primary language (JavaScript) into mind, I am confident that we should implement ESLint (https://eslint.org) in our code. It is an industry standard, and relatively easy to work with / customize
How are you going to acheive the goal or solve the problem?
- This goal will be achieved by fully implementing ESLint, following their documentation here: https://eslint.org/docs/user-guide/getting-started
What will be produced as a result of this effort and where will it live on GitLab?
As a result of this:
- a new npm package will be installed
- our package and package lock will be automatically updated
- ESLint's configuration files will be installed
Give a justification of weight or due date.
This ticket should have a weight of 4 for just the install
Who will do it, and what will they do?
@mm413 will be responsible for this issue.
What was the outcome?
EsLint was configured with its configuration files. It's dependencies have been added to the node modules, and it's instructions have been added to the package and package lock. I created a shortcut script inside of the package.json for this package. Since we technically have 2 npm installs in the project (as of right now) the only way to run ESLint is from the command line while inside the Frontend directory OR inside the Backend directory. To run:
- be inside one of the directories mentioned above
- run
npm run lint
.
Note This only runs the linter for the current directory.