{"id":13561900,"url":"https://github.com/stil4m/elm-analyse","last_synced_at":"2025-05-15T08:05:15.378Z","repository":{"id":17706689,"uuid":"79642135","full_name":"stil4m/elm-analyse","owner":"stil4m","description":"A tool that allows you to analyse your Elm code, identify deficiencies and apply best practices.","archived":false,"fork":false,"pushed_at":"2023-04-19T09:20:42.000Z","size":6701,"stargazers_count":414,"open_issues_count":75,"forks_count":56,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-14T13:07:29.289Z","etag":null,"topics":["analysis","ast","elm","elm-lang","linter"],"latest_commit_sha":null,"homepage":"https://stil4m.github.io/elm-analyse/","language":"Elm","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stil4m.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-01-21T11:37:15.000Z","updated_at":"2025-03-04T10:15:40.000Z","dependencies_parsed_at":"2024-01-05T22:00:52.060Z","dependency_job_id":"cf4d789c-3e05-4900-ba2d-9a64fdf71ea0","html_url":"https://github.com/stil4m/elm-analyse","commit_stats":{"total_commits":697,"total_committers":37,"mean_commits":18.83783783783784,"dds":0.4246771879483501,"last_synced_commit":"701b8b4013a4f057b9382d368e42adc6fe08e14e"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stil4m%2Felm-analyse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stil4m%2Felm-analyse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stil4m%2Felm-analyse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stil4m%2Felm-analyse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stil4m","download_url":"https://codeload.github.com/stil4m/elm-analyse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254301426,"owners_count":22047902,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analysis","ast","elm","elm-lang","linter"],"created_at":"2024-08-01T13:01:02.386Z","updated_at":"2025-05-15T08:05:15.312Z","avatar_url":"https://github.com/stil4m.png","language":"Elm","funding_links":[],"categories":["Elm","Tools","Static analysis"],"sub_categories":["Outdated Boilerplates"],"readme":"# [Elm Analyse](http://stil4m.github.io/elm-analyse)\n\nA tool that allows you to analyse your [Elm](http://elm-lang.org/) code, identify deficiencies and apply best practices.\n\n\u003cimg src=\"https://ci.appveyor.com/api/projects/status/github/stil4m/elm-analyse?branch=master\u0026retina=true\" height=\"24\"\u003e\n\u003cimg src=\"https://travis-ci.org/stil4m/elm-analyse.svg?branch=master\" height=\"24\"\u003e\n\u003cimg src=\"https://badge.fury.io/js/elm-analyse.svg\" height=\"24\"\u003e\n\n## Preview\n\n\u003cimg src=\"https://github.com/stil4m/elm-analyse/raw/master/images/dashboard.png\"\u003e\n\u003cimg src=\"https://github.com/stil4m/elm-analyse/raw/master/images/single-message.png\"\u003e\n\u003cimg src=\"https://github.com/stil4m/elm-analyse/raw/master/images/terminal-output.png\"\u003e\n\u003cimg src=\"https://github.com/stil4m/elm-analyse/raw/master/images/package-dependencies.png\"\u003e\n\n---\n## Usage\n\n### Prerequisites\n\nThe following binaries should be available on the path:\n\n```\nnode \u003e=8\nelm  0.19.x\nelm-format (a version that is compatible with the source code you wish to analyse)\n```\n\n### Install\n\n```\nnpm install -g elm-analyse\n```\n\nor if using `yarn`:\n\n```\nyarn global add elm-analyse\n```\n\n### Run\n\nChange to the directory of Elm project you want to analyse and run `elm-analyse`.\n\nAdd the `-s` option for server mode. This will allow you to view results in your browser. To change the port use `-p XXXX`\n\n### CLI Options\n\n| Option | Description |\n| ------ | ----------- |\n| `--help or -h`          | Print the help output. |\n| `--serve or -s`         | Enable server mode. Disabled by default. |\n| `--port or -p`          | The port on which the server should listen. Defaults to 3000 (`--port=3000`). |\n| `--open or -o`          | Open default browser when server goes live. |\n| `--elm-format-path`     | Path to elm-format. Defaults to `elm-format`. |\n| `--version` or `-v`     | Print version of software. |\n| `--format`              | Output format for CLI. Defaults to \"human\". Valid values are either \"human\" or \"json\". |\n\n---\n\n## Supported Checks\n\nAll supported checks can be found in the [check documentation](https://stil4m.github.io/elm-analyse/#/messages).\n\n---\n\n## Analysis Configuration\n\nChecks can be enable or configured based on your preferences. For this see the [Configuration Docs](https://stil4m.github.io/elm-analyse/#/configuration).\n\n---\n\n## Issues\n\nIf you have feature ideas or checks that you wish to see, please create an issue.\nPlease check that you do not create duplicate issues or a check for which we [already have a report](https://github.com/stil4m/elm-analyse/issues/10).\n\n## Contributing\n\nPlease see [the docs](https://stil4m.github.io/elm-analyse/#/contributing)\n---\n\n## Library Setup\n\nThe library is divided into the following main modules:\n\n* `Analyser`: The `main` file that bootstraps the analysis and maintains the core state.\n* `ASTUtil.*`: Utility functions for fact extraction on the AST.\n* `Analyser.Checks.*`: All the checks that are performed.\n* `Analyser.Fixes.*`: All the fixes that can be performed.\n* `Analyser.Messages.*`: All messages that can be produced and the supporting functions.\n* `Client.*`: Front-end code for running in 'server' mode.\n\nThe code that represents the Elm syntax and the parsing is supported by the [elm-syntax](https://github.com/stil4m/elm-syntax) package.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstil4m%2Felm-analyse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstil4m%2Felm-analyse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstil4m%2Felm-analyse/lists"}