JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3766
  • Score
    100M100P100Q125042F
  • License MIT

Eslint plugin to enforce a style of snake_case in your project, rather than just disabling camelcase.

Package Exports

  • eslint-plugin-snakecasejs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-snakecasejs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ESLint Plugin snakecasejs

What does it do

This is to enforce a style of snake_case in your project, rather than just disabling camelcase.

Features

  • [✓] Easy to use
  • [✓] MIT License
  • [✓] Compatible with last version of ESLint
  • [✓] Compatible with CamelCase (Class name or similar)
  • [✓] Whitelist array for methods or variables with camelCase syntax from other libraries/npm package.

Fast setup

  1. Add dependencies on package.json
"dependencies": {
    "eslint": "^4.19.1",
},
"devDependencies": {
    "eslint-plugin-snakecasejs": "^1.1.0",
}
  1. Create .eslintrc.json file with:
{
    "plugins": [
        "snakecasejs"
    ],
    "rules":
    {
        "snakecasejs/snakecasejs": "error",
        "snakecasejs/whitelist": []
    }
}
  1. If it works add a star ⭐ at this project ❤️
  2. If you want to help me: donate on paypal or become a backer on patreon.

NOTE: switch error to warn if you don't need snake_case as mandatory rules.

For advanced configuration see INSTALL.md.

Ignore words, variables, methods, class name (whitelist)

Add rules: "snakecasejs/whitelist": [] with array of variables or method with camelCase syntax.

Plugin ignore check on this words. Example: "snakecasejs/whitelist": ["externalPath","setNumber"]

License

MIT LICENSE

Copyright (c) 2018 Patryk Rzucidło (PTKDev)