{"id":19586397,"url":"https://github.com/epaew/eslint-plugin-filenames-simple","last_synced_at":"2025-05-08T00:22:18.171Z","repository":{"id":37040738,"uuid":"267722796","full_name":"epaew/eslint-plugin-filenames-simple","owner":"epaew","description":"An ESLint plugin to check filenames with simple configuration","archived":false,"fork":false,"pushed_at":"2024-02-17T10:19:46.000Z","size":1591,"stargazers_count":50,"open_issues_count":14,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-12-15T05:46:18.172Z","etag":null,"topics":["ecmascript","eslint","eslint-plugin","filename","javascript","naming-conventions","simple","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/epaew.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2020-05-28T23:58:24.000Z","updated_at":"2024-08-15T22:02:50.000Z","dependencies_parsed_at":"2024-06-18T15:31:55.842Z","dependency_job_id":"ef3cec8a-bfb4-4145-8064-264f25164038","html_url":"https://github.com/epaew/eslint-plugin-filenames-simple","commit_stats":{"total_commits":546,"total_committers":4,"mean_commits":136.5,"dds":"0.47619047619047616","last_synced_commit":"cc2fbdcc5109c016fd5c83e9f8e8bd96ca88b376"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epaew%2Feslint-plugin-filenames-simple","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epaew%2Feslint-plugin-filenames-simple/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epaew%2Feslint-plugin-filenames-simple/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/epaew%2Feslint-plugin-filenames-simple/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/epaew","download_url":"https://codeload.github.com/epaew/eslint-plugin-filenames-simple/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231468021,"owners_count":18381174,"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":["ecmascript","eslint","eslint-plugin","filename","javascript","naming-conventions","simple","typescript"],"created_at":"2024-11-11T07:59:37.188Z","updated_at":"2024-12-27T10:07:39.653Z","avatar_url":"https://github.com/epaew.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESLint plugin filenames simple\n\n[![npm version](https://badge.fury.io/js/eslint-plugin-filenames-simple.svg)](https://badge.fury.io/js/eslint-plugin-filenames-simple)\n[![Build Status](https://github.com/epaew/eslint-plugin-filenames-simple/workflows/Run%20Jest/badge.svg)](https://github.com/epaew/eslint-plugin-filenames-simple/actions?query=workflow%3A%22Run+Jest%22+branch%3A%22master%22)\n[![Maintainability](https://api.codeclimate.com/v1/badges/964080f3d22b89b276d2/maintainability)](https://codeclimate.com/github/epaew/eslint-plugin-filenames-simple/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/964080f3d22b89b276d2/test_coverage)](https://codeclimate.com/github/epaew/eslint-plugin-filenames-simple/test_coverage)\n\nAn ESLint plugin to check filenames with simple configuration.  \nThis plugin is inspired by [eslint-plugin-filenames](https://github.com/selaux/eslint-plugin-filenames).\n\n## Requirements\n\n- [Node.js](https://nodejs.org/en/download/): \u003e= 14.17\n    - Unstable versions of Node.js are not actively supported.\n- [ESLint](https://eslint.org/): 7.x, 8.x\n\n## Getting started\n\n1. Install ESLint and this plugin via npm/yarn\n\n   - https://eslint.org/docs/user-guide/getting-started#installation-and-usage\n\n   ```sh\n   npm i --save-dev eslint eslint-plugin-filenames-simple\n   # or\n   yarn add -D eslint eslint-plugin-filenames-simple\n   ```\n\n2. Modify your `.eslintrc` file to load the plugin and enable the rules.\n\n   ```javascript\n   // select one of the following\n   {\n     \"extends\": [\n       \"plugin:filenames-simple/recommended\"       // for pure ECMAScript/TypeScript project\n       \"plugin:filenames-simple/recommended-react\" // for React.js project\n       \"plugin:filenames-simple/recommended-vue\"   // for Vue.js project\n     ]\n   }\n   ```\n\n   ```javascript\n   // or configure manually\n   {\n     \"plugins\": [\n       \"filenames-simple\"\n     ],\n     \"rules\": {\n       \"filenames-simple/extension\": \"error\",\n       \"filenames-simple/naming-convention\": [\"error\", { \"rule\": \"kebab-case\" }]\n     }\n   }\n   ```\n\n3. Run ESLint and lint your codes.\n   ```sh\n   npm run eslint --ext .js .\n   # or\n   yarn run eslint --ext .js .\n   ```\n\n## Available rules\n\n- [extension](./docs/rules/extension.md)\n- [named-export](./docs/rules/named-export.md)\n- [naming-convention](./docs/rules/naming-convention.md)\n- [no-index](./docs/rules/no-index.md)\n- [pluralize](./docs/rules/pluralize.md)\n- [typescript-module-declaration](./docs/rules/typescript-module-declaration.md)\n\n## CHANGELOG\n\n[CHANGELOG](./CHANGELOG.md)\n\n## LICENSE\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fepaew%2Feslint-plugin-filenames-simple","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fepaew%2Feslint-plugin-filenames-simple","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fepaew%2Feslint-plugin-filenames-simple/lists"}