Giter VIP home page Giter VIP logo

Comments (1)

EdJoPaTo avatar EdJoPaTo commented on June 3, 2024

The current xo rules are requiring types. This is good for JavaScript Documentation but bad for TypeScript documentation.
The eslint built in valid-jsdoc has requireParamType and requireReturnType. They could be set to false (in the typescript ruleset) but they don't enforce something.

As ESLint drops support for JSDoc rules (see xojs/xo#378) the suggested eslint-plugin-jsdoc rules will be better.

Also I have a simple example of the current warnings with xo:

/**
 * Does foobar things
 *
 * @param  bar <docs>
 * @return <docs>
 */
function foo(bar: string): string {
  return bar
}
  ⚠    1:1   Missing JSDoc return type.            valid-jsdoc
  ⚠    4:4   Missing JSDoc parameter type for bar. valid-jsdoc

from eslint-config-xo-typescript.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.