GithubHelp home page GithubHelp logo

Comments (4)

TheSonOfThomp avatar TheSonOfThomp commented on September 26, 2024 1

Exactly, yeah. Something defined in the schema as:

schema: [{
  type: "string",
  description: "..."
}]

I'm able to use an object property for now (which may be a better api for my case)

from eslint-doc-generator.

TheSonOfThomp avatar TheSonOfThomp commented on September 26, 2024

Unless I'm missing something, options defined as type: "string" will also not show up in the docs automatically

from eslint-doc-generator.

bmish avatar bmish commented on September 26, 2024

@TheSonOfThomp I assume you mean a rule like quotes that is configured with a string value instead of an object: quotes: ["error", "double"]. Yes, we haven't supported that type of rule config yet.

from eslint-doc-generator.

bmish avatar bmish commented on September 26, 2024

An object API for rules is almost always a better choice as it allows you to add additional options later (much more future-proof). However, it would still be good for us to support the basic string scenario.

from eslint-doc-generator.

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.