Skip to content

Syntax error in type: String eslint jsdoc/valid-types #874

@fab1o

Description

@fab1o

Getting error:

Syntax error in type: String eslint jsdoc/valid-types
Syntax error in namepath: value eslint jsdoc/valid-types

Uppercase String is not working

/**
 * @param {String} value
 * @desc Parses strings
 * @returns {String}
 */
function parseString(value) {
    return '';
}
plugins: ['jsdoc'],
    extends: ['plugin:jsdoc/recommended'],
    rules: {
        'jsdoc/no-undefined-types': 'off'
    },
    settings: {
        jsdoc: {
            preferredTypes: {
                string: {
                    message: 'Wrong @{{tagName}}{{tagValue}} type "string"; prefer: String',
                    replacement: 'String'
                }
            },
            tagNamePreference: {
                return: {
                    message: '@returns is to be used over @return',
                    replacement: 'returns'
                },
                description: {
                    message: '@desc is to be used over @description',
                    replacement: 'desc'
                }
            }
        }
    }

What am I missing?

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions