feat(doc): Generate a JSON object containing all sources (#72)

Co-authored-by: Quentin Boyer <[email protected]>

doc/builtins.json

@@ -0,0 +1 @@
+{"hover":{"printenv":{"filetypes":["sh","dosbatch","ps1"]},"dictionary":{"filetypes":["org","text","markdown"]}},"completion":{"tags":{"filetypes":[]},"luasnip":{"filetypes":[]},"vsnip":{"filetypes":[]},"spell":{"filetypes":[]}},"diagnostics":{"gospel":{"filetypes":["go"]},"pycodestyle":{"filetypes":["python"]},"stylint":{"filetypes":["stylus"]},"spectral":{"filetypes":["yaml","json"]},"erb_lint":{"filetypes":["eruby"]},"credo":{"filetypes":["elixir"]},"textlint":{"filetypes":["txt","markdown"]},"puppet_lint":{"filetypes":["puppet","epuppet"]},"markdownlint_cli2":{"filetypes":["markdown"]},"buildifier":{"filetypes":["bzl"]},"qmllint":{"filetypes":["qml"]},"glslc":{"filetypes":["glsl"]},"phpcs":{"filetypes":["php"]},"hadolint":{"filetypes":["dockerfile"]},"rpmspec":{"filetypes":["spec"]},"codespell":{"filetypes":[]},"deadnix":{"filetypes":["nix"]},"sqlfluff":{"filetypes":["sql"]},"zsh":{"filetypes":["zsh"]},"yamllint":{"filetypes":["yaml"]},"xo":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact"]},"rubocop":{"filetypes":["ruby"]},"semgrep":{"filetypes":["typescript","typescriptreact","ruby","python","java","go"]},"verilator":{"filetypes":["verilog","systemverilog"]},"markuplint":{"filetypes":["html"]},"write_good":{"filetypes":["markdown"]},"vulture":{"filetypes":["python"]},"opacheck":{"filetypes":["rego"]},"tfsec":{"filetypes":["terraform","tf","terraform-vars"]},"checkstyle":{"filetypes":["java"]},"deno_lint":{"filetypes":["javascript","typescript","typescriptreact","javascriptreact"]},"vale":{"filetypes":["markdown","tex","asciidoc"]},"vacuum":{"filetypes":["yaml","json"]},"typos":{"filetypes":[]},"protoc_gen_lint":{"filetypes":["proto"]},"commitlint":{"filetypes":["gitcommit"]},"haml_lint":{"filetypes":["haml"]},"twigcs":{"filetypes":["twig"]},"pydocstyle":{"filetypes":["python"]},"tsc":{"filetypes":["typescript","typescriptreact"]},"stylelint":{"filetypes":["scss","less","css","sass"]},"cfn_lint":{"filetypes":["yaml","json"]},"todo_comments":{"filetypes":[]},"teal":{"filetypes":["teal"]},"phpmd":{"filetypes":["php"]},"luacheck":{"filetypes":["lua"]},"proselint":{"filetypes":["markdown","tex"]},"trail_space":{"filetypes":[]},"standardjs":{"filetypes":["javascript","javascriptreact"]},"mdl":{"filetypes":["markdown"]},"cspell":{"filetypes":[]},"protolint":{"filetypes":["proto"]},"gccdiag":{"filetypes":["c","cpp"]},"vint":{"filetypes":["vim"]},"psalm":{"filetypes":["php"]},"ansiblelint":{"filetypes":["yaml.ansible"]},"reek":{"filetypes":["ruby"]},"djlint":{"filetypes":["django","jinja.html","htmldjango"]},"saltlint":{"filetypes":["sls"]},"pylama":{"filetypes":["python"]},"swiftlint":{"filetypes":["swift"]},"clang_check":{"filetypes":["c","cpp"]},"perlimports":{"filetypes":["perl"]},"jshint":{"filetypes":["javascript"]},"standardrb":{"filetypes":["ruby"]},"trivy":{"filetypes":["terraform","tf","terraform-vars"]},"statix":{"filetypes":["nix"]},"staticcheck":{"filetypes":["go"]},"misspell":{"filetypes":[]},"actionlint":{"filetypes":["yaml"]},"shellcheck":{"filetypes":["sh"]},"phpstan":{"filetypes":["php"]},"semistandardjs":{"filetypes":["javascript","javascriptreact"]},"selene":{"filetypes":["lua","luau"]},"fish":{"filetypes":["fish"]},"bslint":{"filetypes":["brs"]},"terraform_validate":{"filetypes":["terraform","tf","terraform-vars"]},"ruff":{"filetypes":["python"]},"buf":{"filetypes":["proto"]},"rstcheck":{"filetypes":["rst"]},"revive":{"filetypes":["go"]},"dotenv_linter":{"filetypes":["sh"]},"regal":{"filetypes":["rego"]},"golangci_lint":{"filetypes":["go"]},"pylint":{"filetypes":["python"]},"gdlint":{"filetypes":["gdscript"]},"mlint":{"filetypes":["matlab","octave"]},"puglint":{"filetypes":["pug"]},"textidote":{"filetypes":["markdown","tex"]},"cue_fmt":{"filetypes":["cue"]},"mypy":{"filetypes":["python"]},"cppcheck":{"filetypes":["cpp","c"]},"bandit":{"filetypes":["python"]},"npm_groovy_lint":{"filetypes":["groovy","java","Jenkinsfile"]},"solhint":{"filetypes":["solidity"]},"editorconfig_checker":{"filetypes":[]},"cmake_lint":{"filetypes":["cmake"]},"eslint_d":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue"]},"tidy":{"filetypes":["html","xml"]},"flake8":{"filetypes":["python"]},"pmd":{"filetypes":["java","jsp"]},"eslint":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue"]},"chktex":{"filetypes":["tex"]},"php":{"filetypes":["php"]},"clazy":{"filetypes":["cpp"]},"cpplint":{"filetypes":["cpp","c"]},"markdownlint":{"filetypes":["markdown"]},"pyproject_flake8":{"filetypes":["python"]},"gitlint":{"filetypes":["gitcommit"]},"jsonlint":{"filetypes":["json"]},"checkmake":{"filetypes":["make"]},"ltrs":{"filetypes":["text","markdown","markdown"]},"alex":{"filetypes":["markdown"]},"clj_kondo":{"filetypes":["clojure"]},"ktlint":{"filetypes":["kotlin"]},"curlylint":{"filetypes":["jinja.html","htmldjango"]}},"formatting":{"rubyfmt":{"filetypes":["ruby"]},"pretty_php":{"filetypes":["php"]},"dtsfmt":{"filetypes":["dts"]},"erb_lint":{"filetypes":["eruby"]},"npm_groovy_lint":{"filetypes":["groovy","java","Jenkinsfile"]},"puppet_lint":{"filetypes":["puppet","epuppet"]},"pyink":{"filetypes":["python"]},"blade_formatter":{"filetypes":["blade"]},"lua_format":{"filetypes":["lua"]},"verible_verilog_format":{"filetypes":["verilog","systemverilog"]},"asmfmt":{"filetypes":["asm"]},"gofmt":{"filetypes":["go"]},"prismaFmt":{"filetypes":["prisma"]},"csharpier":{"filetypes":["cs"]},"elm_format":{"filetypes":["elm"]},"qmlformat":{"filetypes":["qml"]},"perltidy":{"filetypes":["perl"]},"vfmt":{"filetypes":["vlang"]},"astyle":{"filetypes":["arduino","c","cpp","cs","java"]},"mix":{"filetypes":["elixir"]},"gofumpt":{"filetypes":["go"]},"eslint_d":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue"]},"gdformat":{"filetypes":["gd","gdscript","gdscript3"]},"google_java_format":{"filetypes":["java"]},"cueimports":{"filetypes":["cue"]},"gersemi":{"filetypes":["cmake"]},"pg_format":{"filetypes":["sql","pgsql"]},"emacs_scheme_mode":{"filetypes":["scheme","scheme.guile"]},"shellharden":{"filetypes":["sh"]},"goimports":{"filetypes":["go"]},"autoflake":{"filetypes":["python"]},"brittany":{"filetypes":["haskell"]},"semistandardjs":{"filetypes":["javascript","javascriptreact"]},"gn_format":{"filetypes":["gn"]},"perlimports":{"filetypes":["perl"]},"xmllint":{"filetypes":["xml"]},"dart_format":{"filetypes":["dart"]},"shfmt":{"filetypes":["sh"]},"isortd":{"filetypes":["python"]},"emacs_vhdl_mode":{"filetypes":["vhdl"]},"xq":{"filetypes":["xml"]},"styler":{"filetypes":["r","rmd"]},"phpcsfixer":{"filetypes":["php"]},"racket_fixw":{"filetypes":["racket"]},"smlfmt":{"filetypes":["sml"]},"hclfmt":{"filetypes":["hcl"]},"bean_format":{"filetypes":["beancount"]},"joker":{"filetypes":["clj"]},"markdown_toc":{"filetypes":["markdown"]},"rego":{"filetypes":["rego"]},"yamlfix":{"filetypes":["yaml"]},"pint":{"filetypes":["php"]},"htmlbeautifier":{"filetypes":["eruby"]},"remark":{"filetypes":["markdown"]},"terrafmt":{"filetypes":["markdown"]},"ktlint":{"filetypes":["kotlin"]},"raco_fmt":{"filetypes":["racket"]},"jq":{"filetypes":["json"]},"beautysh":{"filetypes":["bash","csh","ksh","sh","zsh"]},"stylish_haskell":{"filetypes":["haskell"]},"prettier":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue","css","scss","less","html","json","jsonc","yaml","markdown","markdown.mdx","graphql","handlebars"]},"cbfmt":{"filetypes":["markdown","org"]},"buildifier":{"filetypes":["bzl"]},"fish_indent":{"filetypes":["fish"]},"jsonnetfmt":{"filetypes":["jsonnet"]},"yapf":{"filetypes":["python"]},"codespell":{"filetypes":[]},"erlfmt":{"filetypes":["erlang"]},"sqlfluff":{"filetypes":["sql"]},"bibclean":{"filetypes":["bib"]},"surface":{"filetypes":["elixir","surface"]},"fixjson":{"filetypes":["json"]},"json_tool":{"filetypes":["json"]},"clang_format":{"filetypes":["c","cpp","cs","java","cuda","proto"]},"nginx_beautifier":{"filetypes":["nginx"]},"rubocop":{"filetypes":["ruby"]},"djhtml":{"filetypes":["django","jinja.html","htmldjango"]},"zigfmt":{"filetypes":["zig"]},"yq":{"filetypes":["yml","yaml"]},"yamlfmt":{"filetypes":["yaml"]},"xmlformat":{"filetypes":["xml"]},"usort":{"filetypes":["python"]},"uncrustify":{"filetypes":["c","cpp","cs","java"]},"sqlfmt":{"filetypes":["sql","jinja"]},"swiftformat":{"filetypes":["swift"]},"stylua":{"filetypes":["lua","luau"]},"trim_whitespace":{"filetypes":[]},"ptop":{"filetypes":["pascal","delphi"]},"trim_newlines":{"filetypes":[]},"haxe_formatter":{"filetypes":["haxe"]},"biome":{"filetypes":["javascript","typescript","javascriptreact","typescriptreact","json","jsonc"]},"reorder_python_imports":{"filetypes":["python"]},"just":{"filetypes":["just"]},"standardjs":{"filetypes":["javascript","javascriptreact"]},"ruff":{"filetypes":["python"]},"topiary":{"filetypes":["ncl","nickel"]},"protolint":{"filetypes":["proto"]},"nimpretty":{"filetypes":["nim"]},"cljstyle":{"filetypes":["clojure"]},"deno_fmt":{"filetypes":["javascript","javascriptreact","json","jsonc","markdown","typescript","typescriptreact"]},"textlint":{"filetypes":["txt","markdown"]},"terraform_fmt":{"filetypes":["terraform","tf","terraform-vars"]},"djlint":{"filetypes":["django","jinja.html","htmldjango"]},"templ":{"filetypes":["templ"]},"taplo":{"filetypes":["toml"]},"sqlformat":{"filetypes":["sql"]},"black":{"filetypes":["python"]},"swift_format":{"filetypes":["swift"]},"ocamlformat":{"filetypes":["ocaml"]},"standardrb":{"filetypes":["ruby"]},"swiftlint":{"filetypes":["swift"]},"typstfmt":{"filetypes":["typ","typst"]},"stylelint":{"filetypes":["scss","less","css","sass"]},"rescript":{"filetypes":["rescript"]},"rufo":{"filetypes":["ruby"]},"docformatter":{"filetypes":["python"]},"standardts":{"filetypes":["typescript","typescriptreact"]},"nixfmt":{"filetypes":["nix"]},"scalafmt":{"filetypes":["scala"]},"goimports_reviser":{"filetypes":["go"]},"fantomas":{"filetypes":["fsharp"]},"sql_formatter":{"filetypes":["sql"]},"fprettify":{"filetypes":["fortran"]},"buf":{"filetypes":["proto"]},"crystal_format":{"filetypes":["crystal"]},"fnlfmt":{"filetypes":["fennel","fnl"]},"blackd":{"filetypes":["python"]},"purs_tidy":{"filetypes":["purescript"]},"blue":{"filetypes":["python"]},"forge_fmt":{"filetypes":["solidity"]},"treefmt":{"filetypes":[]},"d2_fmt":{"filetypes":["d2"]},"format_r":{"filetypes":["r","rmd"]},"dprint":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","json","jsonc","markdown","python","toml","rust","roslyn"]},"nixpkgs_fmt":{"filetypes":["nix"]},"rustfmt":{"filetypes":["rust"]},"golines":{"filetypes":["go"]},"latexindent":{"filetypes":["tex"]},"cue_fmt":{"filetypes":["cue"]},"cmake_format":{"filetypes":["cmake"]},"dfmt":{"filetypes":["d"]},"prettierd":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue","css","scss","less","html","json","jsonc","yaml","markdown","markdown.mdx","graphql","handlebars"]},"erb_format":{"filetypes":["eruby"]},"tidy":{"filetypes":["html","xml"]},"zprint":{"filetypes":["clojure"]},"autopep8":{"filetypes":["python"]},"eslint":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue"]},"ocdc":{"filetypes":["markdown"]},"ruff_format":{"filetypes":["python"]},"bsfmt":{"filetypes":["brs"]},"mdformat":{"filetypes":["markdown"]},"markdownlint":{"filetypes":["markdown"]},"pyflyby":{"filetypes":["python"]},"cabal_fmt":{"filetypes":["cabal"]},"isort":{"filetypes":["python"]},"leptosfmt":{"filetypes":["rust"]},"fourmolu":{"filetypes":["haskell"]},"packer":{"filetypes":["hcl"]},"phpcbf":{"filetypes":["php"]},"alejandra":{"filetypes":["nix"]},"rustywind":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue","svelte","html"]}},"code_actions":{"regal":{"filetypes":["rego"]},"eslint":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue"]},"statix":{"filetypes":["nix"]},"xo":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact"]},"shellcheck":{"filetypes":["sh"]},"refactoring":{"filetypes":["go","javascript","lua","python","typescript"]},"gitsigns":{"filetypes":[]},"ts_node_action":{"filetypes":[]},"proselint":{"filetypes":["markdown","tex"]},"eslint_d":{"filetypes":["javascript","javascriptreact","typescript","typescriptreact","vue"]},"cspell":{"filetypes":[]},"gitrebase":{"filetypes":["gitrebase"]},"gomodifytags":{"filetypes":["go"]},"ltrs":{"filetypes":["text","markdown"]},"impl":{"filetypes":["go"]}}}

scripts/autogen.lua

@@ -20,6 +20,7 @@ local NULL_LS_DIR = vim.loop.cwd()
 local BUILTINS_DIR = join_paths(NULL_LS_DIR, "lua", "null-ls", "builtins")
 local META_DIR = join_paths(BUILTINS_DIR, "_meta")
 local DOC_FILE = join_paths(NULL_LS_DIR, "doc", "BUILTINS.md")
+local JSON_FILE = join_paths(NULL_LS_DIR, "doc", "builtins.json")
 local BUILTINS_URL_TEMPLATE = "https://github.com/nvimtools/none-ls.nvim/blob/main/lua/null-ls/builtins/%s/%s.lua"
 
 -- metadata
@@ -300,4 +301,5 @@ do
 
     write_file(metadata_files.ft_map, generate_meta_table(filetypes), "w")
     write_file(DOC_FILE, generate_documentation(), "w")
+    write_file(JSON_FILE, vim.json.encode(sources), "w")
 end