Skip to content

Commit a70f4eb

Browse files
achingbrainachingbrain
committed
feat: initial import
0 parents  commit a70f4eb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+3069
-0
lines changed

‎.github/dependabot.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
time: "10:00"
8+
open-pull-requests-limit: 10
9+
commit-message:
10+
prefix: "deps"
11+
prefix-development: "deps(dev)"

‎.github/workflows/automerge.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: Automerge
2+
on: [ pull_request ]
3+
4+
jobs:
5+
automerge:
6+
uses: protocol/.github/.github/workflows/automerge.yml@master
7+
with:
8+
job: 'automerge'

‎.github/workflows/js-test-and-release.yml

+182
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
name: test & maybe release
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
8+
jobs:
9+
10+
check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v3
14+
- uses: actions/setup-node@v3
15+
with:
16+
node-version: lts/*
17+
- uses: ipfs/aegir/actions/cache-node-modules@master
18+
- run: npm run --if-present lint
19+
- run: npm run --if-present dep-check
20+
- run: npm run --if-present doc-check
21+
22+
test-node:
23+
needs: check
24+
runs-on: ${{ matrix.os }}
25+
strategy:
26+
matrix:
27+
os: [windows-latest, ubuntu-latest, macos-latest]
28+
node: [lts/*]
29+
fail-fast: true
30+
steps:
31+
- uses: actions/checkout@v3
32+
- uses: actions/setup-node@v3
33+
with:
34+
node-version: ${{ matrix.node }}
35+
- uses: ipfs/aegir/actions/cache-node-modules@master
36+
- run: npm run --if-present test:node
37+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
38+
with:
39+
flags: node
40+
41+
test-chrome:
42+
needs: check
43+
runs-on: ubuntu-latest
44+
steps:
45+
- uses: actions/checkout@v3
46+
- uses: actions/setup-node@v3
47+
with:
48+
node-version: lts/*
49+
- uses: ipfs/aegir/actions/cache-node-modules@master
50+
- run: npm run --if-present test:chrome
51+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
52+
with:
53+
flags: chrome
54+
55+
test-chrome-webworker:
56+
needs: check
57+
runs-on: ubuntu-latest
58+
steps:
59+
- uses: actions/checkout@v3
60+
- uses: actions/setup-node@v3
61+
with:
62+
node-version: lts/*
63+
- uses: ipfs/aegir/actions/cache-node-modules@master
64+
- run: npm run --if-present test:chrome-webworker
65+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
66+
with:
67+
flags: chrome-webworker
68+
69+
test-firefox:
70+
needs: check
71+
runs-on: ubuntu-latest
72+
steps:
73+
- uses: actions/checkout@v3
74+
- uses: actions/setup-node@v3
75+
with:
76+
node-version: lts/*
77+
- uses: ipfs/aegir/actions/cache-node-modules@master
78+
- run: npm run --if-present test:firefox
79+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
80+
with:
81+
flags: firefox
82+
83+
test-firefox-webworker:
84+
needs: check
85+
runs-on: ubuntu-latest
86+
steps:
87+
- uses: actions/checkout@v3
88+
- uses: actions/setup-node@v3
89+
with:
90+
node-version: lts/*
91+
- uses: ipfs/aegir/actions/cache-node-modules@master
92+
- run: npm run --if-present test:firefox-webworker
93+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
94+
with:
95+
flags: firefox-webworker
96+
97+
test-webkit:
98+
needs: check
99+
runs-on: ${{ matrix.os }}
100+
strategy:
101+
matrix:
102+
os: [ubuntu-latest, macos-latest]
103+
node: [lts/*]
104+
fail-fast: true
105+
steps:
106+
- uses: actions/checkout@v3
107+
- uses: actions/setup-node@v3
108+
with:
109+
node-version: lts/*
110+
- uses: ipfs/aegir/actions/cache-node-modules@master
111+
- run: npm run --if-present test:webkit
112+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
113+
with:
114+
flags: webkit
115+
116+
test-webkit-webworker:
117+
needs: check
118+
runs-on: ${{ matrix.os }}
119+
strategy:
120+
matrix:
121+
os: [ubuntu-latest, macos-latest]
122+
node: [lts/*]
123+
fail-fast: true
124+
steps:
125+
- uses: actions/checkout@v3
126+
- uses: actions/setup-node@v3
127+
with:
128+
node-version: lts/*
129+
- uses: ipfs/aegir/actions/cache-node-modules@master
130+
- run: npm run --if-present test:webkit-webworker
131+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
132+
with:
133+
flags: webkit-webworker
134+
135+
test-electron-main:
136+
needs: check
137+
runs-on: ubuntu-latest
138+
steps:
139+
- uses: actions/checkout@v3
140+
- uses: actions/setup-node@v3
141+
with:
142+
node-version: lts/*
143+
- uses: ipfs/aegir/actions/cache-node-modules@master
144+
- run: npx xvfb-maybe npm run --if-present test:electron-main
145+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
146+
with:
147+
flags: electron-main
148+
149+
test-electron-renderer:
150+
needs: check
151+
runs-on: ubuntu-latest
152+
steps:
153+
- uses: actions/checkout@v3
154+
- uses: actions/setup-node@v3
155+
with:
156+
node-version: lts/*
157+
- uses: ipfs/aegir/actions/cache-node-modules@master
158+
- run: npx xvfb-maybe npm run --if-present test:electron-renderer
159+
- uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
160+
with:
161+
flags: electron-renderer
162+
163+
release:
164+
needs: [test-node, test-chrome, test-chrome-webworker, test-firefox, test-firefox-webworker, test-webkit, test-webkit-webworker, test-electron-main, test-electron-renderer]
165+
runs-on: ubuntu-latest
166+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
167+
steps:
168+
- uses: actions/checkout@v3
169+
with:
170+
fetch-depth: 0
171+
- uses: actions/setup-node@v3
172+
with:
173+
node-version: lts/*
174+
- uses: ipfs/aegir/actions/cache-node-modules@master
175+
- uses: ipfs/aegir/actions/docker-login@master
176+
with:
177+
docker-token: ${{ secrets.DOCKER_TOKEN }}
178+
docker-username: ${{ secrets.DOCKER_USERNAME }}
179+
- run: npm run --if-present release
180+
env:
181+
GITHUB_TOKEN: ${{ secrets.UCI_GITHUB_TOKEN || github.token }}
182+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.github/workflows/stale.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Close and mark stale issue
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 * * *'
6+
7+
jobs:
8+
stale:
9+
10+
runs-on: ubuntu-latest
11+
permissions:
12+
issues: write
13+
pull-requests: write
14+
15+
steps:
16+
- uses: actions/stale@v3
17+
with:
18+
repo-token: ${{ secrets.GITHUB_TOKEN }}
19+
stale-issue-message: 'Oops, seems like we needed more information for this issue, please comment with more details or this issue will be closed in 7 days.'
20+
close-issue-message: 'This issue was closed because it is missing author input.'
21+
stale-issue-label: 'kind/stale'
22+
any-of-labels: 'need/author-input'
23+
exempt-issue-labels: 'need/triage,need/community-input,need/maintainer-input,need/maintainers-input,need/analysis,status/blocked,status/in-progress,status/ready,status/deferred,status/inactive'
24+
days-before-issue-stale: 6
25+
days-before-issue-close: 7
26+
enable-statistics: true

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
node_modules
2+
build
3+
dist
4+
.docs
5+
.coverage
6+
node_modules
7+
package-lock.json
8+
yarn.lock
9+
.vscode

‎LICENSE

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
This project is dual licensed under MIT and Apache-2.0.
2+
3+
MIT: https://www.opensource.org/licenses/mit
4+
Apache-2.0: https://www.apache.org/licenses/license-2.0

‎LICENSE-APACHE

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
2+
3+
http://www.apache.org/licenses/LICENSE-2.0
4+
5+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

‎LICENSE-MIT

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The MIT License (MIT)
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is
8+
furnished to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in
11+
all copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

‎README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<p align="center">
2+
<a href="https://github.com/ipfs/helia" title="Helia">
3+
<img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia logo" width="300" />
4+
</a>
5+
</p>
6+
7+
# @helia/mfs <!-- omit in toc -->
8+
9+
[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
10+
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
11+
[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-mfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-mfs)
12+
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-mfs/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-mfs/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
13+
14+
> A mutable filesystem powered by Helia
15+
16+
## Table of contents <!-- omit in toc -->
17+
18+
- - [Structure](#structure)
19+
- [@helia/unixfs <!-- omit in toc -->](#heliaunixfs----omit-in-toc---)
20+
- [API Docs](#api-docs)
21+
- [License](#license)
22+
- [Contribute](#contribute)
23+
24+
## Structure
25+
26+
- [`/packages/interop`](./packages/interop) Interop tests for @helia/mfs
27+
- [`/packages/mfs`](./packages/mfs) A mutable filesystem powered by Helia
28+
29+
## API Docs
30+
31+
- <https://ipfs.github.io/helia-mfs>
32+
33+
## License
34+
35+
Licensed under either of
36+
37+
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
38+
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
39+
40+
## Contribute
41+
42+
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-mfs/issues).
43+
44+
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
45+
46+
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
47+
48+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
49+
50+
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

‎package.json

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"name": "@helia/mfs",
3+
"version": "0.0.0",
4+
"description": "A mutable filesystem powered by Helia",
5+
"license": "Apache-2.0 OR MIT",
6+
"homepage": "https://github.com/ipfs/helia-mfs#readme",
7+
"repository": {
8+
"type": "git",
9+
"url": "git+https://github.com/ipfs/helia-mfs.git"
10+
},
11+
"bugs": {
12+
"url": "https://github.com/ipfs/helia-mfs/issues"
13+
},
14+
"keywords": [
15+
"ipfs"
16+
],
17+
"private": true,
18+
"scripts": {
19+
"reset": "aegir run clean && aegir clean **/node_modules **/package-lock.json",
20+
"test": "aegir run test",
21+
"test:node": "aegir run test:node",
22+
"test:chrome": "aegir run test:chrome",
23+
"test:chrome-webworker": "aegir run test:chrome-webworker",
24+
"test:firefox": "aegir run test:firefox",
25+
"test:firefox-webworker": "aegir run test:firefox-webworker",
26+
"test:electron-main": "aegir run test:electron-main",
27+
"test:electron-renderer": "aegir run test:electron-renderer",
28+
"clean": "aegir run clean",
29+
"generate": "aegir run generate",
30+
"build": "aegir run build",
31+
"lint": "aegir run lint",
32+
"docs": "NODE_OPTIONS=--max_old_space_size=8192 aegir docs -- --exclude packages/interop",
33+
"docs:no-publish": "NODE_OPTIONS=--max_old_space_size=8192 aegir docs --publish false -- --exclude packages/interop",
34+
"dep-check": "aegir run dep-check",
35+
"release": "npm run docs:no-publish && aegir run release && npm run docs"
36+
},
37+
"devDependencies": {
38+
"aegir": "^40.0.9"
39+
},
40+
"type": "module",
41+
"workspaces": [
42+
"packages/*"
43+
]
44+
}

0 commit comments

Comments
 (0)