Track options - Githubissues

cljs / api

ClojureScript API parser

http://cljs.github.io/api/

MIT License

193 stars 23 forks source link

Track options #160

Open shaunlebron opened 8 years ago

shaunlebron commented 8 years ago

For example:

ns has what could be considered options
compiler options
repl options

shaunlebron commented 7 years ago

I think it makes sense to have entries for each compiler and repl option since they are often referred to by functions and vars that use them. I don't think this is the case for ns options, and it is easy to determine where to find them since they are under the ns form and thus ns api entry.

shaunlebron commented 7 years ago

Used Figwheel's compiler option docs as reference: https://github.com/bhauman/lein-figwheel/blob/master/sidecar/src/figwheel_sidecar/schemas/cljs_options.clj

shaunlebron commented 7 years ago

There are some options for which source functions could be included to clarify the usage and implementation.

source-map-asset-path in emit-source-map

shaunlebron commented 7 years ago

examples of options we can make:

ns/require
- require/refer
ns/require-macros
- require-macros/refer
foreign-libs/file-min
destructure-vector/as
destructure-map/keys

I think it is okay to leave the markdown files for these minor options empty, and just use them for tracking when they're added, allowing a better search index, and allowing URLs to where they are documented (as anchor links to where they are mentioned in their parent's page)