{"id":13531250,"url":"https://github.com/natterstefan/plop-action-eslint","last_synced_at":"2025-04-10T01:11:57.357Z","repository":{"id":43353362,"uuid":"466638741","full_name":"natterstefan/plop-action-eslint","owner":"natterstefan","description":"A Plop action to lint files with ESLint and automatically format with Prettier.","archived":false,"fork":false,"pushed_at":"2024-07-17T18:49:38.000Z","size":316,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T01:11:52.015Z","etag":null,"topics":["eslint","plop","plop-action","plop-helper","plop-pack","plopjs","prettier"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/plop-action-eslint","language":"JavaScript","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/natterstefan.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["natterstefan"],"patreon":"natterstefan","custom":["https://www.paypal.me/natterstefan","https://www.buymeacoffee.com/natterstefan"]}},"created_at":"2022-03-06T04:49:01.000Z","updated_at":"2025-02-07T18:35:23.000Z","dependencies_parsed_at":"2024-07-17T22:55:50.310Z","dependency_job_id":null,"html_url":"https://github.com/natterstefan/plop-action-eslint","commit_stats":null,"previous_names":["natterstefan/plop-eslint"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fplop-action-eslint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fplop-action-eslint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fplop-action-eslint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/natterstefan%2Fplop-action-eslint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/natterstefan","download_url":"https://codeload.github.com/natterstefan/plop-action-eslint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137888,"owners_count":21053775,"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":["eslint","plop","plop-action","plop-helper","plop-pack","plopjs","prettier"],"created_at":"2024-08-01T07:01:01.442Z","updated_at":"2025-04-10T01:11:57.327Z","avatar_url":"https://github.com/natterstefan.png","language":"JavaScript","funding_links":["https://github.com/sponsors/natterstefan","https://patreon.com/natterstefan","https://www.paypal.me/natterstefan","https://www.buymeacoffee.com/natterstefan"],"categories":["Actions"],"sub_categories":[],"readme":"# plop-action-eslint\n\n[![npm version](https://badge.fury.io/js/plop-action-eslint.svg)](https://badge.fury.io/js/plop-action-eslint)\n[![GitHub license](https://img.shields.io/github/license/natterstefan/plop-action-eslint.svg)](https://github.com/natterstefan/plop-action-eslint/blob/main/LICENSE)\n[![Node CI](https://github.com/natterstefan/plop-action-eslint/actions/workflows/ci.yml/badge.svg)](https://github.com/natterstefan/plop-action-eslint/actions/workflows/ci.yml)\n\nA [Plop](https://github.com/plopjs/plop) action to lint files with\n[ESLint](https://eslint.org/) and automatically format with\n[Prettier](#prettier-support).\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Actions](#actions)\n- [Prettier Support](#prettier-support)\n\n## Installation\n\n```sh\nnpm install plop-action-eslint --save-dev\n\n# or with yarn\nyarn add plop-action-eslint -D\n```\n\n## Usage\n\nBefore you can use `plop-action-eslint`, you have to load it into the `plop`\nobject by adding the folling to your `plopfile.js`:\n\n```javascript\n// plopfile.js\nmodule.exports = async plop =\u003e {\n  await plop.load('plop-action-eslint')\n}\n```\n\nOnce loaded, you have access the following actions.\n\n### Actions\n\n#### `eslint`\n\nLints and fixes (autofix is enabled) the file of the given path with your\nprojects ESLint configuration.\n\n```javascript\n{\n  type: \"eslint\",\n  path: \"src/component/{{pascalCase name}}.js\",\n}\n```\n\nYou can also pass an array of paths.\n\n```javascript\n{\n  type: \"eslint\",\n  path: [\n    \"src/component/{{pascalCase name}}.js\",\n    \"src/component/{{pascalCase name}}.test.js\",\n  ],\n}\n```\n\n## Prettier Support\n\nIn order to automatically format your code with Prettier as well, you have to\nuse [eslint-config-prettier][1] and [eslint-plugin-prettier][2] in your ESLint\nconfiguration.\n\n## How to release\n\n### Manually trigger release\n\n```bash\n# generate a new tag\nyarn lerna:version\n\n# generate a new Changelog entry\nnpx lerna-changelog --from \u003ctag\u003e --to \u003ctag\u003e\n# add the result manually to CHANGELOG.md and commit it\ngit add CHANGELOG.md\ngit commit -m \"chore: prepared release\"\n\n# push the tags\ngit push --tags\n\n# publish the new version\nyarn lerna:publish\n```\n\n## License\n\n[MIT](./LICENSE)\n\n## Contributors ✨\n\nThanks goes to these wonderful people\n([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://natterstefan.me/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/1043668?v=4?s=100\" width=\"100px;\" alt=\"Stefan Natter\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eStefan Natter\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natterstefan/plop-action-eslint/commits?author=natterstefan\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://vytenis.kuciauskas.lt/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/468006?v=4?s=100\" width=\"100px;\" alt=\"Vytenis\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eVytenis\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natterstefan/plop-action-eslint/commits?author=FDiskas\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/iholovin\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/95911872?v=4?s=100\" width=\"100px;\" alt=\"Ivan Holovin\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eIvan Holovin\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natterstefan/plop-action-eslint/commits?author=iholovin\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/buggedcom\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/2810?v=4?s=100\" width=\"100px;\" alt=\"Oliver Lillie\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eOliver Lillie\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/natterstefan/plop-action-eslint/commits?author=buggedcom\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the\n[all-contributors](https://github.com/all-contributors/all-contributors)\nspecification. Contributions of any kind welcome!\n\n## Credits\n\nThis plop action is based on the code that was shared in\n[plop#80](https://github.com/plopjs/plop/issues/80#issuecomment-645179250) by\n[FDiskas](https://github.com/FDiskas).\n\n[1]: https://github.com/prettier/eslint-config-prettier\n[2]: https://github.com/prettier/eslint-plugin-prettier\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatterstefan%2Fplop-action-eslint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnatterstefan%2Fplop-action-eslint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnatterstefan%2Fplop-action-eslint/lists"}