Skip to content

Commit

Permalink
Merge pull request #66 from kyoh86/describe-tree-path
Browse files Browse the repository at this point in the history
Describe two representation ways of the TreePath
  • Loading branch information
Shougo authored Jul 9, 2023
2 parents 11c81d8 + 5aee98d commit 1188a06
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
4 changes: 4 additions & 0 deletions denops/ddu/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ export type KindName = string;
export type ColumnName = string;
export type ActionName = string;

// TreePath is the path (string) or list of the path segments(string[])
// You can represents two ways for one path like below.
// "/aa/bb/cc"
// ["/", "aa", "bb", "cc"]
export type TreePath = string | string[];

export type Context = {
Expand Down
9 changes: 9 additions & 0 deletions doc/ddu.txt
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,9 @@ resume (boolean)
searchPath (string | string[])
Search the path. This only works when specified |ddu#start()|
or |ddu#redraw()|.
NOTE: You can represents a path by two way like below.
"/aa/bb/cc" (string)
["/", "aa", "bb", "cc"] (string[])
NOTE: The path must be absolute path.

Default: ""
Expand Down Expand Up @@ -722,6 +725,9 @@ maxItems (number)
*ddu-source-option-path*
path (string | string[])
Specify an initial narrowing path.
NOTE: You can represents a path by two way like below.
"/aa/bb/cc" (string)
["/", "aa", "bb", "cc"] (string[])
NOTE: It must be full path.

*ddu-source-option-sorters*
Expand Down Expand Up @@ -1091,6 +1097,9 @@ status (object) (Optional)
*ddu-item-attribute-treePath*
treePath (string | string[]) (Optional)
The item tree path.
NOTE: You can represents a path by two way like below.
"/aa/bb/cc" (string)
["/", "aa", "bb", "cc"] (string[])
NOTE: The attribute must be set to support tree feature.

*ddu-item-attribute-word*
Expand Down

0 comments on commit 1188a06

Please sign in to comment.