Skip to content
This repository was archived by the owner on Jan 17, 2024. It is now read-only.

Commit 5c18214

Browse files
committed
Add module template
1 parent d11cd02 commit 5c18214

File tree

8 files changed

+57
-0
lines changed

8 files changed

+57
-0
lines changed

.editorconfig

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
tab_width = 8
7+
end_of_line = lf
8+
insert_final_newline = true
9+
charset = utf-8
10+
11+
[{Makefile,**/Makefile,runtime/doc/*.txt}]
12+
indent_style = tab
13+
indent_size = 8

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,11 @@
11
# module-template
22
A repository template to create you own nvim-treesitter module !
3+
4+
Please find below the list of things you will need to do to get going !
5+
6+
# TODO (for you)
7+
After using this template, you will need to :
8+
- [ ] Rename every from `example-module` to the actual name of your module
9+
- [ ] Maybe rename the queries.
10+
- [ ] Send us a message here : [![Gitter](https://badges.gitter.im/nvim-treesitter/community.svg)](https://gitter.im/nvim-treesitter/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
11+
- [ ] Code your module !

lua/module-template.lua

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
local queries = require "nvim-treesitter.query"
2+
3+
local M = {}
4+
5+
-- TODO: In this function replace `module-template` with the actual name of your module.
6+
function M.init()
7+
require "nvim-treesitter".define_modules {
8+
module_template = {
9+
module_path = "module-template.internal",
10+
is_supported = function(lang)
11+
-- TODO: you don't want your queries to be named `awesome-query`, do you ?
12+
return queries.get_query(lang, 'awesome-query') ~= nil
13+
end
14+
}
15+
}
16+
end
17+
18+
return M

lua/module-template/internal.lua

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
local M = {}
2+
3+
function M.attach(bufnr, lang)
4+
-- TODO: Fill this with what you need to do when attaching to a buffer
5+
end
6+
7+
function M.detach(bufnr)
8+
-- TODO: Fill this with what you need to do when detaching from a buffer
9+
end
10+
11+
return M

plugin/module-template.vim

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
lua << EOF
2+
require "module-template".init()
3+
EOF

queries/c/awesome-query.scm

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
;; A query that the C filetype will search for

queries/javascript/awesome-query.scm

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
;; A query for javascript files

queries/lua/awesome-query.scm

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
;; A query for lua files

0 commit comments

Comments
 (0)