@siemens/eslint-plugin-defaultvalue 1.0.2 → 1.1.1

package/README.md

@@ -33,16 +33,3 @@ export default [
   }
 ];
 ```
-
-### Removing not resolved and setter @defaultValue annotations
-
-To automatically remove not resolvable and setter @defaultValue annotations, use the following configuration:
-
-```js
-...,
-rules: {
-  ...,
-  'defaultvalue/tsdoc-defaultValue-annotation': ['error', 'removeAll', 1000]
-}
-...
-```

package/lib/rules/default-value.js

@@ -143,8 +143,16 @@ const extractCallExpression = (callExpression, sourceCode, readonly) => {
                 // This will never have a defaultValue.
                 return undefined;
             }
+            // Should not be documented.
+            if (readonly) {
+                return undefined;
+            }
             return sourceCode.getText(callExpression);
         default:
+            // Should not be documented.
+            if (readonly) {
+                return undefined;
+            }
             return sourceCode.getText(callExpression);
     }
 };
@@ -192,12 +200,7 @@ export default createRule({
         docs: {
             description: 'enforce correct @defaultValue TSDoc annotation'
         },
-        schema: [
-            {
-                type: 'string',
-                enum: ['removeAll', 'default']
-            }
-        ],
+        schema: [],
         fixable: 'code',
         messages: {
             incorrectDefaultValueAnnotation: 'Incorrect @defaultValue TSDoc annotation: {{ message }}',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siemens/eslint-plugin-defaultvalue",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "main": "lib/index.js",
   "type": "module",
   "description": "Automatically enrich TSDoc comments with default values or check if they are all correct.",