Skip to content

Commit 8a7be83

Browse files
lambdalisuelambdalisue
committed
📝 Use relative path to fix type-check on README
1 parent fbd4bee commit 8a7be83

File tree

10 files changed

+93
-97
lines changed

10 files changed

+93
-97
lines changed

‎denops_std/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ for a plugin.
1212
By using this module, developers can write Vim/Neovim denops plugins like:
1313

1414
```typescript
15-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
16-
import * as fn from "https://deno.land/x/denops_std/function/mod.ts";
17-
import * as vars from "https://deno.land/x/denops_std/variable/mod.ts";
18-
import * as helper from "https://deno.land/x/denops_std/helper/mod.ts";
15+
import { Denops } from "./mod.ts";
16+
import * as fn from "./function/mod.ts";
17+
import * as vars from "./variable/mod.ts";
18+
import * as helper from "./helper/mod.ts";
1919

2020
import { assertString } from "https://deno.land/x/unknownutil/mod.ts";
2121

‎denops_std/anonymous/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Use `add()` to add new anonymous functions and use return value as unique IDs to
1313
call added functions later like:
1414

1515
```typescript
16-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
17-
import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
16+
import { Denops } from "../mod.ts";
17+
import * as anonymous from "./mod.ts";
1818

1919
export async function main(denops: Denops): Promise<void> {
2020
// Add anonymous functions
@@ -46,8 +46,8 @@ export async function main(denops: Denops): Promise<void> {
4646
If you need one-time anonymous function, use `once()` instead like:
4747

4848
```typescript
49-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
50-
import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
49+
import { Denops } from "../mod.ts";
50+
import * as anonymous from "../anonymous/mod.ts";
5151

5252
export async function main(denops: Denops): Promise<void> {
5353
// Add anonymous functions
@@ -76,8 +76,8 @@ export async function main(denops: Denops): Promise<void> {
7676
When you need to remove callback, use `remove()` like:
7777

7878
```typescript
79-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
80-
import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
79+
import { Denops } from "../mod.ts";
80+
import * as anonymous from "../anonymous/mod.ts";
8181

8282
export async function main(denops: Denops): Promise<void> {
8383
// Add anonymous functions

‎denops_std/autocmd/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Use `group()` to create an autocmd group and define/remove autocmds in that
1212
group like:
1313

1414
```typescript
15-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
16-
import * as autocmd from "https://deno.land/x/denops_std/autocmd/mod.ts";
15+
import { Denops } from "../mod.ts";
16+
import * as autocmd from "../autocmd/mod.ts";
1717

1818
export async function main(denops: Denops): Promise<void> {
1919
await autocmd.group(denops, "my-autocmd", (helper) => {
@@ -53,8 +53,8 @@ autocmd group and the number of RPC calls is minimized.
5353
Use `define()` to define new autocmd like:
5454

5555
```typescript
56-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
57-
import * as autocmd from "https://deno.land/x/denops_std/autocmd/mod.ts";
56+
import { Denops } from "../mod.ts";
57+
import * as autocmd from "../autocmd/mod.ts";
5858

5959
export async function main(denops: Denops): Promise<void> {
6060
// Define new autocmd for BufEnter
@@ -85,8 +85,8 @@ export async function main(denops: Denops): Promise<void> {
8585
Use `remove()` to remove an autocmd like:
8686

8787
```typescript
88-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
89-
import * as autocmd from "https://deno.land/x/denops_std/autocmd/mod.ts";
88+
import { Denops } from "../mod.ts";
89+
import * as autocmd from "../autocmd/mod.ts";
9090

9191
export async function main(denops: Denops): Promise<void> {
9292
// Remove BufEnter autocmd
@@ -110,8 +110,8 @@ export async function main(denops: Denops): Promise<void> {
110110
Use `list()` to list defined autocmd like:
111111

112112
```typescript
113-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
114-
import * as autocmd from "https://deno.land/x/denops_std/autocmd/mod.ts";
113+
import { Denops } from "../mod.ts";
114+
import * as autocmd from "../autocmd/mod.ts";
115115

116116
export async function main(denops: Denops): Promise<void> {
117117
// List all autocmd
@@ -133,8 +133,8 @@ export async function main(denops: Denops): Promise<void> {
133133
Use `emit()` to emit autocmd in a buffer like:
134134

135135
```typescript
136-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
137-
import * as autocmd from "https://deno.land/x/denops_std/autocmd/mod.ts";
136+
import { Denops } from "../mod.ts";
137+
import * as autocmd from "../autocmd/mod.ts";
138138

139139
export async function main(denops: Denops): Promise<void> {
140140
// Emit an autocmd in a current buffer
@@ -153,8 +153,8 @@ export async function main(denops: Denops): Promise<void> {
153153
Use `emitAll()` to emit autocmd in all buffers like:
154154

155155
```typescript
156-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
157-
import * as autocmd from "https://deno.land/x/denops_std/autocmd/mod.ts";
156+
import { Denops } from "../mod.ts";
157+
import * as autocmd from "../autocmd/mod.ts";
158158

159159
export async function main(denops: Denops): Promise<void> {
160160
// Emit an autocmd in all buffers

‎denops_std/batch/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Use `batch()` to call multiple denops functions sequentially without overhead
1212
like:
1313

1414
```typescript
15-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
16-
import { batch } from "https://deno.land/x/denops_std/batch/mod.ts";
15+
import { Denops } from "../mod.ts";
16+
import { batch } from "../batch/mod.ts";
1717

1818
export async function main(denops: Denops): Promise<void> {
1919
await batch(denops, async (denops) => {
@@ -28,8 +28,8 @@ The function can be nested thus users can use functions which may internally use
2828
`batch()` like:
2929

3030
```typescript
31-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
32-
import { batch } from "https://deno.land/x/denops_std/batch/mod.ts";
31+
import { Denops } from "../mod.ts";
32+
import { batch } from "../batch/mod.ts";
3333

3434
async function replace(denops: Denops, content: string): Promise<void> {
3535
await batch(denops, async (denops) => {
@@ -53,8 +53,8 @@ Note that `denops.call()`, `denops.batch()`, or `denops.eval()` always return
5353
falsy value in `batch()`, indicating that you **cannot** write code like below:
5454

5555
```typescript
56-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
57-
import { batch } from "https://deno.land/x/denops_std/batch/mod.ts";
56+
import { Denops } from "../mod.ts";
57+
import { batch } from "../batch/mod.ts";
5858

5959
export async function main(denops: Denops): Promise<void> {
6060
await batch(denops, async (denops) => {
@@ -72,9 +72,9 @@ the block. It works like a real `denops` instance, mean that you can write code
7272
like:
7373

7474
```typescript
75-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
76-
import { batch } from "https://deno.land/x/denops_std/batch/mod.ts";
77-
import * as anonymous from "https://deno.land/x/denops_std/anonymous/mod.ts";
75+
import { Denops } from "../mod.ts";
76+
import { batch } from "../batch/mod.ts";
77+
import * as anonymous from "../anonymous/mod.ts";
7878

7979
export async function main(denops: Denops): Promise<void> {
8080
await batch(denops, async (denops) => {
@@ -100,8 +100,8 @@ Use `gather()` to call multiple denops functions sequentially without overhead
100100
and return values like:
101101

102102
```typescript
103-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
104-
import { gather } from "https://deno.land/x/denops_std/batch/mod.ts";
103+
import { Denops } from "../mod.ts";
104+
import { gather } from "../batch/mod.ts";
105105

106106
export async function main(denops: Denops): Promise<void> {
107107
const results = await gather(denops, async (denops) => {
@@ -119,8 +119,8 @@ Note that `denops.call()` or `denops.eval()` always return falsy value in
119119
`gather()`, indicating that you **cannot** write code like below:
120120

121121
```typescript
122-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
123-
import { gather } from "https://deno.land/x/denops_std/batch/mod.ts";
122+
import { Denops } from "../mod.ts";
123+
import { gather } from "../batch/mod.ts";
124124

125125
export async function main(denops: Denops): Promise<void> {
126126
const results = await gather(denops, async (denops) => {

‎denops_std/bufname/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ instance like:
5454

5555
```typescript
5656
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
57-
import { format } from "https://deno.land/x/denops_std/bufname/mod.ts";
57+
import { format } from "../bufname/mod.ts";
5858

5959
assertEquals(
6060
format({
@@ -107,7 +107,7 @@ constructing a buffer name from a real path. For example
107107
```typescript
108108
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
109109
import * as path from "https://deno.land/std/path/mod.ts";
110-
import { format } from "https://deno.land/x/denops_std/bufname/mod.ts";
110+
import { format } from "../bufname/mod.ts";
111111

112112
// NOTE:
113113
// Works only on Windows (Use path.win32.toFileUrl instead on other platforms)
@@ -126,7 +126,7 @@ Use `parse()` to parse Vim's buffer name and get a `Bufname` instance like
126126

127127
```typescript
128128
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
129-
import { parse } from "https://deno.land/x/denops_std/bufname/mod.ts";
129+
import { parse } from "../bufname/mod.ts";
130130

131131
assertEquals(
132132
parse("denops:///Users/John Titor/test.git"),
@@ -181,7 +181,7 @@ was constructed from a real path. For example
181181
```typescript
182182
import { assertEquals } from "https://deno.land/std/testing/asserts.ts";
183183
import * as path from "https://deno.land/std/path/mod.ts";
184-
import { parse } from "https://deno.land/x/denops_std/bufname/mod.ts";
184+
import { parse } from "../bufname/mod.ts";
185185

186186
const bufname = parse("denops:///C:/Users/John%20Titor/test.git");
187187
assertEquals(bufname, {

‎denops_std/function/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ in minimal supported Vim and Neovim versions.
1414
## Example
1515

1616
```typescript
17-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
18-
import * as fn from "https://deno.land/x/denops_std/function/mod.ts";
19-
import * as vimFn from "https://deno.land/x/denops_std/function/vim/mod.ts";
20-
import * as nvimFn from "https://deno.land/x/denops_std/function/nvim/mod.ts";
17+
import { Denops } from "../mod.ts";
18+
import * as fn from "../function/mod.ts";
19+
import * as vimFn from "../function/vim/mod.ts";
20+
import * as nvimFn from "../function/nvim/mod.ts";
2121

2222
export async function main(denops: Denops): Promise<void> {
2323
// fn holds functions exists in both Vim and Neovim

‎denops_std/helper/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ won't show messages reported from channel commands. It's same for
1313
`denops.cmd('echo "Hello\nWorld!"')` in Neovim.
1414

1515
```typescript
16-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
17-
import { echo, echoerr } from "https://deno.land/x/denops_std/helper/mod.ts";
16+
import { Denops } from "../mod.ts";
17+
import { echo, echoerr } from "../helper/mod.ts";
1818

1919
export async function main(denops: Denops): Promise<void> {
2020
await echo(denops, "Hello\nWorld!");
@@ -31,8 +31,8 @@ functions.
3131
Note that it prints a stack trace when denops is running in debug mode.
3232

3333
```typescript
34-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
35-
import { friendlyCall } from "https://deno.land/x/denops_std/helper/mod.ts";
34+
import { Denops } from "../mod.ts";
35+
import { friendlyCall } from "../helper/mod.ts";
3636

3737
export async function main(denops: Denops): Promise<void> {
3838
denops.dispatcher = {
@@ -53,8 +53,8 @@ Use `input()` which is a wrapper function of `input()` in
5353
like:
5454

5555
```typescript
56-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
57-
import { input } from "https://deno.land/x/denops_std/helper/mod.ts";
56+
import { Denops } from "../mod.ts";
57+
import { input } from "../helper/mod.ts";
5858

5959
export async function main(denops: Denops): Promise<void> {
6060
console.log(
@@ -74,8 +74,8 @@ It accepts a TypeScript callback as a completion function addition to built-in
7474
completions and Vim script custom completion like:
7575

7676
```typescript
77-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
78-
import { input } from "https://deno.land/x/denops_std/helper/mod.ts";
77+
import { Denops } from "../mod.ts";
78+
import { input } from "../helper/mod.ts";
7979

8080
export async function main(denops: Denops): Promise<void> {
8181
// Built-in completions
@@ -117,8 +117,8 @@ If you'd like to guard input by `inputsave()` and `inputrestore()`, use
117117
`inputsave` option like:
118118

119119
```typescript
120-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
121-
import { input } from "https://deno.land/x/denops_std/helper/mod.ts";
120+
import { Denops } from "../mod.ts";
121+
import { input } from "../helper/mod.ts";
122122

123123
export async function main(denops: Denops): Promise<void> {
124124
denops.dispatcher = {
@@ -142,8 +142,8 @@ function on that module instead.
142142
Use `execute()` to execute multi-lined Vim script like:
143143

144144
```typescript
145-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
146-
import { execute } from "https://deno.land/x/denops_std/helper/mod.ts";
145+
import { Denops } from "../mod.ts";
146+
import { execute } from "../helper/mod.ts";
147147

148148
export async function main(denops: Denops): Promise<void> {
149149
await execute(
@@ -177,8 +177,8 @@ export async function main(denops: Denops): Promise<void> {
177177
Use `load()` to load a local or remote Vim script like:
178178

179179
```typescript
180-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
181-
import { load } from "https://deno.land/x/denops_std/helper/mod.ts";
180+
import { Denops } from "../mod.ts";
181+
import { load } from "../helper/mod.ts";
182182

183183
export async function main(denops: Denops): Promise<void> {
184184
// Load '../../foo.vim' from this file
@@ -193,8 +193,8 @@ It does nothing if the `url` is already loaded unless `force` option is
193193
specified like:
194194

195195
```typescript
196-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
197-
import { load } from "https://deno.land/x/denops_std/helper/mod.ts";
196+
import { Denops } from "../mod.ts";
197+
import { load } from "../helper/mod.ts";
198198

199199
export async function main(denops: Denops): Promise<void> {
200200
const url = new URL("../../foo.vim", import.meta.url);
@@ -213,8 +213,8 @@ export async function main(denops: Denops): Promise<void> {
213213
It returns `true` when the script is loaded. Otherwise, it returns `false` like:
214214

215215
```typescript
216-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
217-
import { load } from "https://deno.land/x/denops_std/helper/mod.ts";
216+
import { Denops } from "../mod.ts";
217+
import { load } from "../helper/mod.ts";
218218

219219
export async function main(denops: Denops): Promise<void> {
220220
const url = new URL("../../foo.vim", import.meta.url);

‎denops_std/mapping/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
Use `map()` to register a mapping like:
1212

1313
```typescript
14-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
15-
import * as mapping from "https://deno.land/x/denops_std/mapping/mod.ts";
14+
import { Denops } from "../mod.ts";
15+
import * as mapping from "../mapping/mod.ts";
1616

1717
export async function main(denops: Denops): Promise<void> {
1818
await mapping.map(denops, "<Plug>(test-denops-std)", "Hello");
@@ -25,8 +25,8 @@ export async function main(denops: Denops): Promise<void> {
2525
Users can specify multiple `mode` value like:
2626

2727
```typescript
28-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
29-
import * as mapping from "https://deno.land/x/denops_std/mapping/mod.ts";
28+
import { Denops } from "../mod.ts";
29+
import * as mapping from "../mapping/mod.ts";
3030

3131
export async function main(denops: Denops): Promise<void> {
3232
await mapping.map(denops, "<Plug>(test-denops-std)", "Hello", {
@@ -40,8 +40,8 @@ export async function main(denops: Denops): Promise<void> {
4040
Use `unmap()` to unregister a mapping like:
4141

4242
```typescript
43-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
44-
import * as mapping from "https://deno.land/x/denops_std/mapping/mod.ts";
43+
import { Denops } from "../mod.ts";
44+
import * as mapping from "../mapping/mod.ts";
4545

4646
export async function main(denops: Denops): Promise<void> {
4747
await mapping.map(denops, "<Plug>(test-denops-std)", "Hello");
@@ -59,8 +59,8 @@ export async function main(denops: Denops): Promise<void> {
5959
Users can specify multiple `mode` value like:
6060

6161
```typescript
62-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
63-
import * as mapping from "https://deno.land/x/denops_std/mapping/mod.ts";
62+
import { Denops } from "../mod.ts";
63+
import * as mapping from "../mapping/mod.ts";
6464

6565
export async function main(denops: Denops): Promise<void> {
6666
await mapping.map(denops, "<Plug>(test-denops-std)", "Hello", {
@@ -78,8 +78,8 @@ export async function main(denops: Denops): Promise<void> {
7878
Use `read()` to read a mapping like:
7979

8080
```typescript
81-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
82-
import * as mapping from "https://deno.land/x/denops_std/mapping/mod.ts";
81+
import { Denops } from "../mod.ts";
82+
import * as mapping from "../mapping/mod.ts";
8383

8484
export async function main(denops: Denops): Promise<void> {
8585
await denops.cmd(`map <Plug>(test-denops-std) Hello`);
@@ -99,8 +99,8 @@ export async function main(denops: Denops): Promise<void> {
9999
Use `list()` to list mappings like:
100100

101101
```typescript
102-
import { Denops } from "https://deno.land/x/denops_std/mod.ts";
103-
import * as mapping from "https://deno.land/x/denops_std/mapping/mod.ts";
102+
import { Denops } from "../mod.ts";
103+
import * as mapping from "../mapping/mod.ts";
104104

105105
export async function main(denops: Denops): Promise<void> {
106106
const result = await mapping.list(denops, "<Plug>");

0 commit comments

Comments
 (0)