VFile について

# Dec 4, 2022

to-vfile は VFile を扱うモジュールです。

1

import { read, write, toVFile } from 'to-vfile';

remark と相性がいいっていうか、同じ作者さんが作ってるみたいなので、remark の例によく出てきます。

read() は実のところ、Perl における slurp のようなものです。
違うのは string ではなくて VFile を返すところです。

1

const vfile /* : VFile */ = await read( './hoge.md' );

.value でファイルの内容を参照できます。

1

console.log( vfile.value );   // => <ファイルの内容>

write() がほんとにわかりませんでしたが、test.js を見て理解することができました:

1
2


const destFilePath = changeExtention( './hoge.md', '.html' );
await write( { path: destFilePath, data: 'Hello, World!' } );

NodeJS の fs.writeFile() 風に書くと以下のようになります:

1
2
3
4
5
6
7
8


async function writeVFile(filepath, data/*, options */) {
    const vfile = {
        path: filepath,
        data: data
    };

    await write( vfile );
}

うぃーくりー・あんだーわーるど・にゅーす

VFile について