{"id":18523695,"url":"https://github.com/sonicdoe/brave-mouse","last_synced_at":"2025-10-12T13:33:16.388Z","repository":{"id":26300488,"uuid":"29748376","full_name":"sonicdoe/brave-mouse","owner":"sonicdoe","description":"[Unmaintained] Validate your code against your EditorConfig.","archived":false,"fork":false,"pushed_at":"2015-07-26T12:16:59.000Z","size":262,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-09-18T18:26:30.086Z","etag":null,"topics":["cli","coffeescript","editorconfig","lint","linter","nodejs","semver"],"latest_commit_sha":null,"homepage":"","language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sonicdoe.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-01-23T19:10:16.000Z","updated_at":"2025-07-19T00:19:04.000Z","dependencies_parsed_at":"2022-08-27T09:10:28.906Z","dependency_job_id":null,"html_url":"https://github.com/sonicdoe/brave-mouse","commit_stats":null,"previous_names":["sonichedgehog/brave-mouse"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/sonicdoe/brave-mouse","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonicdoe%2Fbrave-mouse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonicdoe%2Fbrave-mouse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonicdoe%2Fbrave-mouse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonicdoe%2Fbrave-mouse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sonicdoe","download_url":"https://codeload.github.com/sonicdoe/brave-mouse/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonicdoe%2Fbrave-mouse/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279011445,"owners_count":26084947,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cli","coffeescript","editorconfig","lint","linter","nodejs","semver"],"created_at":"2024-11-06T17:37:10.784Z","updated_at":"2025-10-12T13:33:16.368Z","avatar_url":"https://github.com/sonicdoe.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# brave-mouse\n\n[![Node.js package](http://img.shields.io/npm/v/brave-mouse.svg)](https://www.npmjs.com/package/brave-mouse)\n[![Linux Build Status](http://img.shields.io/travis/SonicHedgehog/brave-mouse/develop.svg)](https://travis-ci.org/SonicHedgehog/brave-mouse)\n[![Windows Build Status](http://img.shields.io/appveyor/ci/SonicHedgehog/brave-mouse.svg)](https://ci.appveyor.com/project/SonicHedgehog/brave-mouse)\n\nValidate your code against your EditorConfig.\n\n## Command line interface\n\nInstall brave-mouse using:\n\n```shell\n$ npm install brave-mouse -g\n```\n\nValidate files like this:\n\n```shell\n$ brave-mouse .travis.yml README.md package.json\n```\n\nbrave-mouse automatically uses the appropiate `.editorconfig`.\n\n### Exit codes\n\nbrave-mouse will exit abruptly (i.e. subsequent files won’t be processed) with an exit code of `1` if it encounters an error such as being unable to read a file.\n\nbrave-mouse will exit with an exit code of `2` if all files could be processed but not all files are valid according to your `.editorconfig`.\n\nIf all files could be processed successfully and are valid, brave-mouse exits with an exit code of `0`.\n\n## Programmatic usage\n\nInstall brave-mouse using:\n\n```shell\n$ npm install brave-mouse\n```\n\nUse it like this:\n\n```js\nvar braveMouse = require('brave-mouse');\n\nbraveMouse.validate('your-file.js', function(err, results) {\n  // `err` will only be set for actual errors, e.g. it will\n  // not be set if your file isn’t valid.\n  if(err) throw err;\n  \n  if(results === true) {\n    // Your file is valid\n  } else {\n    console.log(results);\n    // {\n    //   \"indent_style\": {\n    //     \"expected\": \"tab\"\n    //     \"is\": \"space\"\n    //   }\n    // }\n  }\n});\n```\n\n## Supported EditorConfig properties\n\nSee [EditorConfig’s wiki](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties) for a complete list of properties.\n\nbrave-mouse currently supports validating the following properties:\n\n- `indent_style`\n- `indent_size`\n- `end_of_line` (only `lf` and `crlf` are supported)\n- `trim_trailing_whitespace`\n- `insert_final_newline`\n- `max_line_length`\n\n`tab_width` can’t be validated as it only applies to editors.\n\n## Running tests\n\nFirst, install all dependencies:\n\n```shell\n$ npm install -g grunt-cli\n$ npm install\n```\n\nThen run the tests:\n\n```shell\n$ grunt test\n```\n\n## Release History\n\nSee [CHANGELOG.md](./CHANGELOG.md).\n\n## License\n\nbrave-mouse is licensed under the BSD 2-clause license, subject to additional terms. See [LICENSE](./LICENSE) for the full license text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonicdoe%2Fbrave-mouse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsonicdoe%2Fbrave-mouse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonicdoe%2Fbrave-mouse/lists"}