{"id":19920604,"url":"https://github.com/jenssimon/eslint-plugin-always","last_synced_at":"2025-05-03T06:31:07.434Z","repository":{"id":37072300,"uuid":"235754892","full_name":"jenssimon/eslint-plugin-always","owner":"jenssimon","description":"ESLint plugin that always reports with configurable message","archived":false,"fork":false,"pushed_at":"2025-04-29T03:21:14.000Z","size":754772,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-29T04:33:01.331Z","etag":null,"topics":["eslint","eslint-plugin","eslintplugin"],"latest_commit_sha":null,"homepage":"","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/jenssimon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"zenodo":null}},"created_at":"2020-01-23T08:40:41.000Z","updated_at":"2025-04-29T03:21:16.000Z","dependencies_parsed_at":"2023-12-26T01:23:56.606Z","dependency_job_id":"1610f379-198c-4802-8aa4-3f1bee3e0d5d","html_url":"https://github.com/jenssimon/eslint-plugin-always","commit_stats":{"total_commits":564,"total_committers":5,"mean_commits":112.8,"dds":"0.14184397163120566","last_synced_commit":"9682b6e3f329fd93be700c6f82a046946f33fe65"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenssimon%2Feslint-plugin-always","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenssimon%2Feslint-plugin-always/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenssimon%2Feslint-plugin-always/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenssimon%2Feslint-plugin-always/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenssimon","download_url":"https://codeload.github.com/jenssimon/eslint-plugin-always/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252154737,"owners_count":21702983,"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","eslint-plugin","eslintplugin"],"created_at":"2024-11-12T22:05:09.537Z","updated_at":"2025-05-03T06:31:06.117Z","avatar_url":"https://github.com/jenssimon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM version][npm-image]][npm-url] [![Downloads][npm-downloads-image]][npm-url] [![star this repo][gh-stars-image]][gh-url] [![fork this repo][gh-forks-image]][gh-url] [![CI](https://github.com/jenssimon/eslint-plugin-always/actions/workflows/ci.yml/badge.svg)](https://github.com/jenssimon/eslint-plugin-always/actions/workflows/ci.yml)\n\n# eslint-plugin-always\n\n\u003e ESLint plugin that **always reports** with a configurable message.\n\nSimply reports **ALWAYS**!\n\nThere is a reason why we want to do so! See [Why?](#why)\n\n## Installation\n\n```sh\n$ yarn add eslint-plugin-always --dev\n```\n\n## Usage\n\nAdd the plugin to your ESLint configuration:\n\n```json\n{\n  \"plugins\": [\n    \"always\"\n  ]\n}\n```\n\nAnd then add the following rule:\n\n```json\n{\n  \"rules\": {\n    \"always/always\": [\"error\", {\n      \"message\": \"Hello World\"\n    }]\n  }\n}\n```\n\n## Why?\n\n\u003e I need to notice the team members that the new folder must contain a ESLint configuration.\n\n\u003e **Notice**\n\u003e\n\u003e I will simply show you the use case which is the reason why I created this plugin.\n\nThere is a `cartridges/` folder in the project. This folder contains multiple packages which may need a different ESLint configuration.\n\nThe surrounding application uses another ESLint configuration.\nBut this configuration isn't applicable for the packages in the `cartridges/` folder.\n\n```\n├── cartridges\n│   ├── app_foo\n│   │   ├── .eslintrc.json\n│   ├── int_foo\n│   │   ├── .eslintrc.json\n│   ├── int_bar\n│   │   ├── .eslintrc.json\n│   ├── int_new \u003c-- DETECT WHY THIS FOLDER DOESN'T HAVE A LINT CONFIGURATION\n│   ├── bc_foo\n│   │   ├── .eslintrc.json\n│   ├── .eslintrc.json \u003c-- THE FILE THAT ENABLES THIS RULE AND CONTAINING root: true\n├── packages.json \u003c-- CONTAINING THE SURROUNDING LINT CONFIGURATION\n```\n\nFor a new package `cartidges/int_new` a valid ESLint configuration **must** be added.\n\n`cartridges/.eslintrc.json` resets the ESLint configuration and adds this rule.\n\n```json\n{\n  \"root\": true,\n  \"plugins\": [\n    \"always\"\n  ],\n  \"rules\": {\n    \"always/always\": [\"error\", {\n      \"message\": \"No ESLint config found. Please add one or ignore the cartridge.\"\n    }]\n  }\n}\n```\n\nSo all files in this folder structure won't check any ESLint rules.\nThe subfolders must contain ESLint configurations which can differ between each subfolder.\n\nFor the case that someone adds a subfolder and forgets the ESLint configuration this rule was created. So every file within the subfolder will report an error\n\n```\nNo ESLint config found. Please add one or ignore the cartridge.\n```\n\n## License\n\nMIT © 2023 [Jens Simon](https://github.com/jenssimon)\n\n[npm-url]: https://www.npmjs.com/package/eslint-plugin-always\n[npm-image]: https://badgen.net/npm/v/eslint-plugin-always\n[npm-downloads-image]: https://badgen.net/npm/dw/eslint-plugin-always\n\n[gh-url]: https://github.com/jenssimon/eslint-plugin-always\n[gh-stars-image]: https://badgen.net/github/stars/jenssimon/eslint-plugin-always\n[gh-forks-image]: https://badgen.net/github/forks/jenssimon/eslint-plugin-always\n[gh-status-image]: https://badgen.net/github/status/jenssimon/eslint-plugin-always\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenssimon%2Feslint-plugin-always","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenssimon%2Feslint-plugin-always","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenssimon%2Feslint-plugin-always/lists"}