Skip to content

Commit f8ee265

Browse files
committed
docs: Update README
1 parent 9e17198 commit f8ee265

File tree

1 file changed

+93
-1
lines changed

1 file changed

+93
-1
lines changed

README.md

Lines changed: 93 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,98 @@
11
# rollup-plugin-nodebox-fs-files
22

3-
実装中。
3+
Converts file to [Nodebox](https://sandpack.codesandbox.io/docs/advanced-usage/nodebox) [files](https://github.com/codesandbox/nodebox-runtime/blob/main/packages/nodebox/api.md#nodeboxfsinitfiles).
4+
5+
## Installation
6+
7+
```shell
8+
npm install --save-dev @hankei6km/rollup-plugin-nodebox-fs-files
9+
```
10+
11+
## Usage
12+
13+
```js
14+
// rollup.config.js
15+
import nodeboxFsFiles from '@hankei6km/rollup-plugin-nodebox-fs-files'
16+
17+
export default {
18+
input: 'src/index.mjs',
19+
plugins: [
20+
nodeboxFsFiles({
21+
from: 'box-src/proj',
22+
insertTo: 'src/files.mjs'
23+
})
24+
]
25+
}
26+
```
27+
28+
from
29+
30+
```
31+
box-src/proj/
32+
├── index.js
33+
├── node_modules
34+
│ └── ...
35+
├── public
36+
│ └── image.png
37+
└── src
38+
└── lib.js
39+
```
40+
41+
to
42+
43+
```js
44+
// src/files.mjs
45+
export const files = {
46+
'index.js': 'console.log(...;\n',
47+
'public/image.png': { type: 'Buffer', data: [97, 98, 99 /*...*/] },
48+
'src/lib.js': 'export default ...;\n'
49+
}
50+
```
51+
52+
> NOTE: Define a temporary `export` to bypass a linting error.
53+
>
54+
> ```js
55+
> // src/files.mjs
56+
> export const files = {}
57+
> ```
58+
59+
## Examples
60+
61+
`misc` directory is ignored.
62+
63+
```js
64+
// rollup.config.js
65+
import nodeboxFsFiles from '@hankei6km/rollup-plugin-nodebox-fs-files'
66+
67+
export default {
68+
input: 'src/index.mjs',
69+
plugins: [
70+
nodeboxFsFiles({
71+
from: 'box-src/proj',
72+
insertTo: 'src/files.mjs',
73+
excludeFrom: '**/misc/**'
74+
})
75+
]
76+
}
77+
```
78+
79+
converts `.mp4` and `.mp3` files as binary.
80+
81+
```js
82+
// rollup.config.js
83+
import nodeboxFsFiles from '@hankei6km/rollup-plugin-nodebox-fs-files'
84+
85+
export default {
86+
input: 'src/index.mjs',
87+
plugins: [
88+
nodeboxFsFiles({
89+
from: 'box-src/proj',
90+
insertTo: 'src/files.mjs',
91+
binaryFile: ['**/*.mp4', '**/*.mp3']
92+
})
93+
]
94+
}
95+
```
496

597
## License
698

0 commit comments

Comments
 (0)