@geekjuice/style

style

personal style guide and configuration manager

features include:

• minimal dependency management. package come pre-bundled with:
  • eslint
  • prettier
  • husky
  • lint-staged
• sensible configurations. consistent styles and process that just work™
• javascript and typescript. configured to handle both
• opinionated. because personal :man_shrugging:

getting started

to start the guided setup process:

❯ npx @geekjuice/style install

commands

install

this command is used to initially setup your project by:

• updating your package.json to include the necessary dependencies and scripts
• adding (or replacing) the following configuration files:
  • .eslintrc.js
  • .prettierrc.js
  • .huskyrc.js
  • .lintstagedrc.js

the command can be re-run to set your project up again or pick up updates.

check

used to check files for linting and formatting issues without actually making changes. underneath the hood this command is running the following in parallel:

• eslint against all javascript and typescript files unless files specified
• prettier --check against many supported file types unless files specified

fix

similar to check, but will attempt to fix problems if possible. underneath the hood this command is running the following in serial:

• eslint --fix against all javascript and typescript files unless files specified
• prettier against many supported file types unless files specified

license

mit - copyright © nicholas hwang