{"id":21085847,"url":"https://github.com/zbeekman/editorconfig-action","last_synced_at":"2025-09-25T20:27:13.527Z","repository":{"id":49062751,"uuid":"194446536","full_name":"zbeekman/EditorConfig-Action","owner":"zbeekman","description":"🔎A GitHub Action to check, enforce \u0026 fix EditorConfig style violations","archived":false,"fork":false,"pushed_at":"2024-04-07T12:37:43.000Z","size":519,"stargazers_count":46,"open_issues_count":12,"forks_count":15,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-27T11:18:20.403Z","etag":null,"topics":["eclint","editorconfig","editorconfig-linter","linter","style","stylelint"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/editorconfig-action","language":"Shell","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/zbeekman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":"http://www.sourceryinstitute.org/store/p5/Donation.html"}},"created_at":"2019-06-29T20:38:22.000Z","updated_at":"2025-06-20T23:21:11.000Z","dependencies_parsed_at":"2024-01-16T22:19:00.798Z","dependency_job_id":"b76ded39-acdb-4686-aff0-e1b3b9399cab","html_url":"https://github.com/zbeekman/EditorConfig-Action","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/zbeekman/EditorConfig-Action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbeekman%2FEditorConfig-Action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbeekman%2FEditorConfig-Action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbeekman%2FEditorConfig-Action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbeekman%2FEditorConfig-Action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zbeekman","download_url":"https://codeload.github.com/zbeekman/EditorConfig-Action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zbeekman%2FEditorConfig-Action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276976302,"owners_count":25738659,"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-09-25T02:00:09.612Z","response_time":80,"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":["eclint","editorconfig","editorconfig-linter","linter","style","stylelint"],"created_at":"2024-11-19T20:36:51.524Z","updated_at":"2025-09-25T20:27:13.477Z","avatar_url":"https://github.com/zbeekman.png","language":"Shell","funding_links":["http://www.sourceryinstitute.org/store/p5/Donation.html"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# EditorConfig-Action\n\n[![action on GH marketplace][marketplace badge]][marketplace] \u0026nbsp;\n[![gpg on keybase.io][keybase badge]][keybase] \u0026nbsp;\n[![GitHub release][release badge]][latest release] \u0026nbsp;\n[![package.json deps][npm dep badge]][eclint npm] \u0026nbsp;\n[![GitHub][LICENSE badge]][LICENSE]\n\n\u003c/div\u003e\n\n:mag_right: A GitHub Action to check, enforce \u0026 fix [EditorConfig] style violations\n\n\u003cdiv align=\"center\"\u003e\n\n  [![blinking octocat][Blinky]][marketplace]\n  ![squar-heart][sq heart]\n  [![EditorConfig logo][EC logo]][EditorConfig]\n\n\u003c/div\u003e\n\n\u003cdetails\u003e\u003csummary\u003e\u003cb\u003eTable of Contents\u003c/b\u003e\u003c/summary\u003e\n\u003cp\u003e\n\n\u003c!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc --\u003e\n**Table of Contents**\n\n- [EditorConfig-Action](#editorconfig-action)\n  - [What is EditorConfig?](#what-is-editorconfig)\n  - [Using EditorConfig-Action with Your Project](#using-editorconfig-action-with-your-project)\n  - [Example Workflows](#example-workflows)\n    - [Check Conformance of Pushed Commits with `.editorconfig`](#check-conformance-of-pushed-commits-with-editorconfig)\n  - [Features and Planed Features](#features-and-planed-features)\n  - [EditorConfig Resources](#editorconfig-resources)\n  - [Other GitHub Actions from @zbeekman](#other-github-actions-from-zbeekman)\n\n\u003c!-- markdown-toc end --\u003e\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n## What is EditorConfig?\n\nFrom the [EditorConfig website][EditorConfig]:\n\u003e EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across\nvarious editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection\nof text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are\neasily readable and they work nicely with version control systems.\n\nCheckout this project's `.editorconfig` file [here][`.editorconfig`]. However, to use this GitHub Action, your project\nshould define your own `.editorconfig`.\n\nThis project uses [eclint] by Jed Mao ([@jedmao]) to lint your project. [eclint] is also\nreleased [under an MIT license].\n\n## Using EditorConfig-Action with Your Project\n\nVisit the [EditorConfig-Action GitHub Marketplace page][marketplace] to get started. Use a tagged release or the master\nversion of this GitHub action by creating your own `.github/main.workflow` file and adding a `on = \"push\"` and/or\n`on = \"pull_request\"` `workflow` that `resolves` an `action` `uses = zbeekman/EditorConfig-Action[@ref]`.\nPlease see [the GitHub Actions documentation] for additional information.\n\n## Example Workflows\n\n### Check Conformance of Pushed Commits with [`.editorconfig`]\n\nTo ensure your repository does not violate your project's [`.editorconfig`] file, you may use the\nfollowing workflow:\n\n```workflow\nworkflow \"PR Audit\" {\n  on = \"pull_request\"\n  resolves = [\"EC Audit PR\"]\n}\n\naction \"EC Audit PR\" {\n  uses = \"zbeekman/EditorConfig-Action@v1.1.0\"\n  # secrets = [\"GITHUB_TOKEN\"] # Will be needed for fixing errors\n  env = {\n    ALWAYS_LINT_ALL_FILES = \"false\" # This is the default\n  }\n}\n\nworkflow \"Push Audit\" {\n  on = \"push\"\n  resolves = [\"EC Audit Push\"]\n}\n\naction \"EC Audit Push\" {\n  uses = \"zbeekman/EditorConfig-Action@v1.1.0\"\n  # secrets = [\"GITHUB_TOKEN\"] # Will be needed for fixing errors\n  env = {\n    EC_FIX_ERROR = \"false\" # not yet implemented\n    ALWAYS_LINT_ALL_FILES = \"true\" # Might be slow for large repos\n  }\n}\n```\n\nIf you omit the  `ALWAYS_LINT_ALL_FILES` variable or it is set to `false` then only files changed in\nthe pushed commits will be linted. If you explicitly set this to `true` then every file in the\nrepository will be checked. Depending on the size of the repository, this may be a bad idea.\n\nFor protected branches, it is best to set the required action to be the one created with the `on = \"pull_request\"`,\ne.g., `\"EC Audit Push\"` above, since PRs from forks will not trigger a local push event.\n\n## Features and Planed Features\n\nFeatures currently in development or being considered for addition include:\n\n  - [x] Check only files touched by commits included in the current push\n  - [x] Always check all files\n  - [x] Pull Request linting (lint all files in pull request) and provide PR status\n  - [ ] Automatically apply fixes using `eclint fix`\n  - [ ] Ability to pass search patterns to `git ls-files` for enumerating files to check\n  - [ ] Ability to override project `.editorconfig` or use without an `.editorconfig` via `eclint`'s property override\n      flags\n  - [ ] Pass patterns of files to ignore\n\n## [EditorConfig] Resources\n\n  - :book: [eclint] usage : https://github.com/jedmao/eclint#features\n  - :earth_americas: [EditorConfig] website : https://editorconfig.org\n  - :memo: [EditorConfig] wiki : https://github.com/editorconfig/editorconfig/wiki\n  - :card_file_box: [EditorConfig] properties :\n    https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties\n  - :thinking: [EditorConfig] FAQs : https://github.com/editorconfig/editorconfig/wiki/FAQ\n  - :pencil2: [EditorConfig] with your editor : https://editorconfig.org/#download\n  - :octocat: [EditorConfig] GitHub : https://github.com/editorconfig/editorconfig\n  - :bird: [EditorConfig] on twitter : https://twitter.com/EditorConfig\n\n## Other GitHub Actions from [@zbeekman]\n\n  - [ShellCheck-Linter-Action]\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n[![star badge][star badge]][star] \u0026nbsp;\n[![zbeekman gh profile][gh follow]][gh profile] \u0026nbsp;\n[![zbeekman on twitter][twitter badge]][twitter]\n\n\u003c/div\u003e\n\n[EditorConfig]: https://editorconfig.org\n[eclint]: https://github.com/jedmao/eclint\n[@jedmao]: https://github.com/jedmao\n[@zbeekman]: https://github.com/zbeekman\n[under an MIT license]: https://github.com/jedmao/eclint/blob/master/LICENSE\n[`.editorconfig`]: https://github.com/zbeekman/EditorConfig-Action/blob/master/.editorconfig\n[ShellCheck-Linter-Action]: https://github.com/marketplace/actions/shellcheck-linter-action\n[GitHub Actions documentation]: https://developer.github.com/actions/\n\n\u003c!--\nArtwork \u0026 Images\n--\u003e\n[Blinky]: https://github.com/zbeekman/EditorConfig-Action/raw/master/assets/ocdb.gif\n[sq heart]: https://github.com/zbeekman/EditorConfig-Action/raw/master/assets/sqhr.png\n[EC logo]: https://github.com/zbeekman/EditorConfig-Action/raw/master/assets/ecl.png\n\n\u003c!--\nBadges and local links\n--\u003e\n[marketplace badge]: https://img.shields.io/badge/GitHub-Marketplace-lightblue.svg\n[marketplace]: https://github.com/marketplace/actions/editorconfig-action\n[LICENSE badge]: https://img.shields.io/github/license/zbeekman/EditorConfig-Action.svg\n[LICENSE]: https://github.com/zbeekman/EditorConfig-Action/blob/master/LICENSE\n[release badge]: https://img.shields.io/github/release/zbeekman/EditorConfig-Action.svg\n[latest release]: https://github.com/zbeekman/EditorConfig-Action/releases/latest\n[npm dep badge]:\nhttps://img.shields.io/github/package-json/dependency-version/zbeekman/EditorConfig-Action/eclint.svg\n[eclint npm]: https://www.npmjs.com/package/eclint\n[keybase badge]: https://img.shields.io/keybase/pgp/zbeekman.svg\n[keybase]: https://keybase.io/zbeekman\n[twitter badge]: https://img.shields.io/twitter/follow/zbeekman.svg?style=social\n[twitter]: https://twitter.com/intent/follow?screen_name=zbeekman\n[star badge]: https://img.shields.io/github/stars/zbeekman/EditorConfig-Action.svg?style=social\n[star]: https://github.com/zbeekman/EditorConfig-Action\n[gh follow]: https://img.shields.io/github/followers/zbeekman.svg?style=social\n[gh profile]: https://github.com/zbeekman\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbeekman%2Feditorconfig-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzbeekman%2Feditorconfig-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzbeekman%2Feditorconfig-action/lists"}