@riebeckite/node 0.0.0-stage → 0.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +109 -2
- package/README_ja.md +104 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +210 -0
- package/dist/src/file_system_content_source.d.ts +23 -0
- package/package.json +53 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright Rerurate_514
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,110 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @riebeckite/node
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[日本語](./README_ja.md)
|
|
4
|
+
|
|
5
|
+
Node.js adapters for Riebeckite. It provides the filesystem-backed content
|
|
6
|
+
source used by Node.js applications and framework integrations.
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
Install this package when your application creates a `ContentManager` from a
|
|
11
|
+
directory on disk:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
pnpm add @riebeckite/core @riebeckite/node
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
`@riebeckite/honox` installs and uses this adapter for its default filesystem
|
|
18
|
+
content source.
|
|
19
|
+
|
|
20
|
+
## Use a filesystem content source
|
|
21
|
+
|
|
22
|
+
`ContentManager` accepts a `ContentSource`. Create a
|
|
23
|
+
`FileSystemContentSource` for a local content directory and pass it to the
|
|
24
|
+
manager:
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import { ContentManager, defineConfig } from "@riebeckite/core";
|
|
28
|
+
import { FileSystemContentSource } from "@riebeckite/node";
|
|
29
|
+
|
|
30
|
+
const config = defineConfig({
|
|
31
|
+
site: { title: "My notes" },
|
|
32
|
+
content: {
|
|
33
|
+
directory: "content",
|
|
34
|
+
exclude: ["drafts/**"],
|
|
35
|
+
},
|
|
36
|
+
});
|
|
37
|
+
|
|
38
|
+
const content = new ContentManager(
|
|
39
|
+
new FileSystemContentSource(config.content.directory, config.content.exclude),
|
|
40
|
+
[],
|
|
41
|
+
{ config, plugins: config.plugins },
|
|
42
|
+
);
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The directory is read when content is scanned or requested, not in the
|
|
46
|
+
constructor. A missing directory produces an error that names the directory.
|
|
47
|
+
|
|
48
|
+
## Filesystem behavior
|
|
49
|
+
|
|
50
|
+
- Scans directories recursively and returns paths in a stable alphabetical
|
|
51
|
+
order.
|
|
52
|
+
- Includes regular files with creation time, modification time, and size
|
|
53
|
+
metadata.
|
|
54
|
+
- Reads only regular files. Symbolic links are never followed or exposed.
|
|
55
|
+
- Rejects reads outside the configured content directory.
|
|
56
|
+
- Ignores Riebeckite and common workspace metadata by default: `.riebeckite`,
|
|
57
|
+
`.git`, `.github`, `.obsidian`, `node_modules`, `.DS_Store`, `Thumbs.db`, and
|
|
58
|
+
`desktop.ini`.
|
|
59
|
+
- Applies the configured exclusion patterns. An exclusion without `.md` also
|
|
60
|
+
matches the corresponding Markdown path, so `private` excludes
|
|
61
|
+
`private.md`.
|
|
62
|
+
- Reads Obsidian Templater's `templates_folder` setting when present and
|
|
63
|
+
excludes that folder from content.
|
|
64
|
+
|
|
65
|
+
## Public API
|
|
66
|
+
|
|
67
|
+
### `FileSystemContentSource`
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
new FileSystemContentSource(
|
|
71
|
+
contentDirectory: string,
|
|
72
|
+
exclude?: readonly string[],
|
|
73
|
+
)
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Implements Core's `ContentSource` contract. Use `scan()` for entries and
|
|
77
|
+
`read(entry)` for the content of an entry.
|
|
78
|
+
|
|
79
|
+
`scanWithExclusions()` additionally returns exclusion records:
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
const { entries, exclusions } = await source.scanWithExclusions();
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Each exclusion has the logical `path` and the matching `pattern`. This is
|
|
86
|
+
useful for inspection tooling; ordinary applications should use `scan()`.
|
|
87
|
+
|
|
88
|
+
### Path helpers
|
|
89
|
+
|
|
90
|
+
- `INTERNAL_CONTENT_IGNORE_PATTERNS` lists the built-in ignored patterns.
|
|
91
|
+
- `isIgnoredContentPath(path, exclude?)` reports whether a logical content path
|
|
92
|
+
is ignored.
|
|
93
|
+
- `matchContentExcludePattern(path, exclude?)` returns the matching configured
|
|
94
|
+
pattern, if any.
|
|
95
|
+
|
|
96
|
+
These helpers operate on logical content paths with `/` separators, not
|
|
97
|
+
absolute filesystem paths.
|
|
98
|
+
|
|
99
|
+
## Package boundary
|
|
100
|
+
|
|
101
|
+
`@riebeckite/core` defines the portable `ContentSource` contract and content
|
|
102
|
+
pipeline. This package is the Node.js filesystem implementation of that
|
|
103
|
+
contract. Import filesystem-specific APIs from `@riebeckite/node`; do not
|
|
104
|
+
import them from `@riebeckite/core`.
|
|
105
|
+
|
|
106
|
+
## See also
|
|
107
|
+
|
|
108
|
+
- [`@riebeckite/core`](../core/README.md)
|
|
109
|
+
- [Content system](../../docs/docs/framework/content-system.md)
|
|
110
|
+
- [Configuration reference](../../docs/docs/reference/configuration.md)
|
package/README_ja.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# @riebeckite/node
|
|
2
|
+
|
|
3
|
+
[English](./README.md)
|
|
4
|
+
|
|
5
|
+
Riebeckite 向けの Node.js アダプターです。Node.js アプリケーションや
|
|
6
|
+
フレームワーク統合で使う、ファイルシステムベースのコンテンツソースを提供します。
|
|
7
|
+
|
|
8
|
+
## インストール
|
|
9
|
+
|
|
10
|
+
ディスク上のディレクトリから `ContentManager` を作成するアプリケーションでは、
|
|
11
|
+
このパッケージを追加します。
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
pnpm add @riebeckite/core @riebeckite/node
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
`@riebeckite/honox` は、既定のファイルシステムコンテンツソースとしてこの
|
|
18
|
+
アダプターをインストールして利用します。
|
|
19
|
+
|
|
20
|
+
## ファイルシステムコンテンツソースを使う
|
|
21
|
+
|
|
22
|
+
`ContentManager` は `ContentSource` を受け取ります。ローカルのコンテンツ
|
|
23
|
+
ディレクトリには `FileSystemContentSource` を作成して渡します。
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import { ContentManager, defineConfig } from "@riebeckite/core";
|
|
27
|
+
import { FileSystemContentSource } from "@riebeckite/node";
|
|
28
|
+
|
|
29
|
+
const config = defineConfig({
|
|
30
|
+
site: { title: "My notes" },
|
|
31
|
+
content: {
|
|
32
|
+
directory: "content",
|
|
33
|
+
exclude: ["drafts/**"],
|
|
34
|
+
},
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
const content = new ContentManager(
|
|
38
|
+
new FileSystemContentSource(config.content.directory, config.content.exclude),
|
|
39
|
+
[],
|
|
40
|
+
{ config, plugins: config.plugins },
|
|
41
|
+
);
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
ディレクトリはコンストラクター実行時ではなく、コンテンツを走査または取得する時点で
|
|
45
|
+
読み取られます。ディレクトリが存在しない場合は、対象のディレクトリ名を含むエラーになります。
|
|
46
|
+
|
|
47
|
+
## ファイルシステムでの動作
|
|
48
|
+
|
|
49
|
+
- ディレクトリを再帰的に走査し、安定したアルファベット順でパスを返します。
|
|
50
|
+
- 通常ファイルを作成日時・更新日時・サイズのメタデータとともに取得します。
|
|
51
|
+
- 読み取るのは通常ファイルだけです。シンボリックリンクはたどらず、結果にも含めません。
|
|
52
|
+
- 設定したコンテンツディレクトリの外側にあるファイルの読み取りを拒否します。
|
|
53
|
+
- `.riebeckite`、`.git`、`.github`、`.obsidian`、`node_modules`、`.DS_Store`、
|
|
54
|
+
`Thumbs.db`、`desktop.ini` といった Riebeckite やワークスペースのメタデータは
|
|
55
|
+
既定で無視します。
|
|
56
|
+
- 設定した除外パターンを適用します。`.md` を含まない除外パターンは対応する
|
|
57
|
+
Markdown パスにも一致するため、`private` は `private.md` も除外します。
|
|
58
|
+
- Obsidian Templater の `templates_folder` 設定がある場合は、そのフォルダを
|
|
59
|
+
コンテンツから除外します。
|
|
60
|
+
|
|
61
|
+
## 公開 API
|
|
62
|
+
|
|
63
|
+
### `FileSystemContentSource`
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
new FileSystemContentSource(
|
|
67
|
+
contentDirectory: string,
|
|
68
|
+
exclude?: readonly string[],
|
|
69
|
+
)
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Core の `ContentSource` 契約を実装します。エントリーの取得には `scan()`、
|
|
73
|
+
エントリー内容の取得には `read(entry)` を使います。
|
|
74
|
+
|
|
75
|
+
`scanWithExclusions()` は除外情報も返します。
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
const { entries, exclusions } = await source.scanWithExclusions();
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
各除外情報には論理パス `path` と、一致した `pattern` が含まれます。これは検査用
|
|
82
|
+
ツール向けです。通常のアプリケーションでは `scan()` を使います。
|
|
83
|
+
|
|
84
|
+
### パスヘルパー
|
|
85
|
+
|
|
86
|
+
- `INTERNAL_CONTENT_IGNORE_PATTERNS` は組み込みの無視パターンです。
|
|
87
|
+
- `isIgnoredContentPath(path, exclude?)` は論理コンテンツパスが無視対象かを返します。
|
|
88
|
+
- `matchContentExcludePattern(path, exclude?)` は一致した設定上のパターンを返します。
|
|
89
|
+
|
|
90
|
+
これらのヘルパーは絶対ファイルシステムパスではなく、`/` 区切りの論理コンテンツパスを
|
|
91
|
+
対象にします。
|
|
92
|
+
|
|
93
|
+
## パッケージ境界
|
|
94
|
+
|
|
95
|
+
`@riebeckite/core` は移植可能な `ContentSource` 契約とコンテンツパイプラインを
|
|
96
|
+
定義します。このパッケージはその契約の Node.js ファイルシステム実装です。
|
|
97
|
+
ファイルシステム固有の API は `@riebeckite/core` ではなく `@riebeckite/node` から
|
|
98
|
+
インポートしてください。
|
|
99
|
+
|
|
100
|
+
## 関連資料
|
|
101
|
+
|
|
102
|
+
- [`@riebeckite/core`](../core/README_ja.md)
|
|
103
|
+
- [コンテンツシステム](../../docs/docs/framework/content-system.md)
|
|
104
|
+
- [設定リファレンス](../../docs/docs/reference/configuration.md)
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
// src/file_system_content_source.ts
|
|
2
|
+
import fs from "node:fs/promises";
|
|
3
|
+
import path from "node:path";
|
|
4
|
+
import {
|
|
5
|
+
isExcluded,
|
|
6
|
+
normalizeContentPath
|
|
7
|
+
} from "@riebeckite/core";
|
|
8
|
+
var INTERNAL_CONTENT_IGNORE_PATTERNS = [
|
|
9
|
+
".riebeckite",
|
|
10
|
+
".riebeckite/**",
|
|
11
|
+
".git",
|
|
12
|
+
".git/**",
|
|
13
|
+
".github",
|
|
14
|
+
".github/**",
|
|
15
|
+
".obsidian",
|
|
16
|
+
".obsidian/**",
|
|
17
|
+
"node_modules",
|
|
18
|
+
"node_modules/**",
|
|
19
|
+
"**/.DS_Store",
|
|
20
|
+
"**/Thumbs.db",
|
|
21
|
+
"**/desktop.ini"
|
|
22
|
+
];
|
|
23
|
+
var FileSystemContentSource = class {
|
|
24
|
+
constructor(contentDirectory, exclude = []) {
|
|
25
|
+
this.contentDirectory = contentDirectory;
|
|
26
|
+
this.exclude = exclude;
|
|
27
|
+
}
|
|
28
|
+
contentDirectory;
|
|
29
|
+
exclude;
|
|
30
|
+
async scan() {
|
|
31
|
+
return (await this.scanWithExclusions()).entries;
|
|
32
|
+
}
|
|
33
|
+
async scanWithExclusions() {
|
|
34
|
+
const exclusions = [];
|
|
35
|
+
try {
|
|
36
|
+
const templaterTemplateFolder = await this.resolveTemplaterTemplateFolder();
|
|
37
|
+
const entries = await this.scanDirectory(
|
|
38
|
+
this.contentDirectory,
|
|
39
|
+
"",
|
|
40
|
+
exclusions,
|
|
41
|
+
templaterTemplateFolder
|
|
42
|
+
);
|
|
43
|
+
return { entries, exclusions };
|
|
44
|
+
} catch (error) {
|
|
45
|
+
if (isMissingDirectoryError(error, this.contentDirectory)) {
|
|
46
|
+
throw missingContentDirectoryError(this.contentDirectory);
|
|
47
|
+
}
|
|
48
|
+
throw error;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
async read(entry) {
|
|
52
|
+
const filePath = this.resolveFilePath(entry.path);
|
|
53
|
+
const stats = await fs.lstat(filePath);
|
|
54
|
+
if (!stats.isFile() || stats.isSymbolicLink()) {
|
|
55
|
+
throw new Error(`Content entry is not a regular file: ${entry.path}`);
|
|
56
|
+
}
|
|
57
|
+
return await fs.readFile(filePath);
|
|
58
|
+
}
|
|
59
|
+
async scanDirectory(directory, parentPath, exclusions, templaterTemplateFolder) {
|
|
60
|
+
const directoryEntries = (await fs.readdir(directory, {
|
|
61
|
+
withFileTypes: true
|
|
62
|
+
})).toSorted((left, right) => left.name.localeCompare(right.name, "en"));
|
|
63
|
+
const entries = [];
|
|
64
|
+
for (const directoryEntry of directoryEntries) {
|
|
65
|
+
if (directoryEntry.isSymbolicLink()) continue;
|
|
66
|
+
const logicalPath = normalizeContentPath(
|
|
67
|
+
parentPath ? `${parentPath}/${directoryEntry.name}` : directoryEntry.name
|
|
68
|
+
);
|
|
69
|
+
const filePath = path.join(directory, directoryEntry.name);
|
|
70
|
+
if (isExcluded(INTERNAL_CONTENT_IGNORE_PATTERNS, logicalPath)) continue;
|
|
71
|
+
const pattern = matchContentExcludePattern(logicalPath, this.exclude);
|
|
72
|
+
if (pattern !== void 0) {
|
|
73
|
+
exclusions.push({ path: logicalPath, pattern });
|
|
74
|
+
continue;
|
|
75
|
+
}
|
|
76
|
+
if (templaterTemplateFolder && isTemplaterTemplatePath(logicalPath, templaterTemplateFolder)) {
|
|
77
|
+
exclusions.push({
|
|
78
|
+
path: logicalPath,
|
|
79
|
+
pattern: `Obsidian Templater templates_folder: ${templaterTemplateFolder}`
|
|
80
|
+
});
|
|
81
|
+
continue;
|
|
82
|
+
}
|
|
83
|
+
if (directoryEntry.isDirectory()) {
|
|
84
|
+
entries.push(
|
|
85
|
+
...await this.scanDirectory(
|
|
86
|
+
filePath,
|
|
87
|
+
logicalPath,
|
|
88
|
+
exclusions,
|
|
89
|
+
templaterTemplateFolder
|
|
90
|
+
)
|
|
91
|
+
);
|
|
92
|
+
continue;
|
|
93
|
+
}
|
|
94
|
+
if (!directoryEntry.isFile()) continue;
|
|
95
|
+
let stats;
|
|
96
|
+
try {
|
|
97
|
+
stats = await fs.stat(filePath);
|
|
98
|
+
} catch (error) {
|
|
99
|
+
if (isFileNotFoundError(error)) continue;
|
|
100
|
+
throw new Error(
|
|
101
|
+
`Could not read content file metadata: ${logicalPath}`,
|
|
102
|
+
{ cause: error }
|
|
103
|
+
);
|
|
104
|
+
}
|
|
105
|
+
const createdAt = validTimestamp(stats.birthtimeMs, logicalPath, "ctime");
|
|
106
|
+
const modifiedAt = validTimestamp(stats.mtimeMs, logicalPath, "mtime");
|
|
107
|
+
const size = validSize(stats.size, logicalPath);
|
|
108
|
+
entries.push({
|
|
109
|
+
path: logicalPath,
|
|
110
|
+
metadata: {
|
|
111
|
+
createdAt,
|
|
112
|
+
modifiedAt,
|
|
113
|
+
size
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
return entries;
|
|
118
|
+
}
|
|
119
|
+
resolveFilePath(logicalPath) {
|
|
120
|
+
const normalizedPath = normalizeLogicalPath(logicalPath);
|
|
121
|
+
const filePath = path.resolve(this.contentDirectory, normalizedPath);
|
|
122
|
+
const relativePath = path.relative(this.contentDirectory, filePath);
|
|
123
|
+
if (relativePath.startsWith("..") || path.isAbsolute(relativePath)) {
|
|
124
|
+
throw new Error(`Invalid content path: ${logicalPath}`);
|
|
125
|
+
}
|
|
126
|
+
return filePath;
|
|
127
|
+
}
|
|
128
|
+
async resolveTemplaterTemplateFolder() {
|
|
129
|
+
const settingsPath = path.join(
|
|
130
|
+
this.contentDirectory,
|
|
131
|
+
".obsidian",
|
|
132
|
+
"plugins",
|
|
133
|
+
"templater-obsidian",
|
|
134
|
+
"data.json"
|
|
135
|
+
);
|
|
136
|
+
let raw;
|
|
137
|
+
try {
|
|
138
|
+
raw = await fs.readFile(settingsPath, "utf8");
|
|
139
|
+
} catch (error) {
|
|
140
|
+
if (isFileNotFoundError(error)) return void 0;
|
|
141
|
+
throw error;
|
|
142
|
+
}
|
|
143
|
+
try {
|
|
144
|
+
const settings = JSON.parse(raw);
|
|
145
|
+
return normalizeTemplaterTemplateFolder(settings.templates_folder);
|
|
146
|
+
} catch {
|
|
147
|
+
return void 0;
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
};
|
|
151
|
+
function isIgnoredContentPath(logicalPath, exclude = []) {
|
|
152
|
+
if (isExcluded(INTERNAL_CONTENT_IGNORE_PATTERNS, logicalPath)) return true;
|
|
153
|
+
return matchContentExcludePattern(logicalPath, exclude) !== void 0;
|
|
154
|
+
}
|
|
155
|
+
function matchContentExcludePattern(logicalPath, exclude = []) {
|
|
156
|
+
const direct = exclude.find((pattern) => isExcluded([pattern], logicalPath));
|
|
157
|
+
if (direct !== void 0) return direct;
|
|
158
|
+
if (!logicalPath.endsWith(".md")) return void 0;
|
|
159
|
+
const withoutExtension = logicalPath.slice(0, -3);
|
|
160
|
+
return exclude.find((pattern) => isExcluded([pattern], withoutExtension));
|
|
161
|
+
}
|
|
162
|
+
function isTemplaterTemplatePath(logicalPath, templateFolder) {
|
|
163
|
+
return logicalPath === templateFolder || logicalPath.startsWith(`${templateFolder}/`);
|
|
164
|
+
}
|
|
165
|
+
function normalizeTemplaterTemplateFolder(value) {
|
|
166
|
+
if (typeof value !== "string" || value.trim().length === 0) return void 0;
|
|
167
|
+
const normalized = normalizeContentPath(value.trim()).replace(/\/+$/, "");
|
|
168
|
+
if (normalized.length === 0 || normalized.startsWith("/") || path.isAbsolute(normalized) || path.win32.isAbsolute(normalized) || normalized.split("/").some((segment) => segment === "..")) {
|
|
169
|
+
return void 0;
|
|
170
|
+
}
|
|
171
|
+
return normalized;
|
|
172
|
+
}
|
|
173
|
+
function normalizeLogicalPath(logicalPath) {
|
|
174
|
+
const normalizedPath = normalizeContentPath(logicalPath);
|
|
175
|
+
if (normalizedPath.length === 0 || normalizedPath.startsWith("/") || path.isAbsolute(normalizedPath) || path.win32.isAbsolute(normalizedPath) || normalizedPath.split("/").some((segment) => segment === "..")) {
|
|
176
|
+
throw new Error(`Invalid content path: ${logicalPath}`);
|
|
177
|
+
}
|
|
178
|
+
return normalizedPath;
|
|
179
|
+
}
|
|
180
|
+
function isMissingDirectoryError(error, directory) {
|
|
181
|
+
return error instanceof Error && "code" in error && error.code === "ENOENT" && "path" in error && error.path === directory;
|
|
182
|
+
}
|
|
183
|
+
function isFileNotFoundError(error) {
|
|
184
|
+
return error instanceof Error && "code" in error && error.code === "ENOENT";
|
|
185
|
+
}
|
|
186
|
+
function validTimestamp(value, logicalPath, name) {
|
|
187
|
+
if (Number.isFinite(value)) return value;
|
|
188
|
+
throw new Error(`Invalid ${name} metadata for content file: ${logicalPath}`);
|
|
189
|
+
}
|
|
190
|
+
function validSize(value, logicalPath) {
|
|
191
|
+
if (Number.isSafeInteger(value) && value >= 0) return value;
|
|
192
|
+
throw new Error(`Invalid size metadata for content file: ${logicalPath}`);
|
|
193
|
+
}
|
|
194
|
+
function missingContentDirectoryError(directory) {
|
|
195
|
+
const relative = path.relative(process.cwd(), directory);
|
|
196
|
+
const display = relative && !relative.startsWith("..") ? relative : directory;
|
|
197
|
+
const error = new Error(
|
|
198
|
+
`Could not find the content directory:
|
|
199
|
+
|
|
200
|
+
${display}`
|
|
201
|
+
);
|
|
202
|
+
error.hint = "Check `content.directory` in your Riebeckite configuration.";
|
|
203
|
+
return error;
|
|
204
|
+
}
|
|
205
|
+
export {
|
|
206
|
+
FileSystemContentSource,
|
|
207
|
+
INTERNAL_CONTENT_IGNORE_PATTERNS,
|
|
208
|
+
isIgnoredContentPath,
|
|
209
|
+
matchContentExcludePattern
|
|
210
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { type ContentSource, type ContentSourceContent, type ContentSourceEntry } from "@riebeckite/core";
|
|
2
|
+
export declare const INTERNAL_CONTENT_IGNORE_PATTERNS: readonly [".riebeckite", ".riebeckite/**", ".git", ".git/**", ".github", ".github/**", ".obsidian", ".obsidian/**", "node_modules", "node_modules/**", "**/.DS_Store", "**/Thumbs.db", "**/desktop.ini"];
|
|
3
|
+
export type ContentSourceExclusion = {
|
|
4
|
+
readonly path: string;
|
|
5
|
+
readonly pattern: string;
|
|
6
|
+
};
|
|
7
|
+
export type ContentSourceScan = {
|
|
8
|
+
readonly entries: readonly ContentSourceEntry[];
|
|
9
|
+
readonly exclusions: readonly ContentSourceExclusion[];
|
|
10
|
+
};
|
|
11
|
+
export declare class FileSystemContentSource implements ContentSource {
|
|
12
|
+
private contentDirectory;
|
|
13
|
+
private exclude;
|
|
14
|
+
constructor(contentDirectory: string, exclude?: readonly string[]);
|
|
15
|
+
scan(): Promise<readonly ContentSourceEntry[]>;
|
|
16
|
+
scanWithExclusions(): Promise<ContentSourceScan>;
|
|
17
|
+
read(entry: ContentSourceEntry): Promise<ContentSourceContent>;
|
|
18
|
+
private scanDirectory;
|
|
19
|
+
private resolveFilePath;
|
|
20
|
+
private resolveTemplaterTemplateFolder;
|
|
21
|
+
}
|
|
22
|
+
export declare function isIgnoredContentPath(logicalPath: string, exclude?: readonly string[]): boolean;
|
|
23
|
+
export declare function matchContentExcludePattern(logicalPath: string, exclude?: readonly string[]): string | undefined;
|
package/package.json
CHANGED
|
@@ -1,6 +1,56 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@riebeckite/node",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.0.33",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./dist/index.js",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"source": "./index.ts",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"LICENSE",
|
|
18
|
+
"README.md",
|
|
19
|
+
"README_ja.md",
|
|
20
|
+
"dist"
|
|
21
|
+
],
|
|
22
|
+
"publishConfig": {
|
|
23
|
+
"access": "public"
|
|
24
|
+
},
|
|
25
|
+
"dependencies": {
|
|
26
|
+
"@riebeckite/core": "0.0.33"
|
|
27
|
+
},
|
|
28
|
+
"devDependencies": {
|
|
29
|
+
"@riebeckite/test": "0.0.33",
|
|
30
|
+
"tsx": "^4.22.4"
|
|
31
|
+
},
|
|
32
|
+
"repository": {
|
|
33
|
+
"type": "git",
|
|
34
|
+
"url": "https://github.com/Rerurate514/riebeckite.git",
|
|
35
|
+
"directory": "packages/node"
|
|
36
|
+
},
|
|
37
|
+
"homepage": "https://github.com/Rerurate514/riebeckite#readme",
|
|
38
|
+
"bugs": {
|
|
39
|
+
"url": "https://github.com/Rerurate514/riebeckite/issues"
|
|
40
|
+
},
|
|
41
|
+
"description": "Node.js adapters for Riebeckite.",
|
|
42
|
+
"keywords": [
|
|
43
|
+
"riebeckite",
|
|
44
|
+
"node",
|
|
45
|
+
"content-source",
|
|
46
|
+
"filesystem"
|
|
47
|
+
],
|
|
48
|
+
"engines": {
|
|
49
|
+
"node": "^20.19.0 || >=22.12.0"
|
|
50
|
+
},
|
|
51
|
+
"sideEffects": false,
|
|
52
|
+
"scripts": {
|
|
53
|
+
"build": "node ../../scripts/build_package.mjs",
|
|
54
|
+
"test": "node --import tsx --test \"test/*.test.ts\""
|
|
55
|
+
}
|
|
6
56
|
}
|