{"id":27081517,"url":"https://github.com/mezgoodle/auto-formatter","last_synced_at":"2026-05-17T15:02:02.894Z","repository":{"id":49562916,"uuid":"281359742","full_name":"mezgoodle/auto-formatter","owner":"mezgoodle","description":"🔨GitHub Action that formats commits automatically⚙️","archived":false,"fork":false,"pushed_at":"2021-12-29T07:18:28.000Z","size":224,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-17T05:12:57.384Z","etag":null,"topics":["auto-formatter","automation","commit","github-actions"],"latest_commit_sha":null,"homepage":"","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/mezgoodle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2020-07-21T09:54:11.000Z","updated_at":"2023-09-10T08:30:29.000Z","dependencies_parsed_at":"2023-01-04T12:30:16.510Z","dependency_job_id":null,"html_url":"https://github.com/mezgoodle/auto-formatter","commit_stats":{"total_commits":339,"total_committers":4,"mean_commits":84.75,"dds":"0.21828908554572268","last_synced_commit":"8fdaceff07d36ef3aa5e0fe4924ca9b08ee1a88f"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2Fauto-formatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2Fauto-formatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2Fauto-formatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mezgoodle%2Fauto-formatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mezgoodle","download_url":"https://codeload.github.com/mezgoodle/auto-formatter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247276185,"owners_count":20912288,"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":["auto-formatter","automation","commit","github-actions"],"created_at":"2025-04-06T02:19:29.581Z","updated_at":"2026-05-17T15:01:57.846Z","avatar_url":"https://github.com/mezgoodle.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# auto-formatter\n\n[![Language](https://img.shields.io/badge/language-shell_script-brightgreen?style=flat-square)](https://en.wikipedia.org/wiki/Shell_script)\n\nThis repository is for the **GitHub Action** to run a **auto-formatter**.\nIt is a simple combination of various libraries, written in `bash`, to help formate your code automatically.\n\n## Version\n\nCurrent version keep only _python_ format. In next version more languages will be available.\n\n\u003e Project is no longer being developed for various reasons.\n\n## How it Works\n\nThe auto-formatter launches linters that can formate code, do this and commit to your repository.\n\n## Supported Linters\n\nDevelopers on **GitHub** can call the **GitHub Action** to formate their code base with the following list of libraries:\n\n| _Language_                       | _Library_                                                                                                                                                                       |\n| -------------------------------- | ---------------------------------------------------------- |\n| **NodeJs**                       | [eslint](https://eslint.org/)                              |\n| **Python**                       | [autopep8](https://github.com/hhatto/autopep8)             |\n| **CSS**                          | [stylelint](https://stylelint.io/)                         |\n| **MarkDown**                     | [markdownlint](https://github.com/DavidAnson/markdownlint) |                                                                                                                                           |\n| **HTML**                         | [clean-html](https://www.npmjs.com/package/clean-html)     |\n\n## How to use\n\nTo use this **GitHub** Action you will need to complete the following:\n\n1. Create a new file in your repository called `.github/workflows/formatter.yml`\n2. Copy the example workflow from below into that new file, no extra configuration required\n3. Commit that file to a new branch\n4. Open up a pull request and observe the action working\n5. Enjoy your more _stable_, and _cleaner_ code base\n\n## Example connecting GitHub Action Workflow\n\nIn your repository you should have a `.github/workflows` folder with **GitHub** Action similar to below:\n\n- `.github/workflows/formatter.yml`\n\nThis file should have the following code:\n\n```yml\n---\n####################\n####################\n## Auto Formatter ##\n####################\n####################\nname: Formate Code\n\n#\n# Documentation:\n# https://github.com/mezgoodle/auto-formatter\n#\n\n#############################\n# Start the job on all push #\n#############################\non:\n  push:\n    branches: [master]\n  pull_request:\n    branches-ignore: [master]\n    # Remove the line above to run when pull-requesting to master\n\n###############\n# Set the Job #\n###############\njobs:\n  build:\n    # Name the Job\n    name: Formate Code\n    # Set the agent to run on\n    runs-on: ubuntu-latest\n\n    ##################\n    # Load all steps #\n    ##################\n    steps:\n      ##########################\n      # Checkout the code base #\n      ##########################\n      - name: Checkout Code\n        uses: actions/checkout@v2\n        with:\n          # Full git history is needed to get a proper list of changed files within `auto-formatter`\n          fetch-depth: 0\n\n      ################################\n      # Run Auto-formatter against code base #\n      ################################\n      - name: Auto-Formatter\n        uses: mezgoodle/auto-formatter@v1.0.2\n        env:\n            GITHUB_TOKEN: ${{ secrets.TOKEN }}\n```\n\n## Add Super-Linter badge in your repository README\n\nYou can show Super-Linter status with a badge in your repository README\n\n![Auto formate code](https://github.com/mezgoodle/auto-formatter/workflows/Auto%20formate%20code/badge.svg)\n\nFormat:\n\n```markdown\n![Auto formate code](https://github.com/\u003cOWNER\u003e/\u003cREPOSITORY\u003e/workflows/Auto%20formate%20code/badge.svg)\n```\n\nExample:\n\n```markdown\n![Auto formate code](https://github.com/mezgoodle/auto-formatter/workflows/Auto%20formate%20code/badge.svg)\n```\n\n## Environment variables\n\nThe super-linter allows you to pass the following `ENV` variables to be able to trigger different functionality.\n\n_Note:_ All the `VALIDATE_[LANGUAGE]` variables behave in a very specific way:\n\n- If none of them are passed, then they all default to false.\n- If any one of the variables are set to true, we default to leaving any unset variable to false.\n- If any one of the variables are set to false, we default to leaving any unset variable to false.\n\n| **ENV VAR**                        | **Default Value**     | **Notes**                                                                                                                                                                        |\n| ---------------------------------- | --------------------- | ----------------------------------------------------------------------- |\n| **python**                         | `false`               | Flag to enable or disable the formatting process of the Python language.|                                                                                   |\n\n## Motivation\n\nAt first I was inspired by this [project](https://github.com/github/super-linter). I wanted to do the same, but with formatting. It is also a great opportunity to learn how to work with Docker and how to create your own GitHub workflow. Also it was the amazing time working together with my dad.\n\n## Build status\n\nHere you can see build status of [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration):\n\n[![Docker Image CI](https://github.com/mezgoodle/auto-formatter/actions/workflows/docker-image.yml/badge.svg)](https://github.com/mezgoodle/auto-formatter/actions/workflows/docker-image.yml)\n[![Docker Image CI](https://gitlab.com/mezgoodle/auto-formatter/badges/master/pipeline.svg)](https://gitlab.com/mezgoodle/auto-formatter/-/pipelines)\n![Lint Code Base](https://github.com/mezgoodle/auto-formatter/workflows/Lint%20Code%20Base/badge.svg)\n\n## Contribute\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Also look at the [CONTRIBUTING.md](https://github.com/mezgoodle/auto-formatter/blob/master/CONTRIBUTING.md).\n\n## Credits\n\nLinks to any repo, articles which inspired me to build this project:\n\n- [Python Docker](https://hub.docker.com/_/python)\n- [Nyukers Docker](https://github.com/nyukers/aformat)\n- [Environment variables](https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables)\n- [run-node-formatter](https://github.com/MarvinJWendt/run-node-formatter)\n- [alpine-packages](https://pkgs.alpinelinux.org/packages) \n\n## License\n\nMIT © [mezgoodle](https://github.com/mezgoodle)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmezgoodle%2Fauto-formatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmezgoodle%2Fauto-formatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmezgoodle%2Fauto-formatter/lists"}