eslint-plugin-interface-to-type 1.0.1 → 1.1.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug Report
+about: Report a bug to help us improve
+title: "[BUG] "
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Run '...'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature Request
+about: Suggest a new feature
+title: "[FEATURE] "
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe the feature you'd like**
+A clear and concise description of the feature.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/SECURITY.md

@@ -0,0 +1,10 @@
+# Security Policy
+
+## Reporting a Vulnerability
+If you discover a security vulnerability in this project, please report it by creating a new issue in this repository.
+
+When creating the issue:
+- Clearly describe the vulnerability.
+- Include any relevant details or steps to reproduce the issue.
+
+We will review and address all reported vulnerabilities as quickly as possible. Thank you for helping to improve the security of this project.

package/.github/pull_request_template.md

@@ -0,0 +1,11 @@
+
+### Description
+Describe the changes you made and why.
+
+### Related Issues
+Closes #[issue number]
+
+### Checklist
+- [ ] I have tested the changes locally.
+- [ ] I have updated documentation where necessary.
+- [ ] I have ensured my code follows the style guidelines of this project.

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,35 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+We as members, contributors, and leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+Examples of behavior that contributes to a positive environment for our community include:
+- Demonstrating empathy and kindness toward other people.
+- Being respectful of differing opinions, viewpoints, and experiences.
+- Giving and gracefully accepting constructive feedback.
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
+- Focusing on what is best not just for us as individuals, but for the overall community.
+
+Examples of unacceptable behavior include:
+- The use of sexualized language or imagery, and sexual attention or advances of any kind.
+- Trolling, insulting or derogatory comments, and personal or political attacks.
+- Public or private harassment.
+- Publishing others' private information, such as a physical or email address, without their explicit permission.
+- Other conduct which could reasonably be considered inappropriate in a professional setting.
+
+## Enforcement Responsibilities
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by creating an issue in this repository. All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

