https://github.com/sparksp/elm-review-camelcase

elm-review rule to ensure your code uses camelCase
https://github.com/sparksp/elm-review-camelcase

camelcase elm elm-review review-camelcase

Last synced: about 2 months ago
JSON representation

elm-review rule to ensure your code uses camelCase

• Host: GitHub
• URL: https://github.com/sparksp/elm-review-camelcase
• Owner: sparksp
• License: mit
• Created: 2020-04-29T17:20:36.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-11T06:41:27.000Z (5 months ago)
• Last Synced: 2024-08-11T07:39:28.535Z (5 months ago)
• Topics: camelcase, elm, elm-review, review-camelcase
• Language: Elm
• Homepage: https://package.elm-lang.org/packages/sparksp/elm-review-camelcase/latest/
• Size: 803 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# elm-review-camelcase

![elm package](https://img.shields.io/elm-package/v/sparksp/elm-review-camelcase)

![elm-review 2.3](https://img.shields.io/badge/elm--review-2.3-%231293D8)

![elm 0.19](https://img.shields.io/badge/elm-0.19-%231293D8)

![Tests](https://github.com/sparksp/elm-review-camelcase/workflows/Tests/badge.svg)

Provides an [`elm-review`](https://package.elm-lang.org/packages/jfmengels/elm-review/latest/) rule to ensure your code uses only camelCase and PascalCase for variables, constants and other declarations.

## Provided rule

- [`UseCamelCase`](https://package.elm-lang.org/packages/sparksp/elm-review-camelcase/1.1.0/UseCamelCase) - Reports code written in the wrong case style.

## Example configuration

```elm

module ReviewConfig exposing (config)

import Review.Rule exposing (Rule)

import UseCamelCase

config : List Rule

config =

    [ UseCamelCase.rule UseCamelCase.default

    ]

```

Detailed [configuration documentation](https://package.elm-lang.org/packages/sparksp/elm-review-camelcase/1.1.0/UseCamelCase#configuration) is provided with the rule.

## Try it out

You can try the example configuration above out by running the following command:

```bash

elm-review --template sparksp/elm-review-camelcase/example

```