{"id":31223436,"url":"https://github.com/barzik/eslint-plugin-angular-component-api","last_synced_at":"2026-04-29T16:05:24.982Z","repository":{"id":151929442,"uuid":"107850114","full_name":"barzik/eslint-plugin-angular-component-api","owner":"barzik","description":"Eslint rule for Angular 1.X components API enforcement","archived":false,"fork":false,"pushed_at":"2017-10-24T11:35:10.000Z","size":8,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-21T22:44:01.979Z","etag":null,"topics":["eslint-plugin","node-js"],"latest_commit_sha":null,"homepage":null,"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/barzik.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-10-22T08:41:33.000Z","updated_at":"2017-10-22T10:22:07.000Z","dependencies_parsed_at":"2023-05-16T12:45:38.218Z","dependency_job_id":null,"html_url":"https://github.com/barzik/eslint-plugin-angular-component-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/barzik/eslint-plugin-angular-component-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barzik%2Feslint-plugin-angular-component-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barzik%2Feslint-plugin-angular-component-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barzik%2Feslint-plugin-angular-component-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barzik%2Feslint-plugin-angular-component-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/barzik","download_url":"https://codeload.github.com/barzik/eslint-plugin-angular-component-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barzik%2Feslint-plugin-angular-component-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281584982,"owners_count":26526171,"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-29T02:00:06.901Z","response_time":59,"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":["eslint-plugin","node-js"],"created_at":"2025-09-21T22:43:29.406Z","updated_at":"2025-10-29T08:07:13.826Z","avatar_url":"https://github.com/barzik.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# eslint-plugin-angular-component-api [![Build Status](https://travis-ci.org/barzik/eslint-plugin-angular-component-api.svg?branch=master)](https://travis-ci.org/barzik/eslint-plugin-angular-component-api)\n\nAPI tester for Angular components. Making sure that Angular V 1.X has the API that we want to use.\n\n## Installation\n\nYou'll first need to install [ESLint](http://eslint.org):\n\n```\n$ npm i eslint --save-dev\n```\n\nNext, install `eslint-plugin-angular-component-api`:\n\n```\n$ npm install eslint-plugin-angular-component-api --save-dev\n```\n\n**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-angular-component-api` globally.\n\n## Usage\n\nAdd `angular-component-api` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:\n\n```json\n{\n    \"plugins\": [\n        \"angular-component-api\"\n    ]\n}\n```\n\n\nThen configure the rules you want to use under the rules section.\n\n```json\n{\n    \"rules\": {\n        \"angular-component-api/angular-component-api-name\": [2, {musthaves: [\"nameOfAPIAttribute\"]}]\n    }\n}\n```\n\n## Supported Rules\n\n* angular-component-api-name - Making sure that `options` is included in the component API. Or any other attributes listed in the `musthaves`. For example in component defintion The linter wukk oass if options is defined.\nExamples of incorrect code for this rule with the default { \"musthaves\": [\"nameOfAPIAttribute] } option:\n```\nimport controller from './some-controller.js';\n\nexport default {\n  bindings: {\n    name: '@',\n    ngModel: '=',\n    ngFieldRequired: '=',\n  },\n  controller,\n  template: require('./some.html'),\n  ...\n};\n```\n```\nimport controller from './some-controller.js';\n\nexport default {\n  controller,\n  template: require('./some.html'),\n  ...\n};\n```\n\nExamples of correct code for this rule with the default { \"musthaves\": [\"nameOfAPIAttribute] } option:\n\n```\nimport controller from './some-controller.js';\n\nexport default {\n  bindings: {\n    name: '@',\n    ngModel: '=',\n    ngFieldRequired: '=',\n    options: '=',\n  },\n  controller,\n  template: require('./some.html'),\n  ...\n};\n```\n```\nimport controller from './some-controller.js';\n\nexport default {\n  bindings: {\n    options: '=',\n  },\n  ...\n};\n```\n# License\n\nLicensed under the terms of the MIT license. See LICENSE file in component-api-linter for terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarzik%2Feslint-plugin-angular-component-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarzik%2Feslint-plugin-angular-component-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarzik%2Feslint-plugin-angular-component-api/lists"}