package/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Contributing to eslint-plugin-interface-to-type
+
+Thank you for considering contributing to this project! Here are some guidelines to help you get started.
+
+---
+
+## How to Contribute
+
+1. **Report Bugs:**
+   - Use the [Issues](https://github.com/janszotkowski/eslint-plugin-interface-to-type/issues) tab to report any bugs or problems you encounter.
+   - Clearly describe the problem, steps to reproduce it, and your environment.
+
+2. **Request Features:**
+   - Use the same [Issues](https://github.com/janszotkowski/eslint-plugin-interface-to-type/issues) tab to suggest new features or enhancements.
+
+3. **Submit Changes:**
+   - Create a pull request for any changes you'd like to see in the project.
+   - Include a clear description of your changes and reference any relevant issues.
+
+---
+
+## Development Setup
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/janszotkowski/eslint-plugin-interface-to-type.git
+   cd eslint-plugin-interface-to-type
+   ```
+
+2. **Install dependencies:**
+   ```bash
+   npm install
+   ```
+
+3. **Run tests:**
+   ```bash
+   npm test
+   ```
+
+---
+
+## Guidelines for Contributions
+
+- Ensure all changes are thoroughly tested.
+- Include clear and descriptive commit messages.
+- Update documentation if your changes affect usage.
+
+Thank you for contributing and helping improve this project!

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jan Szotkowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,8 +1,8 @@
 
 # eslint-plugin-interface-to-type
 
-[![npm version](https://img.shields.io/npm/v/eslint-plugin-interface-to-type.svg)](https://www.npmjs.com/package/eslint-plugin-interface-to-type)
-[![downloads](https://img.shields.io/npm/dm/eslint-plugin-interface-to-type.svg)](https://www.npmjs.com/package/eslint-plugin-interface-to-type)
+[![npm version](https://img.shields.io/npm/v/eslint-plugin-interface-to-type.svg)](https://www.npmjs.com/package/eslint-plugin-interface-to-type)  
+[![downloads](https://img.shields.io/npm/dm/eslint-plugin-interface-to-type.svg)](https://www.npmjs.com/package/eslint-plugin-interface-to-type)  
 
 An ESLint plugin that enforces the use of `type` aliases instead of `interface` declarations in TypeScript.
 
@@ -66,6 +66,32 @@ type User = {
 
 ---
 
+## Why `interface` can be risky
+
+One of the reasons to prefer `type` over `interface` is the potential for unexpected behavior with `interface` merging. In TypeScript, when two `interface` declarations share the same name, they are automatically merged into a single declaration. This behavior, known as [Declaration Merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html), can introduce subtle bugs and unintended behaviors in your codebase.
+
+### Example of Declaration Merging
+
+```typescript
+interface User {
+  id: number;
+}
+
+interface User {
+  name: string;
+}
+
+// Resulting type
+interface User {
+  id: number;
+  name: string;
+}
+```
+
+While this behavior can sometimes be useful, it often leads to confusion and makes code harder to maintain, especially in large or collaborative projects. Using `type` avoids this risk entirely, as `type` declarations with the same name will result in a compilation error.
+
+---
+
 ## Autofix
 
 This rule supports ESLint's `--fix` option, which can automatically convert `interface` declarations to equivalent `type` aliases.

package/lib/rules/prefer-type-over-interface.js

@@ -13,7 +13,7 @@ module.exports = {
         return {
             TSInterfaceDeclaration(node) {
                 const interfaceName = node.id.name;
-                const sourceCode = context.getSourceCode();
+                const sourceCode = context.sourceCode || context.getSourceCode();
                 const typeParams = node.typeParameters ? sourceCode.getText(node.typeParameters) : '';
 
                 const bodyStart = node.body.range[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-interface-to-type",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "index.js",
   "scripts": {
     "test": "mocha tests/**/*.test.js"
@@ -19,13 +19,13 @@
     "url": "https://github.com/janszotkowski/eslint-plugin-interface-to-type"
   },
   "description": "An ESLint plugin to enforce the use of type over interface in TypeScript.",
-  "dependencies": {},
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "chai": "^5.1.2",
-    "eslint": "^8.57.1",
+    "@typescript-eslint/eslint-plugin": "^8.54.0",
+    "@typescript-eslint/parser": "^8.54.0",
+    "chai": "^6.2.2",
+    "eslint": "^10.0.0",
     "eslint-rule-tester": "^2.0.0",
-    "mocha": "^10.8.2"
+    "mocha": "^11.7.5",
+    "typescript": "^5.9.3"
   }
 }

package/tests/lib/rules/compatibility.test.js

@@ -0,0 +1,85 @@
+const { RuleTester } = require("eslint");
+const rule = require("../../../lib/rules/prefer-type-over-interface");
+const parser = require("@typescript-eslint/parser");
+
+// Mock context pro simulaci starších verzí ESLintu (před v9)
+const mockContextV8 = {
+    getSourceCode: () => ({
+        getText: (node) => {
+            if (!node) return "mock source code";
+            if (node.type === "TSTypeParameterDeclaration") return "<T>";
+            if (node.type === "TSInterfaceBody") return "{ prop: string }";
+            if (node.name === "Parent") return "Parent";
+            return "getText result";
+        }
+    }),
+    report: () => {}
+};
+
+// Mock context pro ESLint v9/v10
+const mockContextV10 = {
+    sourceCode: {
+        getText: (node) => {
+            if (!node) return "mock source code";
+            return "getText result";
+        }
+    },
+    report: () => {}
+};
+
+describe("Kompatibilita verzí ESLint", () => {
+    it("mělo by fungovat s context.getSourceCode() (pro ESLint < 9)", () => {
+        const ruleInstance = rule.create(mockContextV8);
+        const node = {
+            id: { name: "Test" },
+            body: { range: [0, 10] },
+            typeParameters: { type: "TSTypeParameterDeclaration" }
+        };
+        // Nemělo by vyhodit chybu
+        ruleInstance.TSInterfaceDeclaration(node);
+    });
+
+    it("mělo by fungovat s context.sourceCode (pro ESLint >= 9)", () => {
+        const ruleInstance = rule.create(mockContextV10);
+        const node = {
+            id: { name: "Test" },
+            body: { range: [0, 10] },
+            typeParameters: { type: "TSTypeParameterDeclaration" }
+        };
+        // Nemělo by vyhodit chybu
+        ruleInstance.TSInterfaceDeclaration(node);
+    });
+});
+
+const ruleTester = new RuleTester({
+    languageOptions: {
+        parser: parser,
+        ecmaVersion: 2020,
+        sourceType: "module",
+    },
+});
+
+ruleTester.run("prefer-type-over-interface-v10-compatibility", rule, {
+    valid: [
+        {
+            code: "type MyType = { field: string; };",
+        },
+    ],
+    invalid: [
+        {
+            code: "interface MyInterface { field: string; }",
+            errors: [{ message: "Interface 'MyInterface' can be replaced by a type." }],
+            output: "type MyInterface = { field: string; };",
+        },
+        {
+            code: "interface MyInterface<T> { field: T; }",
+            errors: [{ message: "Interface 'MyInterface' can be replaced by a type." }],
+            output: "type MyInterface<T> = { field: T; };",
+        },
+        {
+            code: "interface MyInterface extends Parent { field: string; }",
+            errors: [{ message: "Interface 'MyInterface' can be replaced by a type." }],
+            output: "type MyInterface = Parent & { field: string; };",
+        },
+    ],
+});

package/tests/lib/rules/prefer-type-over-interface.test.js

@@ -1,9 +1,10 @@
 const { RuleTester } = require("eslint");
 const rule = require("../../../lib/rules/prefer-type-over-interface");
+const parser = require("@typescript-eslint/parser");
 
 const ruleTester = new RuleTester({
-    parser: require.resolve("@typescript-eslint/parser"),
-    parserOptions: {
+    languageOptions: {
+        parser: parser,
         ecmaVersion: 2020,
         sourceType: "module",
     },