eslint-plugin-svelte 3.2.1 → 3.3.0

package/README.md

@@ -48,7 +48,7 @@ npm install --save-dev svelte eslint eslint-plugin-svelte globals
 > **Requirements:**
 >
 > - ESLint v8.57.1, v9.0.0, and above
-> - Node.js v18.20.4, v20.18.0, v22.10.0, and above
+> - Node.js v18.18.0, v20.9.0, v21.1.0 and above
 
 ## Usage
 

package/lib/main.d.ts

@@ -14,7 +14,7 @@ export declare const configs: {
 export declare const rules: Record<string, Rule.RuleModule>;
 export declare const meta: {
     name: "eslint-plugin-svelte";
-    version: "3.2.1";
+    version: "3.3.0";
 };
 export declare const processors: {
     '.svelte': typeof processor;

package/lib/meta.d.ts

@@ -1,2 +1,2 @@
 export declare const name = "eslint-plugin-svelte";
-export declare const version = "3.2.1";
+export declare const version = "3.3.0";

package/lib/meta.js

@@ -2,4 +2,4 @@
 // This file has been automatically generated,
 // in order to update its content execute "pnpm run update"
 export const name = 'eslint-plugin-svelte';
-export const version = '3.2.1';
+export const version = '3.3.0';

package/lib/rule-types.d.ts

@@ -545,7 +545,8 @@ type SvelteNoUnusedClassName = [] | [
 type SvelteNoUnusedProps = [] | [
     {
         checkImportedTypes?: boolean;
-        ignorePatterns?: string[];
+        ignoreTypePatterns?: string[];
+        ignorePropertyPatterns?: string[];
     }
 ];
 type SvelteNoUselessMustaches = [] | [

package/lib/rules/no-unused-props.js

@@ -3,6 +3,7 @@ import { getTypeScriptTools } from '../utils/ts-utils/index.js';
 import { findVariable } from '../utils/ast-utils.js';
 import { toRegExp } from '../utils/regexp.js';
 import { getFilename } from '../utils/compat.js';
+let isRemovedWarningShown = false;
 export default createRule('no-unused-props', {
     meta: {
         docs: {
@@ -18,7 +19,14 @@ export default createRule('no-unused-props', {
                         type: 'boolean',
                         default: false
                     },
-                    ignorePatterns: {
+                    ignoreTypePatterns: {
+                        type: 'array',
+                        items: {
+                            type: 'string'
+                        },
+                        default: []
+                    },
+                    ignorePropertyPatterns: {
                         type: 'array',
                         items: {
                             type: 'string'
@@ -53,31 +61,43 @@ export default createRule('no-unused-props', {
             return {};
         }
         const options = context.options[0] ?? {};
+        // TODO: Remove in v4
+        // MEMO: `ignorePatterns` was a property that only existed from v3.2.0 to v3.2.2.
+        // From v3.3.0, it was replaced with `ignorePropertyPatterns` and `ignoreTypePatterns`.
+        if (options.ignorePatterns != null && !isRemovedWarningShown) {
+            console.warn('eslint-plugin-svelte: The `ignorePatterns` option in the `no-unused-props` rule has been removed. Please use `ignorePropertyPatterns` or/and `ignoreTypePatterns` instead.');
+            isRemovedWarningShown = true;
+        }
         const checkImportedTypes = options.checkImportedTypes ?? false;
-        const ignorePatterns = (options.ignorePatterns ?? []).map((p) => {
+        const ignoreTypePatterns = (options.ignoreTypePatterns ?? []).map((p) => {
+            if (typeof p === 'string') {
+                return toRegExp(p);
+            }
+            return p;
+        });
+        const ignorePropertyPatterns = (options.ignorePropertyPatterns ?? []).map((p) => {
             if (typeof p === 'string') {
                 return toRegExp(p);
             }
             return p;
         });
-        function shouldIgnore(name) {
-            return ignorePatterns.some((pattern) => pattern.test(name));
+        function shouldIgnoreProperty(name) {
+            return ignorePropertyPatterns.some((pattern) => pattern.test(name));
         }
         function shouldIgnoreType(type) {
+            function isMatched(name) {
+                return ignoreTypePatterns.some((pattern) => pattern.test(name));
+            }
             const typeStr = typeChecker.typeToString(type);
             const symbol = type.getSymbol();
             const symbolName = symbol?.getName();
-            return shouldIgnore(typeStr) || (symbolName ? shouldIgnore(symbolName) : false);
+            return isMatched(typeStr) || (symbolName ? isMatched(symbolName) : false);
         }
-        function isExternalType(type) {
-            const symbol = type.getSymbol();
-            if (!symbol)
-                return false;
+        function isInternalProperty(symbol) {
             const declarations = symbol.getDeclarations();
             if (!declarations || declarations.length === 0)
                 return false;
-            const sourceFile = declarations[0].getSourceFile();
-            return sourceFile.fileName !== fileName;
+            return declarations.every((decl) => decl.getSourceFile().fileName === fileName);
         }
         /**
          * Extracts property paths from member expressions.
@@ -179,8 +199,6 @@ export default createRule('no-unused-props', {
             checkedTypes.add(typeStr);
             if (shouldIgnoreType(type))
                 return;
-            if (!checkImportedTypes && isExternalType(type))
-                return;
             const properties = typeChecker.getPropertiesOfType(type);
             const baseTypes = type.getBaseTypes();
             if (!properties.length && (!baseTypes || baseTypes.length === 0)) {
@@ -194,7 +212,11 @@ export default createRule('no-unused-props', {
             for (const prop of properties) {
                 if (isBuiltInProperty(prop))
                     continue;
+                if (!checkImportedTypes && !isInternalProperty(prop))
+                    continue;
                 const propName = prop.getName();
+                if (shouldIgnoreProperty(propName))
+                    continue;
                 const currentPath = [...parentPath, propName];
                 const currentPathStr = [...parentPath, propName].join('.');
                 if (reportedProps.has(currentPathStr))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-svelte",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "ESLint plugin for Svelte using AST",
   "repository": "git+https://github.com/sveltejs/eslint-plugin-svelte.git",
   "homepage": "https://sveltejs.github.io/eslint-plugin-svelte",