Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce eslint and prettier #7

Open
battila7 opened this issue Oct 6, 2020 · 0 comments
Open

Introduce eslint and prettier #7

battila7 opened this issue Oct 6, 2020 · 0 comments
Labels
🎉 Hacktoberfest 🍻 Hacktoberfest-friendly issues, great for newcomers.

Comments

@battila7
Copy link
Collaborator

battila7 commented Oct 6, 2020

Brief

Currently, cryptid-js has absolutely no linting or formatting rules: you can freely write code any way you want, commit it and push it. No restrictions, no checks. You can use tabs in one file and spaces in another (the horror! 😢).

To improve upon this situation, we should set up a linting and formatting toolchain using eslint (https://eslint.org/) and prettier (https://prettier.io/).

Task

  • Create the lint and lint:fix scripts in the package.json.
    • Obviously, lint:fix should run the linter with the --fix flag.
  • Configure eslint and prettier.
    • Please use separeate files, do not pollute the package.json with this configuration.
    • Please be aware, that cryptid-js is isomorphic: clients can use it on both the client-side and the server-side. The linting configuration should be aware of this scenario.

Settings for Prettier

Please use the following settings for prettier:

{
    "singleQuote": true,
    "printWidth": 120,
    "semi": false
}
@battila7 battila7 added the 🎉 Hacktoberfest 🍻 Hacktoberfest-friendly issues, great for newcomers. label Oct 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎉 Hacktoberfest 🍻 Hacktoberfest-friendly issues, great for newcomers.
Projects
None yet
Development

No branches or pull requests

1 participant