Adapt for new repository
This commit is contained in:
57
.travis.yml
57
.travis.yml
@@ -1,57 +0,0 @@
|
|||||||
# Travis does CD, GHA does CI
|
|
||||||
if: branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/ OR branch =~ /^\d+\.\d+\.\d+(-.*)?$/
|
|
||||||
|
|
||||||
stages:
|
|
||||||
- name: deploy
|
|
||||||
if: branch =~ /^deploy-\d+\.\d+\.\d+(-.*)?$/
|
|
||||||
- name: publish
|
|
||||||
if: branch =~ /^\d+\.\d+\.\d+(-.*)?$/
|
|
||||||
|
|
||||||
os: osx
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
include:
|
|
||||||
- stage: deploy
|
|
||||||
name: Deploy
|
|
||||||
osx_image: xcode11
|
|
||||||
env: HOMEBREW_NO_INSTALL_CLEANUP=1
|
|
||||||
install: brew install mxcl/made/swift-sh
|
|
||||||
git.depth: false
|
|
||||||
script:
|
|
||||||
- set -e
|
|
||||||
- export VERSION=$(echo $TRAVIS_TAG | cut -c 8-)
|
|
||||||
- git tag "$VERSION" --force
|
|
||||||
- git remote set-url origin "https://$GITHUB_TOKEN@github.com/$TRAVIS_REPO_SLUG.git"
|
|
||||||
- git push origin "$VERSION"
|
|
||||||
- swift sh <(curl https://raw.githubusercontent.com/mxcl/ops/master/deploy) publish-release
|
|
||||||
- git push origin :$TRAVIS_TAG
|
|
||||||
after_failure: |
|
|
||||||
export VERSION=$(echo $TRAVIS_TAG | cut -c 8-)
|
|
||||||
git push origin :$VERSION
|
|
||||||
|
|
||||||
- stage: publish
|
|
||||||
name: Jazzy
|
|
||||||
osx_image: xcode11
|
|
||||||
install: gem install jazzy
|
|
||||||
before_script: swift package generate-xcodeproj
|
|
||||||
script: |
|
|
||||||
jazzy --config .github/jazzy.yml \
|
|
||||||
--module-version $TRAVIS_TAG \
|
|
||||||
--github_url "https://github.com/$TRAVIS_REPO_SLUG"
|
|
||||||
deploy:
|
|
||||||
provider: pages
|
|
||||||
skip-cleanup: true
|
|
||||||
github-token: $GITHUB_TOKEN
|
|
||||||
local-dir: output
|
|
||||||
on:
|
|
||||||
tags: true
|
|
||||||
|
|
||||||
- name: CocoaPods
|
|
||||||
env: HOMEBREW_NO_INSTALL_CLEANUP=1
|
|
||||||
osx_image: xcode11
|
|
||||||
install:
|
|
||||||
- brew install mxcl/made/swift-sh
|
|
||||||
- curl -O https://raw.githubusercontent.com/mxcl/ops/master/deploy
|
|
||||||
- chmod u+x deploy
|
|
||||||
before_script: ./deploy generate-podspec
|
|
||||||
script: pod trunk push
|
|
||||||
304
LICENSE.md
304
LICENSE.md
@@ -1,27 +1,287 @@
|
|||||||
Unlicense (Public Domain)
|
EUROPEAN UNION PUBLIC LICENCE v. 1.2
|
||||||
============================
|
EUPL © the European Union 2007, 2016
|
||||||
|
|
||||||
This is free and unencumbered software released into the public domain.
|
This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
|
||||||
|
below) which is provided under the terms of this Licence. Any use of the Work,
|
||||||
|
other than as authorised under this Licence is prohibited (to the extent such
|
||||||
|
use is covered by a right of the copyright holder of the Work).
|
||||||
|
|
||||||
Anyone is free to copy, modify, publish, use, compile, sell, or
|
The Work is provided under the terms of this Licence when the Licensor (as
|
||||||
distribute this software, either in source code form or as a compiled
|
defined below) has placed the following notice immediately following the
|
||||||
binary, for any purpose, commercial or non-commercial, and by any
|
copyright notice for the Work:
|
||||||
means.
|
|
||||||
|
|
||||||
In jurisdictions that recognize copyright laws, the author or authors
|
Licensed under the EUPL
|
||||||
of this software dedicate any and all copyright interest in the
|
|
||||||
software to the public domain. We make this dedication for the benefit
|
|
||||||
of the public at large and to the detriment of our heirs and
|
|
||||||
successors. We intend this dedication to be an overt act of
|
|
||||||
relinquishment in perpetuity of all present and future rights to this
|
|
||||||
software under copyright law.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
or has expressed by any other means his willingness to license under the EUPL.
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
||||||
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
|
||||||
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
|
||||||
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
||||||
OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
For more information, please refer to <<http://unlicense.org/>>
|
1. Definitions
|
||||||
|
|
||||||
|
In this Licence, the following terms have the following meaning:
|
||||||
|
|
||||||
|
- ‘The Licence’: this Licence.
|
||||||
|
|
||||||
|
- ‘The Original Work’: the work or software distributed or communicated by the
|
||||||
|
Licensor under this Licence, available as Source Code and also as Executable
|
||||||
|
Code as the case may be.
|
||||||
|
|
||||||
|
- ‘Derivative Works’: the works or software that could be created by the
|
||||||
|
Licensee, based upon the Original Work or modifications thereof. This Licence
|
||||||
|
does not define the extent of modification or dependence on the Original Work
|
||||||
|
required in order to classify a work as a Derivative Work; this extent is
|
||||||
|
determined by copyright law applicable in the country mentioned in Article 15.
|
||||||
|
|
||||||
|
- ‘The Work’: the Original Work or its Derivative Works.
|
||||||
|
|
||||||
|
- ‘The Source Code’: the human-readable form of the Work which is the most
|
||||||
|
convenient for people to study and modify.
|
||||||
|
|
||||||
|
- ‘The Executable Code’: any code which has generally been compiled and which is
|
||||||
|
meant to be interpreted by a computer as a program.
|
||||||
|
|
||||||
|
- ‘The Licensor’: the natural or legal person that distributes or communicates
|
||||||
|
the Work under the Licence.
|
||||||
|
|
||||||
|
- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
|
||||||
|
Licence, or otherwise contributes to the creation of a Derivative Work.
|
||||||
|
|
||||||
|
- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
|
||||||
|
the Work under the terms of the Licence.
|
||||||
|
|
||||||
|
- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
|
||||||
|
renting, distributing, communicating, transmitting, or otherwise making
|
||||||
|
available, online or offline, copies of the Work or providing access to its
|
||||||
|
essential functionalities at the disposal of any other natural or legal
|
||||||
|
person.
|
||||||
|
|
||||||
|
2. Scope of the rights granted by the Licence
|
||||||
|
|
||||||
|
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
|
||||||
|
sublicensable licence to do the following, for the duration of copyright vested
|
||||||
|
in the Original Work:
|
||||||
|
|
||||||
|
- use the Work in any circumstance and for all usage,
|
||||||
|
- reproduce the Work,
|
||||||
|
- modify the Work, and make Derivative Works based upon the Work,
|
||||||
|
- communicate to the public, including the right to make available or display
|
||||||
|
the Work or copies thereof to the public and perform publicly, as the case may
|
||||||
|
be, the Work,
|
||||||
|
- distribute the Work or copies thereof,
|
||||||
|
- lend and rent the Work or copies thereof,
|
||||||
|
- sublicense rights in the Work or copies thereof.
|
||||||
|
|
||||||
|
Those rights can be exercised on any media, supports and formats, whether now
|
||||||
|
known or later invented, as far as the applicable law permits so.
|
||||||
|
|
||||||
|
In the countries where moral rights apply, the Licensor waives his right to
|
||||||
|
exercise his moral right to the extent allowed by law in order to make effective
|
||||||
|
the licence of the economic rights here above listed.
|
||||||
|
|
||||||
|
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
|
||||||
|
any patents held by the Licensor, to the extent necessary to make use of the
|
||||||
|
rights granted on the Work under this Licence.
|
||||||
|
|
||||||
|
3. Communication of the Source Code
|
||||||
|
|
||||||
|
The Licensor may provide the Work either in its Source Code form, or as
|
||||||
|
Executable Code. If the Work is provided as Executable Code, the Licensor
|
||||||
|
provides in addition a machine-readable copy of the Source Code of the Work
|
||||||
|
along with each copy of the Work that the Licensor distributes or indicates, in
|
||||||
|
a notice following the copyright notice attached to the Work, a repository where
|
||||||
|
the Source Code is easily and freely accessible for as long as the Licensor
|
||||||
|
continues to distribute or communicate the Work.
|
||||||
|
|
||||||
|
4. Limitations on copyright
|
||||||
|
|
||||||
|
Nothing in this Licence is intended to deprive the Licensee of the benefits from
|
||||||
|
any exception or limitation to the exclusive rights of the rights owners in the
|
||||||
|
Work, of the exhaustion of those rights or of other applicable limitations
|
||||||
|
thereto.
|
||||||
|
|
||||||
|
5. Obligations of the Licensee
|
||||||
|
|
||||||
|
The grant of the rights mentioned above is subject to some restrictions and
|
||||||
|
obligations imposed on the Licensee. Those obligations are the following:
|
||||||
|
|
||||||
|
Attribution right: The Licensee shall keep intact all copyright, patent or
|
||||||
|
trademarks notices and all notices that refer to the Licence and to the
|
||||||
|
disclaimer of warranties. The Licensee must include a copy of such notices and a
|
||||||
|
copy of the Licence with every copy of the Work he/she distributes or
|
||||||
|
communicates. The Licensee must cause any Derivative Work to carry prominent
|
||||||
|
notices stating that the Work has been modified and the date of modification.
|
||||||
|
|
||||||
|
Copyleft clause: If the Licensee distributes or communicates copies of the
|
||||||
|
Original Works or Derivative Works, this Distribution or Communication will be
|
||||||
|
done under the terms of this Licence or of a later version of this Licence
|
||||||
|
unless the Original Work is expressly distributed only under this version of the
|
||||||
|
Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
|
||||||
|
(becoming Licensor) cannot offer or impose any additional terms or conditions on
|
||||||
|
the Work or Derivative Work that alter or restrict the terms of the Licence.
|
||||||
|
|
||||||
|
Compatibility clause: If the Licensee Distributes or Communicates Derivative
|
||||||
|
Works or copies thereof based upon both the Work and another work licensed under
|
||||||
|
a Compatible Licence, this Distribution or Communication can be done under the
|
||||||
|
terms of this Compatible Licence. For the sake of this clause, ‘Compatible
|
||||||
|
Licence’ refers to the licences listed in the appendix attached to this Licence.
|
||||||
|
Should the Licensee's obligations under the Compatible Licence conflict with
|
||||||
|
his/her obligations under this Licence, the obligations of the Compatible
|
||||||
|
Licence shall prevail.
|
||||||
|
|
||||||
|
Provision of Source Code: When distributing or communicating copies of the Work,
|
||||||
|
the Licensee will provide a machine-readable copy of the Source Code or indicate
|
||||||
|
a repository where this Source will be easily and freely available for as long
|
||||||
|
as the Licensee continues to distribute or communicate the Work.
|
||||||
|
|
||||||
|
Legal Protection: This Licence does not grant permission to use the trade names,
|
||||||
|
trademarks, service marks, or names of the Licensor, except as required for
|
||||||
|
reasonable and customary use in describing the origin of the Work and
|
||||||
|
reproducing the content of the copyright notice.
|
||||||
|
|
||||||
|
6. Chain of Authorship
|
||||||
|
|
||||||
|
The original Licensor warrants that the copyright in the Original Work granted
|
||||||
|
hereunder is owned by him/her or licensed to him/her and that he/she has the
|
||||||
|
power and authority to grant the Licence.
|
||||||
|
|
||||||
|
Each Contributor warrants that the copyright in the modifications he/she brings
|
||||||
|
to the Work are owned by him/her or licensed to him/her and that he/she has the
|
||||||
|
power and authority to grant the Licence.
|
||||||
|
|
||||||
|
Each time You accept the Licence, the original Licensor and subsequent
|
||||||
|
Contributors grant You a licence to their contributions to the Work, under the
|
||||||
|
terms of this Licence.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty
|
||||||
|
|
||||||
|
The Work is a work in progress, which is continuously improved by numerous
|
||||||
|
Contributors. It is not a finished work and may therefore contain defects or
|
||||||
|
‘bugs’ inherent to this type of development.
|
||||||
|
|
||||||
|
For the above reason, the Work is provided under the Licence on an ‘as is’ basis
|
||||||
|
and without warranties of any kind concerning the Work, including without
|
||||||
|
limitation merchantability, fitness for a particular purpose, absence of defects
|
||||||
|
or errors, accuracy, non-infringement of intellectual property rights other than
|
||||||
|
copyright as stated in Article 6 of this Licence.
|
||||||
|
|
||||||
|
This disclaimer of warranty is an essential part of the Licence and a condition
|
||||||
|
for the grant of any rights to the Work.
|
||||||
|
|
||||||
|
8. Disclaimer of Liability
|
||||||
|
|
||||||
|
Except in the cases of wilful misconduct or damages directly caused to natural
|
||||||
|
persons, the Licensor will in no event be liable for any direct or indirect,
|
||||||
|
material or moral, damages of any kind, arising out of the Licence or of the use
|
||||||
|
of the Work, including without limitation, damages for loss of goodwill, work
|
||||||
|
stoppage, computer failure or malfunction, loss of data or any commercial
|
||||||
|
damage, even if the Licensor has been advised of the possibility of such damage.
|
||||||
|
However, the Licensor will be liable under statutory product liability laws as
|
||||||
|
far such laws apply to the Work.
|
||||||
|
|
||||||
|
9. Additional agreements
|
||||||
|
|
||||||
|
While distributing the Work, You may choose to conclude an additional agreement,
|
||||||
|
defining obligations or services consistent with this Licence. However, if
|
||||||
|
accepting obligations, You may act only on your own behalf and on your sole
|
||||||
|
responsibility, not on behalf of the original Licensor or any other Contributor,
|
||||||
|
and only if You agree to indemnify, defend, and hold each Contributor harmless
|
||||||
|
for any liability incurred by, or claims asserted against such Contributor by
|
||||||
|
the fact You have accepted any warranty or additional liability.
|
||||||
|
|
||||||
|
10. Acceptance of the Licence
|
||||||
|
|
||||||
|
The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
|
||||||
|
placed under the bottom of a window displaying the text of this Licence or by
|
||||||
|
affirming consent in any other similar way, in accordance with the rules of
|
||||||
|
applicable law. Clicking on that icon indicates your clear and irrevocable
|
||||||
|
acceptance of this Licence and all of its terms and conditions.
|
||||||
|
|
||||||
|
Similarly, you irrevocably accept this Licence and all of its terms and
|
||||||
|
conditions by exercising any rights granted to You by Article 2 of this Licence,
|
||||||
|
such as the use of the Work, the creation by You of a Derivative Work or the
|
||||||
|
Distribution or Communication by You of the Work or copies thereof.
|
||||||
|
|
||||||
|
11. Information to the public
|
||||||
|
|
||||||
|
In case of any Distribution or Communication of the Work by means of electronic
|
||||||
|
communication by You (for example, by offering to download the Work from a
|
||||||
|
remote location) the distribution channel or media (for example, a website) must
|
||||||
|
at least provide to the public the information requested by the applicable law
|
||||||
|
regarding the Licensor, the Licence and the way it may be accessible, concluded,
|
||||||
|
stored and reproduced by the Licensee.
|
||||||
|
|
||||||
|
12. Termination of the Licence
|
||||||
|
|
||||||
|
The Licence and the rights granted hereunder will terminate automatically upon
|
||||||
|
any breach by the Licensee of the terms of the Licence.
|
||||||
|
|
||||||
|
Such a termination will not terminate the licences of any person who has
|
||||||
|
received the Work from the Licensee under the Licence, provided such persons
|
||||||
|
remain in full compliance with the Licence.
|
||||||
|
|
||||||
|
13. Miscellaneous
|
||||||
|
|
||||||
|
Without prejudice of Article 9 above, the Licence represents the complete
|
||||||
|
agreement between the Parties as to the Work.
|
||||||
|
|
||||||
|
If any provision of the Licence is invalid or unenforceable under applicable
|
||||||
|
law, this will not affect the validity or enforceability of the Licence as a
|
||||||
|
whole. Such provision will be construed or reformed so as necessary to make it
|
||||||
|
valid and enforceable.
|
||||||
|
|
||||||
|
The European Commission may publish other linguistic versions or new versions of
|
||||||
|
this Licence or updated versions of the Appendix, so far this is required and
|
||||||
|
reasonable, without reducing the scope of the rights granted by the Licence. New
|
||||||
|
versions of the Licence will be published with a unique version number.
|
||||||
|
|
||||||
|
All linguistic versions of this Licence, approved by the European Commission,
|
||||||
|
have identical value. Parties can take advantage of the linguistic version of
|
||||||
|
their choice.
|
||||||
|
|
||||||
|
14. Jurisdiction
|
||||||
|
|
||||||
|
Without prejudice to specific agreement between parties,
|
||||||
|
|
||||||
|
- any litigation resulting from the interpretation of this License, arising
|
||||||
|
between the European Union institutions, bodies, offices or agencies, as a
|
||||||
|
Licensor, and any Licensee, will be subject to the jurisdiction of the Court
|
||||||
|
of Justice of the European Union, as laid down in article 272 of the Treaty on
|
||||||
|
the Functioning of the European Union,
|
||||||
|
|
||||||
|
- any litigation arising between other parties and resulting from the
|
||||||
|
interpretation of this License, will be subject to the exclusive jurisdiction
|
||||||
|
of the competent court where the Licensor resides or conducts its primary
|
||||||
|
business.
|
||||||
|
|
||||||
|
15. Applicable Law
|
||||||
|
|
||||||
|
Without prejudice to specific agreement between parties,
|
||||||
|
|
||||||
|
- this Licence shall be governed by the law of the European Union Member State
|
||||||
|
where the Licensor has his seat, resides or has his registered office,
|
||||||
|
|
||||||
|
- this licence shall be governed by Belgian law if the Licensor has no seat,
|
||||||
|
residence or registered office inside a European Union Member State.
|
||||||
|
|
||||||
|
Appendix
|
||||||
|
|
||||||
|
‘Compatible Licences’ according to Article 5 EUPL are:
|
||||||
|
|
||||||
|
- GNU General Public License (GPL) v. 2, v. 3
|
||||||
|
- GNU Affero General Public License (AGPL) v. 3
|
||||||
|
- Open Software License (OSL) v. 2.1, v. 3.0
|
||||||
|
- Eclipse Public License (EPL) v. 1.0
|
||||||
|
- CeCILL v. 2.0, v. 2.1
|
||||||
|
- Mozilla Public Licence (MPL) v. 2
|
||||||
|
- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
|
||||||
|
- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
|
||||||
|
works other than software
|
||||||
|
- European Union Public Licence (EUPL) v. 1.1, v. 1.2
|
||||||
|
- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
|
||||||
|
Reciprocity (LiLiQ-R+).
|
||||||
|
|
||||||
|
The European Commission may update this Appendix to later versions of the above
|
||||||
|
licences without producing a new version of the EUPL, as long as they provide
|
||||||
|
the rights granted in Article 2 of this Licence and protect the covered Source
|
||||||
|
Code from exclusive appropriation.
|
||||||
|
|
||||||
|
All other changes or additions to this Appendix require the production of a new
|
||||||
|
EUPL version.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
import PackageDescription
|
import PackageDescription
|
||||||
|
|
||||||
let package = Package(
|
let package = Package(
|
||||||
name: "Path.swift",
|
name: "swiftpm-pathkit",
|
||||||
products: [
|
products: [
|
||||||
.library(name: "Path", targets: ["Path"]),
|
.library(name: "Path", targets: ["Path"]),
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
Pod::Spec.new do |spec|
|
|
||||||
spec.name = "Path.swift"
|
|
||||||
spec.version = ENV['VERSION'] || "0.0.1"
|
|
||||||
spec.summary = "Delightful, robust, cross-platform and chainable file-pathing functions."
|
|
||||||
spec.homepage = "https://github.com/mxcl/Path.swift"
|
|
||||||
spec.license = "Unlicense"
|
|
||||||
spec.author = { "Max Howell" => "mxcl@me.com" }
|
|
||||||
spec.source = { :git => "https://github.com/mxcl/Path.swift.git", :tag => "#{spec.version}" }
|
|
||||||
spec.source_files = "Sources/*.swift"
|
|
||||||
spec.swift_versions = ['4.2', '5']
|
|
||||||
spec.module_name = 'Path'
|
|
||||||
spec.osx.deployment_target = '10.10'
|
|
||||||
spec.ios.deployment_target = '8.0'
|
|
||||||
spec.tvos.deployment_target = '9.0'
|
|
||||||
spec.watchos.deployment_target = '2.0'
|
|
||||||
end
|
|
||||||
107
README.md
107
README.md
@@ -1,8 +1,16 @@
|
|||||||
# Path.swift ![badge-platforms][] ![badge-languages][] [![badge-ci][]][travis] [![badge-jazzy][]][docs] [![badge-codecov][]][codecov] [![badge-version][]][cocoapods]
|
# Swift PathKit ![badge-platforms][] ![badge-languages][]
|
||||||
|
|
||||||
A file-system pathing library focused on developer experience and robust end
|
A file-system pathing library focused on developer experience and robust end
|
||||||
results.
|
results.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> This repository is a fork of [mxcl/Path.swift][] by [mxcl](), which due to inactivity does not receive new features.
|
||||||
|
|
||||||
|
[mxcl/Path.swift]: https://github.com/mxcl/Path.swift
|
||||||
|
[mxcl]: https://github.com/mxcl
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
import Path
|
import Path
|
||||||
|
|
||||||
@@ -36,31 +44,23 @@ print(foo.isFile) // => true
|
|||||||
// may not have realized existed.
|
// may not have realized existed.
|
||||||
|
|
||||||
// we support dynamic-member-syntax when joining named static members, eg:
|
// we support dynamic-member-syntax when joining named static members, eg:
|
||||||
let prefs = Path.home.Library.Preferences // => /Users/mxcl/Library/Preferences
|
let prefs = Path.home.Library.Preferences // => /Users/someuser/Library/Preferences
|
||||||
|
|
||||||
// a practical example: installing a helper executable
|
// a practical example: installing a helper executable
|
||||||
try Bundle.resources.helper.copy(into: Path.root.usr.local.bin).chmod(0o500)
|
try Bundle.resources.helper.copy(into: Path.root.usr.local.bin).chmod(0o500)
|
||||||
```
|
```
|
||||||
|
|
||||||
We emphasize safety and correctness, just like Swift, and also (again like
|
This repository emphasizes safety and correctness, just like Swift, and also (again like
|
||||||
Swift), we provide a thoughtful and comprehensive (yet concise) API.
|
Swift), we provide a thoughtful and comprehensive (yet concise) API.
|
||||||
|
|
||||||
# Sponsor @mxcl
|
|
||||||
|
|
||||||
Hi, I’m Max Howell and I have written a lot of open source software—generally
|
|
||||||
a good deal of my free time 👨🏻💻. Sponsorship helps me justify creating new open
|
|
||||||
source and maintaining it. Thank you.
|
|
||||||
|
|
||||||
[Sponsor @mxcl].
|
|
||||||
|
|
||||||
# Handbook
|
# Handbook
|
||||||
|
|
||||||
Our [online API documentation][docs] covers 100% of our public API and is
|
The [online API documentation][docs] covers 100% of the public API and is
|
||||||
automatically updated for new releases.
|
automatically updated for new releases.
|
||||||
|
|
||||||
## Codable
|
## Codable
|
||||||
|
|
||||||
We support `Codable` as you would expect:
|
`Path` conforms to `Codable`:
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
try JSONEncoder().encode([Path.home, Path.home/"foo"])
|
try JSONEncoder().encode([Path.home, Path.home/"foo"])
|
||||||
@@ -68,12 +68,12 @@ try JSONEncoder().encode([Path.home, Path.home/"foo"])
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
"/Users/mxcl",
|
"/Users/someuser",
|
||||||
"/Users/mxcl/foo",
|
"/Users/someuser/foo",
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
Though we recommend encoding *relative* paths‡:
|
`Paths` can be encoded as *relative* paths‡:
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
let encoder = JSONEncoder()
|
let encoder = JSONEncoder()
|
||||||
@@ -105,17 +105,14 @@ try decoder.decode(from: data) // would throw if `.relativePath` not set
|
|||||||
|
|
||||||
## Dynamic members
|
## Dynamic members
|
||||||
|
|
||||||
We support `@dynamicMemberLookup`:
|
`Path` supports `@dynamicMemberLookup`:
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
let ls = Path.root.usr.bin.ls // => /usr/bin/ls
|
let ls = Path.root.usr.bin.ls // => /usr/bin/ls
|
||||||
```
|
```
|
||||||
|
|
||||||
We only provide this for “starting” function, eg. `Path.home` or `Bundle.path`.
|
This is provided for “starting” functions only, eg. `Path.home` or `Bundle.path`.
|
||||||
This is because we found in practice it was easy to write incorrect code, since
|
Allowing arbitrary property access only in special cases is a precaution.
|
||||||
everything would compile if we allowed arbituary variables to take *any* named
|
|
||||||
property as valid syntax. What we have is what you want most of the time but
|
|
||||||
much less (potentially) dangerous (at runtime).
|
|
||||||
|
|
||||||
### Pathish
|
### Pathish
|
||||||
|
|
||||||
@@ -149,7 +146,7 @@ This is explicit, not hiding anything that code-review may miss and preventing
|
|||||||
common bugs like accidentally creating `Path` objects from strings you did not
|
common bugs like accidentally creating `Path` objects from strings you did not
|
||||||
expect to be relative.
|
expect to be relative.
|
||||||
|
|
||||||
Our initializer is nameless to be consistent with the equivalent operation for
|
The initializer is nameless to be consistent with the equivalent operation for
|
||||||
converting strings to `Int`, `Float` etc. in the standard library.
|
converting strings to `Int`, `Float` etc. in the standard library.
|
||||||
|
|
||||||
## Initializing from known strings
|
## Initializing from known strings
|
||||||
@@ -191,8 +188,7 @@ try Bundle.main.resources.join("foo").copy(to: .home)
|
|||||||
|
|
||||||
## Directory listings
|
## Directory listings
|
||||||
|
|
||||||
We provide `ls()`, called because it behaves like the Terminal `ls` function,
|
`Path` provides `ls()` to list files. Like `ls` it is not recursive and doesn’t
|
||||||
the name thus implies its behavior, ie. that it is not recursive and doesn’t
|
|
||||||
list hidden files.
|
list hidden files.
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
@@ -223,7 +219,7 @@ let includingHiddenFiles = Path.home.ls(.a)
|
|||||||
fails to list the directory. The rationale for this is weak, please open a
|
fails to list the directory. The rationale for this is weak, please open a
|
||||||
ticket for discussion.
|
ticket for discussion.
|
||||||
|
|
||||||
We provide `find()` for recursive listing:
|
`Path` provides `find()` for recursive listing:
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
for path in Path.home.find() {
|
for path in Path.home.find() {
|
||||||
@@ -269,48 +265,47 @@ get on with it and not have to worry.
|
|||||||
There is also some magic going on in Foundation’s filesystem APIs, which we look
|
There is also some magic going on in Foundation’s filesystem APIs, which we look
|
||||||
for and ensure our API is deterministic, eg. [this test].
|
for and ensure our API is deterministic, eg. [this test].
|
||||||
|
|
||||||
[this test]: https://github.com/mxcl/Path.swift/blob/master/Tests/PathTests/PathTests.swift#L539-L554
|
[this test]: https://github.com/astzweig/swiftpm-pathkit/blob/master/Tests/PathTests/PathTests.swift#L539-L554
|
||||||
|
|
||||||
# `Path.swift` is properly cross-platform
|
# `PathKit` is properly cross-platform
|
||||||
|
|
||||||
`FileManager` on Linux is full of holes. We have found the holes and worked
|
`FileManager` on Linux has a lot of pitfalls, which this library works around on.
|
||||||
round them where necessary.
|
|
||||||
|
|
||||||
# Rules & Caveats
|
# Rules & Caveats
|
||||||
|
|
||||||
Paths are just (normalized) string representations, there *might not* be a real
|
`Paths` are just (normalized) string representations, there *might not* be a real
|
||||||
file there.
|
file there.
|
||||||
|
|
||||||
```swift
|
```swift
|
||||||
Path.home/"b" // => /Users/mxcl/b
|
Path.home/"b" // => /Users/someuser/b
|
||||||
|
|
||||||
// joining multiple strings works as you’d expect
|
// joining multiple strings works as you’d expect
|
||||||
Path.home/"b"/"c" // => /Users/mxcl/b/c
|
Path.home/"b"/"c" // => /Users/someuser/b/c
|
||||||
|
|
||||||
// joining multiple parts simultaneously is fine
|
// joining multiple parts simultaneously is fine
|
||||||
Path.home/"b/c" // => /Users/mxcl/b/c
|
Path.home/"b/c" // => /Users/someuser/b/c
|
||||||
|
|
||||||
// joining with absolute paths omits prefixed slash
|
// joining with absolute paths omits prefixed slash
|
||||||
Path.home/"/b" // => /Users/mxcl/b
|
Path.home/"/b" // => /Users/someuser/b
|
||||||
|
|
||||||
// joining with .. or . works as expected
|
// joining with .. or . works as expected
|
||||||
Path.home.foo.bar.join("..") // => /Users/mxcl/foo
|
Path.home.foo.bar.join("..") // => /Users/someuser/foo
|
||||||
Path.home.foo.bar.join(".") // => /Users/mxcl/foo/bar
|
Path.home.foo.bar.join(".") // => /Users/someuser/foo/bar
|
||||||
|
|
||||||
// though note that we provide `.parent`:
|
// though note that we provide `.parent`:
|
||||||
Path.home.foo.bar.parent // => /Users/mxcl/foo
|
Path.home.foo.bar.parent // => /Users/someuser/foo
|
||||||
|
|
||||||
// of course, feel free to join variables:
|
// of course, feel free to join variables:
|
||||||
let b = "b"
|
let b = "b"
|
||||||
let c = "c"
|
let c = "c"
|
||||||
Path.home/b/c // => /Users/mxcl/b/c
|
Path.home/b/c // => /Users/someuser/b/c
|
||||||
|
|
||||||
// tilde is not special here
|
// tilde is not special here
|
||||||
Path.root/"~b" // => /~b
|
Path.root/"~b" // => /~b
|
||||||
Path.root/"~/b" // => /~/b
|
Path.root/"~/b" // => /~/b
|
||||||
|
|
||||||
// but is here
|
// but is here
|
||||||
Path("~/foo")! // => /Users/mxcl/foo
|
Path("~/foo")! // => /Users/someuser/foo
|
||||||
|
|
||||||
// this works provided the user `Guest` exists
|
// this works provided the user `Guest` exists
|
||||||
Path("~Guest") // => /Users/Guest
|
Path("~Guest") // => /Users/Guest
|
||||||
@@ -332,15 +327,15 @@ try Path.root.foo.readlink() // => /bar
|
|||||||
// thus use `realpath` if there are multiple symlinks
|
// thus use `realpath` if there are multiple symlinks
|
||||||
```
|
```
|
||||||
|
|
||||||
*Path.swift* has the general policy that if the desired end result preexists,
|
*PathKit* has the general policy that if the desired end result preexists,
|
||||||
then it’s a noop:
|
then it’s a noop:
|
||||||
|
|
||||||
* If you try to delete a file, but the file doesn't exist, we do nothing.
|
* If you try to delete a file, but the file doesn't exist, nothing happens.
|
||||||
* If you try to make a directory and it already exists, we do nothing.
|
* If you try to make a directory and it already exists, nothing happens.
|
||||||
* If you call `readlink` on a non-symlink, we return `self`
|
* If you call `readlink` on a non-symlink, we return `self`
|
||||||
|
|
||||||
However notably if you try to copy or move a file without specifying `overwrite`
|
However notably if you try to copy or move a file without specifying `overwrite`
|
||||||
and the file already exists at the destination and is identical, we don’t check
|
and the file already exists at the destination and is identical, *PathKit* doesn't check
|
||||||
for that as the check was deemed too expensive to be worthwhile.
|
for that as the check was deemed too expensive to be worthwhile.
|
||||||
|
|
||||||
## Symbolic links
|
## Symbolic links
|
||||||
@@ -360,7 +355,7 @@ meant to be an abstraction for filesystems. To instead verify that there is
|
|||||||
no filesystem entry there at all check if `type` is `nil`.
|
no filesystem entry there at all check if `type` is `nil`.
|
||||||
|
|
||||||
|
|
||||||
## We do not provide change directory functionality
|
## There is no change directory functionality
|
||||||
|
|
||||||
Changing directory is dangerous, you should *always* try to avoid it and thus
|
Changing directory is dangerous, you should *always* try to avoid it and thus
|
||||||
we don’t even provide the method. If you are executing a sub-process then
|
we don’t even provide the method. If you are executing a sub-process then
|
||||||
@@ -406,26 +401,16 @@ SwiftPM:
|
|||||||
|
|
||||||
```swift
|
```swift
|
||||||
package.append(
|
package.append(
|
||||||
.package(url: "https://github.com/mxcl/Path.swift.git", from: "1.0.0")
|
.package(url: "https://github.com/astzweig/swiftpm-pathkit.git", from: "1.0.0")
|
||||||
)
|
)
|
||||||
|
|
||||||
package.targets.append(
|
package.targets.append(
|
||||||
.target(name: "Foo", dependencies: [
|
.target(name: "Foo", dependencies: [
|
||||||
.product(name: "Path", package: "Path.swift")
|
.product(name: "Path", package: "swiftpm-pathkit")
|
||||||
])
|
])
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
CocoaPods:
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
pod 'Path.swift', '~> 1.0.0'
|
|
||||||
```
|
|
||||||
|
|
||||||
Carthage:
|
|
||||||
|
|
||||||
> Waiting on: [@Carthage#1945](https://github.com/Carthage/Carthage/pull/1945).
|
|
||||||
|
|
||||||
# Naming Conflicts with `SwiftUI.Path`, etc.
|
# Naming Conflicts with `SwiftUI.Path`, etc.
|
||||||
|
|
||||||
We have a typealias of `PathStruct` you can use instead.
|
We have a typealias of `PathStruct` you can use instead.
|
||||||
@@ -441,11 +426,3 @@ We have a typealias of `PathStruct` you can use instead.
|
|||||||
[badge-platforms]: https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20iOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey.svg
|
[badge-platforms]: https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20iOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey.svg
|
||||||
[badge-languages]: https://img.shields.io/badge/swift-4.2%20%7C%205.x-orange.svg
|
[badge-languages]: https://img.shields.io/badge/swift-4.2%20%7C%205.x-orange.svg
|
||||||
[docs]: https://mxcl.dev/Path.swift/Structs/Path.html
|
[docs]: https://mxcl.dev/Path.swift/Structs/Path.html
|
||||||
[badge-jazzy]: https://raw.githubusercontent.com/mxcl/Path.swift/gh-pages/badge.svg?sanitize=true
|
|
||||||
[badge-codecov]: https://codecov.io/gh/mxcl/Path.swift/branch/master/graph/badge.svg
|
|
||||||
[badge-ci]: https://github.com/mxcl/Path.swift/workflows/Checks/badge.svg
|
|
||||||
[travis]: https://travis-ci.com/mxcl/Path.swift
|
|
||||||
[codecov]: https://codecov.io/gh/mxcl/Path.swift
|
|
||||||
[badge-version]: https://img.shields.io/cocoapods/v/Path.swift.svg?label=version
|
|
||||||
[cocoapods]: https://cocoapods.org/pods/Path.swift
|
|
||||||
[Sponsor @mxcl]: https://github.com/sponsors/mxcl
|
|
||||||
|
|||||||
Reference in New Issue
Block a user