/
dial.jax
1537 lines (1286 loc) · 55.7 KB
/
dial.jax
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
*dial.txt* CTRL-A / CTRL-X を拡張するLua製プラグイン
Vimの標準機能である CTRL-A / CTRL-X を拡張し、英数字に限らない様々な文字列を
インクリメント/デクリメントできるようにするパッケージです。
Author: Mogami Shinichi (@monaqa) <cmonaqa{at}google.com>
Version: 0.3.0
License: MIT license
<https://github.com/monaqa/dial.nvim/blob/master/LICENSE>
==============================================================================
CONTENTS *dial-contents*
Requirements |dial-requirements|
Introduction |dial-introduction|
Features |dial-features|
Usage |dial-usage|
Configurations |dial-config|
Aliases |dial-aliases|
Augends |dial-augends|
Number |dial-augends-number|
Date |dial-augends-date|
Constant |dial-augends-constant|
Case |dial-augends-case|
Hexcolor |dial-augends-hexcolor|
Semver |dial-augends-semver|
Paren |dial-augends-paren|
Misc |dial-augends-misc|
User |dial-augends-user|
Advanced Usage |dial-advanced-usage|
Dot Repeating |dial-dot-repeating|
Additive Dot Repeating |dial-additive-dot-repeating|
Interface |dial-interface|
Mapping |dial-mapping|
Command |dial-command|
Lua API |dial-lua-api|
==============================================================================
REQUIREMENTS *dial-requirements*
* Neovim 0.6.1 or later（0.5.0 以降なら動くと考えられますが保証はしません）
==============================================================================
INTRODUCTION *dial-introduction*
*dial.nvim* は、様々な形式の文字列をインクリメント/デクリメントするパッケージ
です。標準の CTRL-A や CTRL-X、 g CTRL-A といったコマンドの動作を拡張します。
------------------------------------------------------------------------------
FEATURES *dial-features*
多岐にわたる文字列の増減~
以下のように、さまざまな文字列を増減できます。
* n 進数 (`2 <= n <= 36`) の整数
* 日付
* キーワードや演算子など、所定文字列のトグル
* `true` ⇄ `false`
* `&&` ⇄ `||`
* `a` ⇄ `b` ⇄ ... ⇄ `z`
* `日` ⇄ `月` ⇄ ... ⇄ `土` ⇄ `日` ⇄ ...
* 識別子の命名規則 (camelCase, snake_case, etc.)
* Hex color
* SemVer
カスタムルールに基づく増減ルールを設定することも可能です。
増減対象の (augend) の柔軟な設定~
|dial.nvim| が提供する増減ルールは多岐にわたりますが、ユーザは本当に必要な
ものだけを選択して有効化することができます。
競合するルール（例: `mm/dd/yyyy`形式の日付と`dd/mm/yyyy`形式の日付）がある
場合も、片方だけを有効化することによって取り違えることなく増減操作を行うこ
とができます。
特定のバッファやファイルタイプでのみ増減対象を変更することも可能です。
カウンタへの対応~
通常の CTRL-A / CTRL-X と同様に、 `10<C-a>` のように打つことで加数を変更で
きます。
ドットリピートへの対応~
通常の CTRL-A / CTRL-X と同様に、|.| を用いて直前の操作を繰り返せます。
|dial.nvim| では直前の増減対象を記憶しており、たとえば直前に「`yyyy/mm/dd`
形式の月」をインクリメントしていた場合は、たとえより手前に他の増減対象文字
列があったとしても「`yyyy/mm/dd`形式の月」を探してインクリメントします。
VISUAL mode での操作に対応~
標準の CTRL-A や CTRL-X は VISUAL モードでも用いることができますが、同様
の機能を dial.nvim も備えています。 |v_g_CTRL-A| や |v_g_CTRL-X| にも対応
しています。NORMAL モードとVISUAL モードで増減対象を変えることもできます。
==============================================================================
USAGE *dial-usage*
|dial.nvim|自身はキーマップの設定および上書きを行わないため、プラグインを動作
させるために以下の設定を追加する必要があります。
>
nmap <C-a> <Plug>(dial-increment)
nmap <C-x> <Plug>(dial-decrement)
nmap g<C-a> g<Plug>(dial-increment)
nmap g<C-x> g<Plug>(dial-decrement)
vmap <C-a> <Plug>(dial-increment)
vmap <C-x> <Plug>(dial-decrement)
vmap g<C-a> g<Plug>(dial-increment)
vmap g<C-x> g<Plug>(dial-decrement)
<
もしくは Lua 上で以下のように設定することもできます。
>
vim.keymap.set("n", "<C-a>", function()
require("dial.map").manipulate("increment", "normal")
end)
vim.keymap.set("n", "<C-x>", function()
require("dial.map").manipulate("decrement", "normal")
end)
vim.keymap.set("n", "g<C-a>", function()
require("dial.map").manipulate("increment", "gnormal")
end)
vim.keymap.set("n", "g<C-x>", function()
require("dial.map").manipulate("decrement", "gnormal")
end)
vim.keymap.set("v", "<C-a>", function()
require("dial.map").manipulate("increment", "visual")
end)
vim.keymap.set("v", "<C-x>", function()
require("dial.map").manipulate("decrement", "visual")
end)
vim.keymap.set("v", "g<C-a>", function()
require("dial.map").manipulate("increment", "gvisual")
end)
vim.keymap.set("v", "g<C-x>", function()
require("dial.map").manipulate("decrement", "gvisual")
end)
<
==============================================================================
CONFIGURATIONS *dial-config*
dial.nvim では操作対象を表す被加数 (augend) と、複数の被加数をまとめたグループ
を用いることで、増減ルールを自由に設定することができます。
>
local augend = require("dial.augend")
require("dial.config").augends:register_group{
-- グループ名を指定しない場合に用いられる被加数
default = {
augend.integer.alias.decimal, -- nonnegative decimal number
augend.integer.alias.hex, -- nonnegative hex number
-- date (2022/02/19, etc.)
augend.date.new {
pattern = "%Y/%m/%d",
default_kind = "day",
},
},
-- `mygroup` というグループ名を使用した際に用いられる被加数
mygroup = {
augend.integer.alias.decimal,
augend.constant.alias.bool, -- boolean value (true <-> false)
-- date (02/19/2022, etc.)
augend.date.new {
pattern = "%m/%d/%Y",
default_kind = "day",
},
}
}
<
`"dial.config"` モジュールに存在する `augends:register_group` 関数を用いてグル
ープを定義することができます。関数の引数には、グループ名をキー、被加数のリスト
を値とする辞書を指定します。
上の例で `augend` という名前のローカル変数に代入されている `"dial.augend"`
モジュールにはさまざまな被加数が定義されています。具体的に定義されている被加数
とエイリアスについては |dial-augends| および |dial-aliases| を参照。
|dial.nvim| では以下のように **expression register** |@=| を用いることで増減対
象のグループを指定します。
>
"=mygroup<CR><C-a>
<
増減のたびに expression register を指定するのが面倒であれば、以下のようにマッ
ピングすることも可能です。
>
nmap <Leader>a "=mygroup<CR><Plug>(dial-increment)
<
Lua 上で以下のように記述すれば expression register を使わずマッピングを設定で
きます。
>
vim.api.nvim_set_keymap(
"n",
"<Leader>a",
require("dial.map").inc_normal("mygroup"),
{noremap = true}
)
<
*dial-config-augends-default*
デフォルトグループ~
`default` は特殊なグループであり、標準で定義されています。expression register
などでグループ名を指定しなかった場合は `default` グループにある被加数がかわり
に用いられます。
何も設定しなかった場合は以下の設定を行っているのと等価となります。
>
local augend = require("dial.augend")
require("dial.config").augends:register_group{
default = {
augend.integer.alias.decimal,
augend.integer.alias.hex,
augend.date.new {
pattern = "%Y/%m/%d",
default_kind = "day",
},
augend.date.new {
pattern = "%Y-%m-%d",
default_kind = "day",
},
augend.date.new {
pattern = "%m/%d",
default_kind = "day",
only_valid = true,
},
augend.date.new {
pattern = "%H:%M",
default_kind = "day",
only_valid = true,
},
augend.constant.alias.ja_weekday_full,
},
}
<
VISUAL mode 限定のマッピング~
VISUAL モード用のグループを作成することで可能です。
>
local augend = require("dial.augend")
require("dial.config").augends:register_group{
visual = {
augend.integer.alias.decimal,
augend.integer.alias.hex,
augend.date.new {
pattern = "%Y/%m/%d",
default_kind = "day",
},
augend.constant.alias.alpha,
augend.constant.alias.Alpha,
},
}
-- VISUAL モードでの被加数を変更する
vim.api.nvim_set_keymap(
"v", "<C-a>", require("dial.map").inc_normal("visual"), {noremap = true}
)
vim.api.nvim_set_keymap(
"v", "<C-x>", require("dial.map").dec_normal("visual"), {noremap = true}
)
<
特定のファイルタイプ限定のルール~
`augends:on_filetype()` 関数を使うことで、特定のファイルタイプのときに有効な被
加数のルールを定義することができます。
>
lua << EOF
local augend = require("dial.augend")
require("dial.config").augends:on_filetype {
typescript = {
augend.integer.alias.decimal,
augend.integer.alias.hex,
augend.constant.new { elements = { "true", "false" } },
augend.constant.new { elements = {"let", "const"} },
},
lua = {
augend.integer.alias.decimal,
augend.constant.new { elements = { "true", "false" } },
},
markdown = {
augend.integer.alias.decimal,
augend.misc.alias.markdown_header,
}
}
EOF
<
------------------------------------------------------------------------------
ALIASES *dial-aliases*
被加数のエイリアスとして、デフォルトで以下が提供されています。
詳しくは |dial-augends| の対応する節を参照。
integer:
`augend.integer.alias.decimal`
`augend.integer.alias.decimal_int`
`augend.integer.alias.hex`
`augend.integer.alias.octal`
`augend.integer.alias.binary`
date:
`augend.date.alias["%Y/%m/%d"]`
`augend.date.alias["%m/%d/%Y"]`
`augend.date.alias["%d/%m/%Y"]`
`augend.date.alias["%m/%d/%y"]`
`augend.date.alias["%d/%m/%y"]`
`augend.date.alias["%m/%d"]`
`augend.date.alias["%-m/%-d"]`
`augend.date.alias["%Y-%m-%d"]`
`augend.date.alias["%Y年%-m月%-d日"]`
`augend.date.alias["%Y年%-m月%-d日(%ja)"]`
`augend.date.alias["%H:%M:%S"]`
`augend.date.alias["%H:%M"]`
constant:
`augend.constant.alias.ja_weekday`
`augend.constant.alias.ja_weekday_full`
`augend.constant.alias.bool`
`augend.constant.alias.alpha`
`augend.constant.alias.Alpha`
semver:
`augend.semver.alias.semver`
NOTE: date の alias は deprecated であり、今後のアップデートで削除される可能性
があります。
------------------------------------------------------------------------------
AUGENDS *dial-augends*
以下簡単のため、 `augend` という変数は以下のように定義されているものとします。
>
local augend = require("dial.augend")
<
NUMBER *dial-augends-number*
------
n 進数の整数 (`2 <= n <= 36`) を表します。 `augend.integer.new{ ...opts }` で
使用できます。
>
require("dial.config").augends:register_group{
default = {
-- uppercase hex number (0x1A1A, 0xEEFE, etc.)
augend.integer.new{
radix = 16,
prefix = "0x",
natural = true,
case = "upper",
},
},
}
<
`augend.integer.new` の引数のテーブルは以下のキーをとることができます。
radix (number, default: 10)
表記に用いる進数を表します。
prefix (string, default: "")
数値に前置される文字列を指定できます (e.g. `0x`)。
natural (boolean, default: true)
true のときは自然数にのみマッチします。
つまり、 `-1` のうえにカーソルがあったとしても `1` にマッチし、
`-1` にはマッチしません。
case ("upper" | "lower", default: "lower")
16進数のように10よりも大きな進数のときに用いるアルファベットの
大文字/小文字を指定します。
delimiter (char, default: "")
数値の区切り文字を指定します。たとえば "," を与えると、以下の
ような数値にもマッチするようになります。
>
1,234,567
1,23,4,5,67
<
いずれも数値を解釈するときは単にカンマが無視されますが、増減時
にカンマの位置が n 桁区切りとなるよう整形されます。n の値は後
述する `delimiter_digits` の値で制御できます。
delimiter_digits (number, default: 3)
数値の区切り文字が指定されているとき、数値を何桁区切りで表示す
るか指定します。
`delimiter` が空文字列のときには意味がありません。
augend.integer.alias.decimal~
十進数の整数。
>
0
123
3141592
<
といった文字列にマッチし、1つインクリメントするごとにその数値を1増加させます。
標準の CTRL-A と異なり、数字の先頭に `-` が付いていても考慮しません。
>
file-1.jpg
<
という文字列の `1` にカーソルがある状態で |<Plug>(dial-increment)| を行うと
>
file-2.jpg
<
となります。
augend.integer.alias.decimal_int~
基本的には `augend.integer.alias.decimal` と同じですが、こちらは負の整数にも
マッチします。
>
file-1.jpg
<
という文字列の `1` にカーソルがある状態で |<Plug>(dial-increment)| を行うと
>
file0.jpg
<
となります。
augend.integer.alias.hex~
16進数の非負整数にマッチし、16進数の表記でインクリメント・デクリメントが行われ
ます。
>
0x12
0xafbf
0xAFBF
<
などの文字列にマッチします。
augend.integer.alias.octal~
8進数の非負整数にマッチし、8進数の表記でインクリメント・デクリメントが行われま
す。
>
0o37
0o567
0o01212
<
などの文字列にマッチします。
augend.integer.alias.binary~
2進数の非負整数にマッチし、2進数の表記でインクリメント・デクリメントが行われま
す。
>
0b00
0b1010
0b10100101
<
などの文字列にマッチします。
DATE *dial-augends-date*
-----
日付や時刻を表します。`augend.date.new{ ...opts }` で使用できます。
>
require("dial.config").augends:register_group{
default = {
augend.date.new{
pattern = "%Y/%m/%d",
default_kind = "day",
only_valid = true,
word = false,
},
},
}
<
*dial-augends-date-arguments*
`augend.date.new` の引数のテーブルは以下のキーをとることができます。
pattern (string, 必須)
マッチさせたい日付のパターン。詳細は |dial-augends-date-pattern|
参照。
default_kind (string, 必須)
カーソル位置が日付から離れている場合、または選択モード中で増減操作
を行うとき、日付をどの単位で増減させるかを表します。以下の6種類の
値から選択します:
* `year`
* `month`
* `day`
* `hour`
* `min`
* `sec`
only_valid (boolean, default: false)
true のとき、フォーマットには合致するものの現実には存在しない日付
や時刻（`2022/13/52` や `27:30`など）にはマッチしなくなります。意
図せぬマッチを防ぐのに役立ちます。
false のとき、現実には存在しない日付にもマッチし、増減の際に現実に
存在する日付へと強制的に修正します。たとえば `2022/06/31` の状態で
日付を1だけ増加させると、もともとの文字列は `2022/07/01` という日
付と解釈され、最終的に `2022/07/02` となります。
word (boolean, default: false)
true のとき、フォーマットに一致する文字列が単語の境界にあるときの
みマッチします。
clamp (boolean, default: false)
月や年をインクリメントすることによって日付がその月の末日を超えると
きにどう扱うかを制御する。true ならば末日での切り詰めを行う。
|dial-augends-date-clamp| 参照。
end_sensitive (boolean, default: false)
月や年をインクリメントする際に、月の末日のみ特別扱いするかどうかを
制御する。true ならば、末日を特別扱いして扱う。
|dial-augends-date-end-sensitive| 参照。
custom_date_elements (table<string, dateelement>, default: {})
ユーザが自分自身で日付の形式を定義する際に用いる発展的なオプション。
詳細は |dial-augends-date-custom-format| を参照。
*dial-augends-date-pattern*
`pattern` 引数には以下のような文字列を指定することができます。
>
%Y/%m/%d (e.g. 2022/02/06)
%H:%M:%S (e.g. 15:30:00)
%-m/%-d (e.g. 2/6)
<
`%` は日付の要素を表すために用いられるエスケープ文字であり、以下のようにして用
いることができます。
* `%` とアルファベット1文字。
`%Y` 4桁の西暦。 (e.g. `2022`)
`%y` 西暦の下2桁。上2桁は `20` として解釈されます。 (e.g. `22`)
`%m` 2桁の月。 (e.g. `09`)
`%d` 2桁の日。 (e.g. `28`)
`%H` 24時間で表示した2桁の時間。 (e.g. `15`)
`%I` 12時間で表示した2桁の時間。 (e.g. `03`)
`%M` 2桁の分。 (e.g. `05`)
`%S` 2桁の秒。 (e.g. `08`)
`%a` 英語表記の短い曜日。 (`Sun`, `Mon`, ..., `Sat`)
`%A` 英語表記の曜日。 (`Sunday`, `Monday`, ..., `Saturday`)
`%b` 英語表記の短い月名。 (`Jan`, ..., `Dec`)
`%B` 英語表記の月名。 (`January`, ..., `December`)
`%p` `AM` または `PM`。
`%J` 日本語表記の曜日。 (`日`, `月`, ..., `土`)
* `%-` とアルファベット1文字。
`%-y` 西暦の下2桁を1–2桁で表したもの。(e.g. `9` で `2009` 年を表す)
`%-m` 1–2桁の月。 (e.g. `9`)
`%-d` 1–2桁の日。 (e.g. `28`)
`%-H` 24時間で表示した1–2桁の時間。 (e.g. `15`)
`%-I` 12時間で表示した1–2桁の時間。 (e.g. `3`)
`%-M` 1–2桁の分。 (e.g. `5`)
`%-S` 1–2桁の秒。 (e.g. `8`)
* `%%`。これは `%` 自体を表現するのに用います。
* `%(element_name)` という形式のテキスト (|dial-augends-date-custom-format|)。
`element_name` には `)` という文字が出現しない任意の文字列を入れることができ
ます。
NOTE パターンには日付または時刻に関する情報を含める必要があり、曜日単体で使う
ことはできません。たとえば `%a` をパターンとして指定しても期待通りの動作をしま
せん。曜日だけでは日付を推定できないためです。
*dial-augends-date-custom-format*
日付のパターンにおいて、`%(element_name)` はユーザの手で定義できる特殊なプレー
スホルダーです。プレースホルダーは `augend.date.new` の `custom_date_elements`
引数で以下のように与えることができます。
>
local WEEKDAYS_FLUSHRIGHT = {
" Sunday",
" Monday",
" Tuesday",
"Wednesday",
" Thursday",
" Friday",
" Saturday",
}
require("dial.config").augends:register_group {
default = {
augend.date.new {
pattern = "%d/%m/%y %(week_flushright)",
default_kind = "day",
custom_date_elements = {
week_flushright = {
kind = nil,
regex = common.enum_to_regex(WEEKDAYS_FLUSHRIGHT),
update_date = function(_, date)
return date
end,
format = function(time)
local wday = os.date("*t", time).wday
return WEEKDAYS_FLUSHRIGHT[wday]
end,
}
}
}
},
}
<
上の例では `week_flushright` という日付の要素を定義し、`%(week_flushright)` と
してパターン内で使用しています。その結果このルールは
>
18/10/22 Tuesday
<
にマッチし、日付の上で <C-a> を実行することで
>
19/10/22 Wednesday
<
へとインクリメントできるようになります。
日付の要素に求められるフィールドは以下のとおりです。
kind (string | nil, default: nil)
その要素が日付のどの情報に紐付いているか。
* `year`
* `month`
* `day`
* `hour`
* `min`
* `sec`
regex (string, 必須)
その要素を検索する際のパターン文字列。
update_date (function, 必須)
その要素を読んだことによって、日付がどのようにアップデートされるか。
1つ目の引数にはプレースホルダーにマッチした文字列、2つ目の引数には
アップデート前の日付の情報 (`os.date("*t")` と同形式のテーブル) が
渡されます。
format (function, 必須)
日付（時刻）が与えられたとき、その要素をどのように文字列に変換する
か。1つ目の引数には unix time が integer で渡されます。
非常に柔軟にパターンを定義できるものの、設定が複雑になるため可能な限り `%a` や
`%y` といった既存の要素を用いることが推奨されます。
*dial-augends-date-clamp*
*dial-augends-date-end-sensitive*
「1ヶ月後」「1年後」のような増減操作を行うとき、それが表す日付は自明ではない場
合があります。たとえば `yyyy-mm-dd` 形式で `2022-01-31` という日付を考えると、
その1ヶ月後は31日を加算した `2022-03-03` だと考える人もいるかもしれませんし、
「1月の次の月の末日」である `2022-02-28` だと考える人もいるでしょう。様々なケ
ースに対応するため、 augend.date には `clamp` と `end_sensitive` という2種類の
オプションが用意されています。
具体例として、 `2022-01-31` の1ヶ月後を考えてみます。素直に考えれば
`2022-02-31` ですが、残念ながらこの日付は存在しません。`clamp = false` のとき
は、次の月に繰り越すことで存在する日付へと修正します。
>
2022-01-31 --(+1 month)--> 2022-02-31 (that does not exist)
~~> 2022-03-03 (FINAL RESULT)
<
一方で`clamp = true` のときは、月を保ちつつ日付を切り詰めることで修正します。
>
2022-01-31 --(+1 month)--> 2022-02-31 (that does not exist)
~~> 2022-02-28 (FINAL RESULT)
<
`end_sensitive` オプションを使うと、末日を特別扱いすることができます。
`end_sensitive = true` のとき、増減対象の日付がある月の末日だった場合、年月を
インクリメントすると `clamp` にかかわらず強制的にその月の末日へと変換されます。
よって
>
2022-01-31 --> 2022-02-28
<
となります。
`clamp` と `end_sensitive` はよく似たオプションですが、動作が微妙に異なります。
自分のユースケースに最も合った値をそれぞれ選択してください。
* `clamp = false, end_sensitive = false` のとき
>
2022-01-30 --(+1 month)--> 2022-03-02
2022-01-31 --(+1 month)--> 2022-03-03
2022-02-28 --(+1 month)--> 2022-03-28
2022-03-31 --(-1 month)--> 2022-03-03
<
* `clamp = true, end_sensitive = false` のとき
>
2022-01-30 --(+1 month)--> 2022-02-28 # Clamped!
2022-01-31 --(+1 month)--> 2022-02-28 # Clamped!
2022-02-28 --(+1 month)--> 2022-03-28
2022-03-31 --(-1 month)--> 2022-02-28 # Clamped!
<
* `clamp = false, end_sensitive = true` のとき
>
2022-01-30 --(+1 month)--> 2022-03-02
2022-01-31 --(+1 month)--> 2022-02-28 # Last day of the month!
2022-02-28 --(+1 month)--> 2022-03-31 # Last day of the month!
2022-03-31 --(-1 month)--> 2022-02-28 # Last day of the month!
<
* `clamp = true, end_sensitive = true` のとき
>
2022-01-30 --(+1 month)--> 2022-02-28 # Clamped!
2022-01-31 --(+1 month)--> 2022-02-28 # Last day of the month!
2022-02-28 --(+1 month)--> 2022-03-31 # Last day of the month!
2022-03-31 --(-1 month)--> 2022-02-28 # Last day of the month!
<
*dial-augends-date-aliases*
`augend.date` には以下のエイリアスが用意されています。
NOTE: 以下のエイリアスは、日付のフォーマットを指定するのが困難であった時代の名
残です。現在はフォーマットを自由に指定できるため、エイリアスの意義が失われつつ
あります。互換性のため現在は残していますが、将来的には削除予定です。
augend.date.alias["%Y/%m/%d"]~
以下のようなフォーマットの日付にマッチします。
>
1970/12/31
2021/01/01
2021/02/13
<
カーソルが当該フォーマットより左にある場合は日付単位でのインクリメントが行われ
ますが、カーソルがフォーマット上にある場合、具体的なカーソルの位置によってイン
クリメントの対象が変化します。
`1970/12/31` を例に取ってみます。
`1970` の4文字のいずれかの上にカーソルがあるときにインクリメントを行うと
>
1971/12/31
<
のように年がインクリメントされます。
`/12` のいずれかの上にカーソルがあるときにインクリメントを行うと
>
1971/01/31
<
のように月がインクリメントされます。
`/31` のいずれかの上にカーソルがあるときにインクリメントを行うと
>
1971/01/01
<
のように日付がインクリメントされます。
当該フォーマットでは
>
2021/02/29
2021/14/59
<
のように現実には存在しない日付でもマッチするものの、インクリメントを行う際に現
実に存在する日付へと強制的に修正されます。
augend.date.alias["%m/%d/%Y"]~
以下のようなフォーマットの日付にマッチします。
>
12/31/1970
01/01/2021
02/13/2021
<
意図しないマッチを避けるため、存在しない日付にはマッチしません。
augend.date.alias["%d/%m/%Y"]~
以下のようなフォーマットの日付にマッチします。
>
31/12/1970
01/01/2021
13/02/2021
<
意図しないマッチを避けるため、存在しない日付にはマッチしません。
augend.date.alias["%m/%d/%y"]~
以下のようなフォーマットの日付にマッチします。
>
12/31/70
01/01/21
02/13/21
<
意図しないマッチを避けるため、存在しない日付にはマッチしません。
augend.date.alias["%d/%m/%y"]~
以下のようなフォーマットの日付にマッチします。
>
31/12/19
01/01/20
13/02/20
<
意図しないマッチを避けるため、存在しない日付にはマッチしません。
augend.date.alias["%m/%d"]~
以下のような日付にマッチします。
>
12/31
01/01
02/13
<
`12/31` の例の場合、
* カーソルが `12` より左にある場合：日付
* カーソルが `12` のいずれかの上にある場合：月
* カーソルが `/31` のいずれかの上にある場合：日付
がインクリメントされます。
現実に存在しない日付でもマッチし、操作の際に現実に存在する日付へと強制的に修正
されます。
augend.date.alias["%-m/%-d"]~
基本的に |dial-augends-date#[%m/%d]| と同様ですが、こちらは月日が2桁にパディン
グされていなくてもマッチします。すなわち、
>
12/31
1/1
2/13
<
などにマッチします。
意図しないマッチを避けるため、存在しない日付にはマッチしません。
augend.date.alias["%Y-%m-%d"]~
以下のようなフォーマットの日付にマッチします。
>
1970-12-31
2021-01-01
2021-02-13
<
現実に存在しない日付でもマッチし、操作の際に現実に存在する日付へと強制的に修正
されます。
augend.date.alias["%Y年%-m月%-d日"]~
以下のようなフォーマットの日付にマッチします。
>
1970年12月31日
2021年1月1日
2021年2月13日
<
augend.date.alias["%Y年%-m月%-d日(%ja)"]~
以下のようなフォーマットの日付にマッチします。
>
1970年12月31日(木)
2021年1月1日(金)
2021年2月13日(土)
<
日付と曜日の整合性が取れていない場合もマッチし、インクリメント・デクリメントの
際に正しい曜日となるよう自動で修正されます。
augend.date.alias["%H:%M:%S"]~
以下のようなフォーマットの時刻（時:分:秒）にマッチします。
>
00:00:00
12:34:56
<
`12:34:56` の例の場合、
* カーソルが `12` より左にある場合：秒
* カーソルが `12` のいずれかの上にある場合：時
* カーソルが `:34` のいずれかの上にある場合：分
* カーソルが `:56` のいずれかの上にある場合：秒
がインクリメントされます。
意図しないマッチを避けるため、存在しない時刻にはマッチしません。
augend.date.alias["%H:%M"]~
以下のようなフォーマットの時刻（時:分）にマッチします。
>
00:00
12:34
<
`12:34` の例の場合、
* カーソルが `12` より左にある場合：分
* カーソルが `12` のいずれかの上にある場合：時
* カーソルが `:34` のいずれかの上にある場合：分
がインクリメントされます。
意図しないマッチを避けるため、存在しない時刻にはマッチしません。
CONSTANT *dial-augends-constant*
--------
キーワードなどの決められた文字列をトグルします。
`augend.constant.new{ ...opts }` で使用できます。
>
require("dial.config").augends:register_group{
default = {
-- uppercase hex number (0x1A1A, 0xEEFE, etc.)
augend.constant.new{
elements = {"and", "or"},
word = true, -- if false, "sand" is incremented into "sor", "doctor" into "doctand", etc.
cyclic = true, -- "or" is incremented into "and".
},
augend.constant.new{
elements = {"&&", "||"},
word = false,
cyclic = true,
},
},
}
<
以下のパラメータを有します。
elements (string[], 必須)
相互変換したい文字列のリスト。
word (boolean, default: true)
true のとき、elements に一致する文字列が単語の境界にあるときの
みマッチします。
cyclic (boolean, default: true)
true のとき、増減操作を行う際に巡回します。
preserve_case (boolean, default: false)
true のとき、アルファベットの大文字・小文字のパターンを保存し
ての変換を試みます。
pattern_regexp (string, default: `\C\V\<\(%s\)\>`)
文字列検索を行う際の正規表現。 elements に指定した文字列を
`%s` に指定します。
注意: `&&` と `||` のように、記号からなる文字列を相互変換するときは `cyclic`
を false にしてください。
注意: `preserve_case` が true のときは、大文字・小文字を無視して elements に
指定した文字列にマッチします。このとき、文字列が以下の3パターンのいずれかに該
当する場合に限り、大文字・小文字のパターンを保存して文字列を切り替えます。
* 全て小文字の場合（例: `true <-> false`）
* 全て大文字の場合（例: `TRUE <-> FALSE`）
* 先頭のみ大文字の場合（例: `True <-> False`）
それ以外のときは全て小文字に変換します。
augend.constant.alias.ja_weekday~
日本語の曜日名にマッチします。
>
月
火
水
木
金
土
日
<
それぞれ Vim の意味での単語になっているものに対してマッチするため、「日用品」
など熟語の一部にはマッチしません。
augend.constant.alias.ja_weekday_full~
日本語の曜日名にマッチします。
>
月曜日
火曜日
水曜日
木曜日
金曜日
土曜日
日曜日
<
こちらは augend.constant.alias.ja_weekday と異なり、単語ではなく文字列としてマ
ッチするため、「毎週火曜日」のように漢字が連なっていてもマッチします。
augend.constant.alias.bool~
`true` または `false` という単語にマッチします。
>
true
false
<
augend.constant.alias.alpha~
`a` や `z` など、1つの小文字アルファベットにマッチします。ノーマルモードの場合
はそれ自身が Vim の意味で単語として独立していない限りマッチしません。例えば
>
(a)
a.
<
などのように単語として独立した `a` にはマッチしますが、
>
cafe
2a
<
のように単語として独立していない `a` にはマッチしません。
なお、インクリメント時に巡回は行われません。すなわち `z` をインクリメントして
も`z` のまま変わらず、 `a` をデクリメントしても `a` のまま変わりません。
augend.constant.alias.Alpha~
`A` や `Z` など、1つの大文字アルファベットにマッチします。
CASE *dial-augends-case*
-----
camelCase や snake_case といったプログラミング言語における変数名や関数名の規則
を変更します。 `augend.case.new { ...opts }` で使用できます。
>
require("dial.config").augends:register_group{
default = {
-- uppercase hex number (0x1A1A, 0xEEFE, etc.)
augend.case.new{
types = {"camelCase", "snake_case"},
cyclic = true,
},
},
}
<
以下のパラメータを有します。
patterns (string[], 必須)