Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

feat: pull in new globSource #3889

Merged
merged 5 commits into from
Sep 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ jobs:
with:
node-version: 16
- uses: actions/cache@v2
id: cache
env:
CACHE_NAME: cache-node-modules
with:
Expand All @@ -41,6 +42,7 @@ jobs:
with:
node-version: 16
- uses: actions/cache@v2
id: cache
env:
CACHE_NAME: cache-node-modules
with:
Expand Down
9 changes: 4 additions & 5 deletions docs/MODULE.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the IPFS module as a dependency of your project to spawn in process instance
- [`node.start()`](#nodestart)
- [Static types and utils](#static-types-and-utils)
- [Glob source](#glob-source)
- [`globSource(path, [options])`](#globsourcepath-options)
- [`globSource(path, pattern, [options])`](#globsourcepath-pattern-options)
- [Example](#example)
- [URL source](#url-source)
- [`urlSource(url)`](#urlsourceurl)
Expand Down Expand Up @@ -398,12 +398,11 @@ import { CID } from 'ipfs'

A utility to allow files on the file system to be easily added to IPFS.

###### `globSource(path, [options])`
###### `globSource(path, pattern, [options])`

- `path`: A path to a single file or directory to glob from
- `pattern`: A pattern to match files under `path`
- `options`: Optional options
- `options.recursive`: If `path` is a directory, use option `{ recursive: true }` to add the directory and all its sub-directories.
- `options.ignore`: To exclude file globs from the directory, use option `{ ignore: ['ignore/this/folder/**', 'and/this/file'] }`.
- `options.hidden`: Hidden/dot files (files or folders starting with a `.`, for example, `.git/`) are not included by default. To add them, use the option `{ hidden: true }`.

Returns an async iterable that yields `{ path, content }` objects suitable for passing to `ipfs.add`.
Expand All @@ -415,7 +414,7 @@ import { create, globSource } from 'ipfs'

const ipfs = await create()

for await (const file of ipfs.addAll(globSource('./docs', { recursive: true }))) {
for await (const file of ipfs.addAll(globSource('./docs', '**/*'))) {
console.log(file)
}
/*
Expand Down
5 changes: 2 additions & 3 deletions packages/interface-ipfs-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@
"browser": {
"fs": false,
"os": false,
"path": false,
"ipfs-utils/src/files/glob-source": false
"path": false
},
"scripts": {
"clean": "rimraf ./dist",
Expand Down Expand Up @@ -76,7 +75,7 @@
"ipfs-core-types": "^0.7.3",
"ipfs-unixfs": "^6.0.3",
"ipfs-unixfs-importer": "^9.0.3",
"ipfs-utils": "^8.1.4",
"ipfs-utils": "^9.0.1",
"ipns": "^0.14.0",
"is-ipfs": "^6.0.1",
"iso-random-stream": "^2.0.0",
Expand Down
17 changes: 8 additions & 9 deletions packages/interface-ipfs-core/src/add-all.js
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ export function testAddAll (factory, options) {
if (!isNode) this.skip()
const filesPath = resolve('test/fixtures/test-folder', 'interface-ipfs-core')

const result = await all(ipfs.addAll(globSource(filesPath, { recursive: true })))
const result = await all(ipfs.addAll(globSource(filesPath, '**/*')))
expect(result.length).to.be.above(8)
})

Expand All @@ -407,7 +407,7 @@ export function testAddAll (factory, options) {

const filesPath = resolve('test/fixtures/weird name folder [v0]', 'interface-ipfs-core')

const result = await all(ipfs.addAll(globSource(filesPath, { recursive: true })))
const result = await all(ipfs.addAll(globSource(filesPath, '**/*')))
expect(result.length).to.be.above(8)
})

Expand All @@ -417,17 +417,17 @@ export function testAddAll (factory, options) {

const filesPath = resolve('test/fixtures/test-folder', 'interface-ipfs-core')

const result = await all(ipfs.addAll(globSource(filesPath, { recursive: true, ignore: ['files/**'] })))
expect(result.length).to.be.below(9)
const result = await all(ipfs.addAll(globSource(filesPath, '@(!(files*))')))
expect(result.length).to.equal(6)
})

it('should add a file from the file system', async function () {
// @ts-ignore this is mocha
if (!isNode) this.skip()

const filePath = resolve('test/fixtures/test-folder/ipfs-add.js', 'interface-ipfs-core')
const filePath = resolve('test/fixtures/test-folder', 'interface-ipfs-core')

const result = await all(ipfs.addAll(globSource(filePath)))
const result = await all(ipfs.addAll(globSource(filePath, 'ipfs-add.js')))
expect(result.length).to.equal(1)
expect(result[0].path).to.equal('ipfs-add.js')
})
Expand All @@ -436,10 +436,9 @@ export function testAddAll (factory, options) {
// @ts-ignore this is mocha
if (!isNode) this.skip()

const filesPath = resolve('test/fixtures/hidden-files-folder', 'interface-ipfs-core')
const filesPath = resolve('test/fixtures', 'interface-ipfs-core')

const result = await all(ipfs.addAll(globSource(filesPath, { recursive: true, hidden: true })))
expect(result.length).to.be.above(10)
const result = await all(ipfs.addAll(globSource(filesPath, 'hidden-files-folder/**/*', { hidden: true })))
expect(result.map(object => object.path)).to.include('hidden-files-folder/.hiddenTest.txt')
expect(result.map(object => object.cid.toString())).to.include('QmdbAjVmLRdpFyi8FFvjPfhTGB2cVXvWLuK7Sbt38HXrtt')
})
Expand Down
3 changes: 2 additions & 1 deletion packages/ipfs-cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,13 @@
"ipfs-daemon": "^0.9.8",
"ipfs-http-client": "^52.0.5",
"ipfs-repo": "^12.0.0",
"ipfs-utils": "^8.1.4",
"ipfs-utils": "^9.0.1",
"it-all": "^1.0.4",
"it-concat": "^2.0.0",
"it-first": "^1.0.4",
"it-glob": "1.0.0",
"it-map": "^1.0.5",
"it-merge": "^1.0.3",
"it-pipe": "^1.1.0",
"it-split": "^1.0.0",
"it-tar": "^4.0.0",
Expand Down
12 changes: 9 additions & 3 deletions packages/ipfs-cli/src/commands/add.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import {
} from '../utils.js'
import globSource from 'ipfs-utils/src/files/glob-source.js'
import parseDuration from 'parse-duration'
import merge from 'it-merge'

const getFolderSize = promisify(getFolderSizeCb)

Expand Down Expand Up @@ -286,15 +287,20 @@ export default {
date = { secs: mtime, nsecs: mtimeNsecs }
}

let pattern = '*'

if (recursive) {
pattern = '**/*'
}

const source = file
? globSource(file, {
recursive,
? merge(...file.map(file => globSource(file, pattern, {
hidden,
preserveMode,
preserveMtime,
mode,
mtime: date
})
})))
: [{
content: getStdin(),
mode,
Expand Down
2 changes: 1 addition & 1 deletion packages/ipfs-core-config/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
"err-code": "^3.0.1",
"hashlru": "^2.3.0",
"ipfs-repo": "^12.0.0",
"ipfs-utils": "^8.1.4",
"ipfs-utils": "^9.0.1",
"ipns": "^0.14.0",
"is-ipfs": "^6.0.1",
"it-all": "^1.0.4",
Expand Down
2 changes: 1 addition & 1 deletion packages/ipfs-core-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
"err-code": "^3.0.1",
"ipfs-core-types": "^0.7.3",
"ipfs-unixfs": "^6.0.3",
"ipfs-utils": "^8.1.4",
"ipfs-utils": "^9.0.1",
"it-all": "^1.0.4",
"it-map": "^1.0.4",
"it-peekable": "^1.0.2",
Expand Down
5 changes: 1 addition & 4 deletions packages/ipfs-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,6 @@
"import": "./src/components/config/profiles.js"
}
},
"browser": {
"ipfs-utils/src/files/glob-source": false
},
"repository": {
"type": "git",
"url": "git+https://github.com/ipfs/js-ipfs.git"
Expand Down Expand Up @@ -94,7 +91,7 @@
"ipfs-unixfs": "^6.0.3",
"ipfs-unixfs-exporter": "^7.0.3",
"ipfs-unixfs-importer": "^9.0.3",
"ipfs-utils": "^8.1.4",
"ipfs-utils": "^9.0.1",
"ipns": "^0.14.0",
"is-domain-name": "^1.0.1",
"is-ipfs": "^6.0.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/ipfs-daemon/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"ipfs-grpc-server": "^0.6.6",
"ipfs-http-gateway": "^0.6.5",
"ipfs-http-server": "^0.7.6",
"ipfs-utils": "^8.1.4",
"ipfs-utils": "^9.0.1",
"just-safe-set": "^2.2.1",
"libp2p": "^0.32.0",
"libp2p-webrtc-star": "^0.23.0"
Expand Down
16 changes: 8 additions & 8 deletions packages/ipfs-http-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
- [Instance Utils](#instance-utils)
- [Static Types and Utils](#static-types-and-utils)
- [Glob source](#glob-source)
- [`globSource(path, [options])`](#globsourcepath-options)
- [`globSource(path, pattern, [options])`](#globsourcepath-pattern-options)
- [Example](#example-1)
- [URL source](#url-source)
- [`urlSource(url)`](#urlsourceurl)
Expand Down Expand Up @@ -182,25 +182,25 @@ import { CID } from 'ipfs-http-client'

A utility to allow files on the file system to be easily added to IPFS.

##### `globSource(path, [options])`
##### `globSource(path, pattern, [options])`

- `path`: A path to a single file or directory to glob from
- `pattern`: A pattern to match files under `path`
- `options`: Optional options
- `options.recursive`: If `path` is a directory, use option `{ recursive: true }` to add the directory and all its sub-directories.
- `options.ignore`: To exclude file globs from the directory, use option `{ ignore: ['ignore/this/folder/**', 'and/this/file'] }`.
- `options.hidden`: Hidden/dot files (files or folders starting with a `.`, for example, `.git/`) are not included by default. To add them, use the option `{ hidden: true }`.

Returns an async iterable that yields `{ path, content }` objects suitable for passing to `ipfs.add`.

##### Example

```js
import { create, globSource } from 'ipfs-http-client'
const ipfs = create()
import { create, globSource } from 'ipfs'

const file = await ipfs.add(globSource('./docs', { recursive: true }))
console.log(file)
const ipfs = await create()

for await (const file of ipfs.addAll(globSource('./docs', '**/*'))) {
console.log(file)
}
/*
{
path: 'docs/assets/anchor.js',
Expand Down
2 changes: 1 addition & 1 deletion packages/ipfs-http-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
"err-code": "^3.0.1",
"ipfs-core-types": "^0.7.3",
"ipfs-core-utils": "^0.10.5",
"ipfs-utils": "^8.1.4",
"ipfs-utils": "^9.0.1",
"it-first": "^1.0.6",
"it-last": "^1.0.4",
"merge-options": "^3.0.4",
Expand Down
4 changes: 2 additions & 2 deletions packages/ipfs-http-client/src/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

/* eslint-env browser */

import { Multibases } from 'ipfs-core-utils/multibases'
Expand Down Expand Up @@ -42,6 +41,7 @@ import { createResolve } from './resolve.js'
import { createStart } from './start.js'
import { createStop } from './stop.js'
import { createVersion } from './version.js'
import globSourceImport from 'ipfs-utils/src/files/glob-source.js'

/**
* @typedef {import('./types').EndpointConfig} EndpointConfig
Expand Down Expand Up @@ -142,5 +142,5 @@ export function create (options = {}) {

export { CID } from 'multiformats/cid'
export { Multiaddr as multiaddr } from 'multiaddr'
export { default as globSource } from 'ipfs-utils/src/files/glob-source.js'
export { default as urlSource } from 'ipfs-utils/src/files/url-source.js'
export const globSource = globSourceImport
4 changes: 2 additions & 2 deletions packages/ipfs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@
"ipfs-client": "^0.6.6",
"ipfs-core-types": "^0.7.3",
"ipfs-http-client": "^52.0.5",
"ipfs-interop": "^6.0.1",
"ipfs-utils": "^8.1.4",
"ipfs-interop": "ipfs/interop#chore/update-globsource",
"ipfs-utils": "^9.0.1",
"ipfsd-ctl": "^10.0.3",
"iso-url": "^1.0.0",
"libp2p-webrtc-star": "^0.23.0",
Expand Down