@ngirl/eslint-config-ngirl

This package provides the Naughty Girl project's .eslintrc as an extensible shared configuration across all of the project modules.

Usage

yarn add @ngirl/eslint-config-ngirl@latest -D

1. The correct peer dependency versions listed in this package must be installed in your project's directory.

1a. Manually install the list of peer dependencies given when querying the npm registry.

npm info @ngirl/eslint-config-ngirl peerDependencies

1b. Use a npm package, such as install-peerdeps that assists in installing peer dependencies.

npm install -g install-peerdeps
install-peerdeps --yarn --only-peers --dev @ngirl/eslint-config-ngirl

1c. Or, via npx to avoid permanently installing install-peerdeps.

npx install-peerdeps --yarn --only-peers --dev @ngirl/eslint-config-ngirl

1d. Or, use the provided helper script to mimic the above process.

DRY_RUN=1 bin/install-peerdeps.js

1. Add "extends": "@ngirl/eslint-config-ngirl" to your project's .eslintrc config.

Cheat Sheet

/* eslint no-undef: ['off'] */
/* eslint no-undef: ['error'] */
/* eslint-disable no-alert */
/* eslint-disable no-alert, no-console */
/* eslint-enable no-alert, no-console */
/* eslint-disable */
/* eslint-enable */
// eslint-disable-line
// eslint-disable-next-line

References

• https://github.com/eslint/eslint

  • http://eslint.org/docs/rules/

• https://gist.github.com/cletusw/e01a85e399ab563b1236

  • https://gist.githubusercontent.com/cletusw/e01a85e399ab563b1236/raw/1d10c27a505f0fba1ea9bfd60313f00ea57639b1/.eslintrc

• https://github.com/benmosher/eslint-plugin-import

  • https://github.com/benmosher/eslint-plugin-import/tree/master/docs/rules

• https://github.com/nodesecurity/eslint-plugin-security

  • https://github.com/nodesecurity/eslint-plugin-security/tree/master/rules

Projects Using @ngirl/eslint-config-ngirl

• @ngirl/naughty.im
• @ngirl/api.naughty.im
• @ngirl/cdn.naughty.im
• @ngirl/db-models
• @ngirl/nom-utils