Flexible grammar installer

LICENSE

@@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+

README.md

@@ -14,21 +14,69 @@ It is work in progress, but functions well.
 | ![](before.png)                                |                                 ![](after.png) |
 
 # Supported Languages
-- [x] [C][tree-sitter-c]
-- [x] [C++][tree-sitter-cpp]
-- [ ] CSS
-- [x] [D][tree-sitter-d]
-- [x] [Diff][tree-sitter-diff]
-- [x] [Go][tree-sitter-go]
-- [x] [go.mod][tree-sitter-go-mod]
-- [ ] HTML
-- [x] [Javascript/JSX][tree-sitter-javascript]
-- [x] [Julia][tree-sitter-julia]
-- [x] [Lua][tree-sitter-lua]
-- [x] [Rust][tree-sitter-rust]
-- [x] [Zig][tree-sitter-zig]
-
-If you want more languages supported, open an issue.
+
+Any language supported by `tree-sitter` should (in theory) be supported as well.
+
+It is possible to use grammar installed locally or directly from their git repository. Additionally 
+it is possible to specify where to find the queries of the language as well as use sub path for projects
+containing more then one language.
+
+## Locally installed grammars
+
+To add a grammar to lite-xl simply add the following configuration to your `init.lua` script:
+
+```lua
+local langs = require "plugins.evergreen.languages"
+
+langs.add_grammar {
+  path = "YOUR GRAMMAR LOCAL PATH",
+  lang = "LANGUAGE NAME",
+  extensions = "FILE EXTENSIONS", -- optional for extension name based
+  filename = "FILE NAME", -- optional for file name based 
+  queries = "QUERIES SUB PATH", -- optional sub path of grammar queries, default = 'queries'
+}
+```
+
+## From git repository 
+To add a grammar directly from a git repository add this to your `init.lua` scripts:
+
+```lua
+local langs = require "plugins.evergreen.languages"
+langs.add_grammar {
+  git = "GIT REPO",
+  lang = "LANGUAGE NAME",
+  extensions = "FILE EXTENSIONS", -- optional for extension name based
+  filename = "FILE NAME", -- optional for file name based 
+  queries = "QUERIES SUB PATH", -- optional sub path of grammar queries, default = 'queries'
+  subpath = "GRAMMAR SUB PATH", -- optional sub path if grammar is nested, default = nil
+  revision = "SPECIFIC GIT REVISION", -- optional version of the code to clone
+}
+```
+
+## Example 
+
+```lua
+local languages = require "plugins.evergreen.languages"
+
+languages.add_grammar {
+  path = "~/.grammars/tree-sitter-epics/epics-db",
+  lang = "epics_db",
+  extensions = "db,vdb",
+}
+
+languages.add_grammar {
+  git = "https://github.com/tree-sitter/tree-sitter-cpp.git",
+  lang = "cpp",
+  extensions = "cpp,hpp,cc",
+}
+
+languages.add_grammar {
+  git = "https://github.com/tree-sitter/tree-sitter-c.git",
+  lang = "c",
+  extensions = "c,h",
+}
+
+```
 
 # Requirements
 - Lite XL 2.1+ or [Pragtical](https://github.com/pragtical/pragtical)
@@ -39,7 +87,7 @@ If you want more languages supported, open an issue.
 Evergreen can be easily installed with [Miq](https://github.com/TorchedSammy/Miq) by
 adding this to your plugin declaration:
 ```lua
-{'TorchedSammy/Evergreen.lxl'},
+{'TorchedSammy/Evergreen.lxl'}
 ```
 
 ## Manually

config.lua

@@ -8,5 +8,7 @@ local M = {
 }
 
 M.parserLocation = util.join {M.dataDir, 'parsers'}
+M.queryLocation = util.join {M.dataDir, 'queries'}
 
 return M
+

highlights.lua

@@ -1,5 +1,6 @@
 local parser = require 'plugins.evergreen.parser'
 local languages = require 'plugins.evergreen.languages'
+local config = require 'plugins.evergreen.config'
 
 local M = {}
 
@@ -9,7 +10,7 @@ local function localPath()
 end
 
 function M.query(ftype)
-	local ff = io.open(string.format('%s/queries/%s/highlights.scm', localPath(), ftype))
+	local ff = io.open(string.format('%s/%s/highlights.scm', config.queryLocation, ftype))
 	if not ff then
 		return ""
 	end
@@ -86,3 +87,4 @@ function M.init(doc)
 end
 
 return M
+

init.lua

@@ -11,6 +11,7 @@ end
 
 system.mkdir(config.dataDir)
 system.mkdir(config.parserLocation)
+system.mkdir(config.queryLocation)
 
 appendPaths {
 	util.join {config.dataDir, '?' .. util.soname},
@@ -71,7 +72,6 @@ local Highlight = require 'core.doc.highlighter'
 local parser = require 'plugins.evergreen.parser'
 local highlights = require 'plugins.evergreen.highlights'
 require 'plugins.evergreen.style'
-require 'plugins.evergreen.installer'
 
 --- @class core.doc
 --- @field treesit boolean
@@ -255,3 +255,4 @@ command.add('core.docview!', {
 		end
 	end
 })
+