Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/docs #26

Merged
merged 6 commits into from
Aug 22, 2020
Merged

Feature/docs #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5632f26
refactor: rename PureGCSPath to PurePathy
justindujardin Aug 21, 2020
0213d2f
feat(README): generate API and CLI docs
justindujardin Aug 22, 2020
5a32357
feat(build): use husky to auto update docs when code changes
justindujardin Aug 22, 2020
e3a2c49
chore: update docs
justindujardin Aug 22, 2020
9a7f8d8
chore: add BucketStat to docs
justindujardin Aug 22, 2020
aacb9f7
chore: fix ci build badge
justindujardin Aug 22, 2020
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
414 changes: 402 additions & 12 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

1,052 changes: 868 additions & 184 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

189 changes: 101 additions & 88 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,90 +1,103 @@
{
"name": "pathy",
"version": "0.0.0-development",
"description": "",
"main": "index.js",
"directories": {
"test": "tests"
},
"scripts": {
"semantic-release": "semantic-release"
},
"repository": {
"type": "git",
"url": "https://github.com/justindujardin/pathy"
},
"author": "",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/justindujardin/pathy/issues"
},
"homepage": "https://github.com/justindujardin/pathy#readme",
"devDependencies": {
"@semantic-release/changelog": "^5.0.0",
"@semantic-release/git": "^9.0.0",
"@semantic-release/github": "^7.0.5",
"@types/node": "^13.1.1",
"minimist": "^1.2.5",
"semantic-release": "^17.0.4",
"stream-buffers": "^3.0.2",
"ts-node": "^8.0.2",
"typescript": "^3.0.3"
},
"release": {
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"preset": "angular",
"releaseRules": [
{
"breaking": true,
"release": "minor"
},
{
"revert": true,
"release": "patch"
},
{
"type": "feat",
"release": "patch"
},
{
"type": "fix",
"release": "patch"
},
{
"type": "perf",
"release": "patch"
}
],
"parserOpts": {
"noteKeywords": [
"BREAKING CHANGE",
"BREAKING CHANGES"
]
}
"name": "pathy",
"version": "0.0.0-development",
"description": "",
"main": "index.js",
"directories": {
"test": "tests"
},
"scripts": {
"semantic-release": "semantic-release"
},
"repository": {
"type": "git",
"url": "https://github.com/justindujardin/pathy"
},
"author": "",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/justindujardin/pathy/issues"
},
"homepage": "https://github.com/justindujardin/pathy#readme",
"husky": {
"hooks": {
"pre-commit": "npx lint-staged"
}
],
"@semantic-release/release-notes-generator",
[
"@semantic-release/changelog",
{
"changelogFile": "CHANGELOG.md"
}
],
[
"@semantic-release/git",
{
"assets": [
"pathy/about.py",
"package.json",
"CHANGELOG.md"
],
"message": "chore(release): ${nextRelease.version} \n\n${nextRelease.notes}"
}
],
"@semantic-release/github"
]
}
}
},
"lint-staged": {
"pathy/*.py": [
"sh tools/docs.sh",
"git add README.md"
]
},
"devDependencies": {
"@semantic-release/changelog": "^5.0.0",
"@semantic-release/git": "^9.0.0",
"@semantic-release/github": "^7.0.5",
"@types/node": "^13.1.1",
"husky": "^4.2.5",
"lint-staged": "^10.2.11",
"minimist": "^1.2.5",
"semantic-release": "^17.0.4",
"stream-buffers": "^3.0.2",
"ts-node": "^8.0.2",
"typescript": "^3.0.3"
},
"release": {
"plugins": [
[
"@semantic-release/commit-analyzer",
{
"preset": "angular",
"releaseRules": [
{
"breaking": true,
"release": "minor"
},
{
"revert": true,
"release": "patch"
},
{
"type": "feat",
"release": "patch"
},
{
"type": "fix",
"release": "patch"
},
{
"type": "perf",
"release": "patch"
}
],
"parserOpts": {
"noteKeywords": [
"BREAKING CHANGE",
"BREAKING CHANGES"
]
}
}
],
"@semantic-release/release-notes-generator",
[
"@semantic-release/changelog",
{
"changelogFile": "CHANGELOG.md"
}
],
[
"@semantic-release/git",
{
"assets": [
"pathy/about.py",
"package.json",
"CHANGELOG.md"
],
"message": "chore(release): ${nextRelease.version} \n\n${nextRelease.notes}"
}
],
"@semantic-release/github"
]
}
}
2 changes: 1 addition & 1 deletion pathy/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ClientBucket,
ClientError,
Pathy,
PureGCSPath,
PurePathy,
FluidPath,
clear_fs_cache,
get_fs_cache,
Expand Down
Loading