-
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b226d57
Showing
20 changed files
with
3,637 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion. | ||
|
||
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Contributing | ||
|
||
Contributions are welcome and will be fully credited! | ||
|
||
## Pull Requests | ||
|
||
Here are some guidelines to make the process smoother: | ||
|
||
- **Add a test** - New features and bugfixes need tests. If you find it difficult to test, please tell us in the pull request and we will try to help you! | ||
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. | ||
- **Run `npm test` locally** - This will allow you to go faster | ||
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. | ||
- **Send coherent history** - Make sure your commits message means something | ||
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. | ||
|
||
## Creating issues | ||
|
||
### Bug reports | ||
|
||
Always try to provide as much information as possible. If you are reporting a bug, try to provide a repro on jsfiddle.net (or anything else) or a stacktrace at the very least. This will help us check the problem quicker. | ||
|
||
### Feature requests | ||
|
||
Lay out the reasoning behind it and propose an API for it. Ideally, you should have a practical example to prove the utility of the feature you're requesting. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<!-- | ||
IMPORTANT: Please provide as much information as possible: | ||
- Reporting a bug: if possible provide a repro on jsfiddle.net or a stacktrace at the very least | ||
- Feature request: lay out the reasoning behind it and propose an API for it | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
github: posva | ||
custom: https://www.paypal.me/posva |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
labels: | ||
- name: bug | ||
color: ee0701 | ||
- name: contribution welcome | ||
color: 0e8a16 | ||
- name: discussion | ||
color: 4935ad | ||
- name: docs | ||
color: 8be281 | ||
- name: enhancement | ||
color: a2eeef | ||
- name: good first issue | ||
color: 7057ff | ||
- name: help wanted | ||
color: 008672 | ||
- name: question | ||
color: d876e3 | ||
- name: wontfix | ||
color: ffffff | ||
- name: WIP | ||
color: ffffff | ||
- name: need repro | ||
color: c9581c | ||
- name: feature request | ||
color: fbca04 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
on: | ||
push: | ||
tags: | ||
- 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 | ||
|
||
name: Create Release | ||
|
||
jobs: | ||
build: | ||
name: Create Release | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@master | ||
- name: Create Release for Tag | ||
id: release_tag | ||
uses: yyx990803/release-tag@master | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
tag_name: ${{ github.ref }} | ||
body: | | ||
Please refer to [CHANGELOG.md](https://github.com/posva/pinia-colada/blob/main/CHANGELOG.md) for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: test | ||
|
||
on: | ||
push: | ||
branches: | ||
- '**' | ||
paths-ignore: | ||
- 'docs/**' | ||
# We don't need to test tags | ||
tags-ignore: | ||
- '**' | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: pnpm/action-setup@v2 | ||
with: | ||
version: 8 | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: '20' | ||
cache: 'pnpm' | ||
|
||
- run: pnpm install --frozen-lockfile | ||
- run: pnpm run lint | ||
- run: pnpm run test | ||
- run: pnpm run build | ||
|
||
- uses: codecov/codecov-action@v3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
node_modules | ||
coverage | ||
npm-debug.log | ||
yarn-error.log | ||
.nyc_output | ||
coverage.lcov | ||
dist | ||
package-lock.json | ||
yarn.lock | ||
.DS_Store | ||
.pnpm-debug.log | ||
tsconfig.tsbuildinfo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
export default { | ||
semi: false, | ||
trailingComma: 'es5', | ||
singleQuote: true, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2023-present Eduardo San Martin Morote | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 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 OR COPYRIGHT HOLDERS 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
<h1> | ||
<img height="64" src="https://pinia.esm.dev/logo.svg" alt="Pinia logo"> | ||
Pinia Colada | ||
</h1> | ||
|
||
<a href="https://npmjs.com/package/@pinia/colada"> | ||
<img src="https://badgen.net/npm/v/@pinia/colada/latest" alt="npm package"> | ||
</a> | ||
<a href="https://github.com/posva/pinia-colada/actions/workflows/test.yml"> | ||
<img src="https://github.com/posva/pinia-colada/workflows/test/badge.svg" alt="build status"> | ||
</a> | ||
<a href="https://codecov.io/gh/posva/pinia-colada"> | ||
<img src="https://codecov.io/gh/posva/pinia-colada/branch/main/graph/badge.svg?token=9WqnRrLf1Q"/> | ||
</a> | ||
|
||
WIP | ||
|
||
## Installation | ||
|
||
```sh | ||
npm install @pinia/colada | ||
``` | ||
|
||
## Usage | ||
|
||
```js | ||
// WIP | ||
``` | ||
|
||
## License | ||
|
||
[MIT](http://opensource.org/licenses/MIT) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
{ | ||
"name": "@pinia/colada", | ||
"packageManager": "[email protected]", | ||
"version": "0.0.0", | ||
"type": "module", | ||
"description": "", | ||
"publishConfig": { | ||
"access": "public" | ||
}, | ||
"main": "./dist/index.cjs", | ||
"module": "./dist/index.js", | ||
"unpkg": "dist/index.global.js", | ||
"jsdelivr": "dist/index.global.js", | ||
"types": "./dist/index.d.ts", | ||
"exports": { | ||
".": { | ||
"types": { | ||
"require": "./dist/index.d.cts", | ||
"import": "./dist/index.d.ts" | ||
}, | ||
"require": "./dist/index.cjs", | ||
"import": "./dist/index.js" | ||
} | ||
}, | ||
"typesVersions": { | ||
"*": { | ||
"*": [ | ||
"./dist/*", | ||
"./*" | ||
] | ||
} | ||
}, | ||
"sideEffects": false, | ||
"funding": "https://github.com/sponsors/posva", | ||
"author": { | ||
"name": "Eduardo San Martin Morote", | ||
"email": "[email protected]" | ||
}, | ||
"scripts": { | ||
"dev": "vitest", | ||
"prepublishOnly": "pnpm run build", | ||
"release": "standard-version", | ||
"test": "pnpm run test:cov && pnpm run test:types", | ||
"lint": "prettier -c --parser typescript \"src/**/*.[jt]s?(x)\"", | ||
"lint:fix": "pnpm run lint --write", | ||
"test:types": "tsc --build ./tsconfig.json", | ||
"test:cov": "vitest run --coverage", | ||
"build": "tsup" | ||
}, | ||
"files": [ | ||
"dist", | ||
"LICENSE", | ||
"README.md" | ||
], | ||
"keywords": [ | ||
"pinia", | ||
"plugin", | ||
"data", | ||
"fetching", | ||
"query", | ||
"mutation", | ||
"cache", | ||
"layer" | ||
], | ||
"license": "MIT", | ||
"devDependencies": { | ||
"@types/node": "^20.10.4", | ||
"@vitest/coverage-v8": "^1.0.4", | ||
"lint-staged": "^15.2.0", | ||
"pinia": "^2.1.7", | ||
"prettier": "^3.1.1", | ||
"standard-version": "^9.5.0", | ||
"tsup": "^8.0.1", | ||
"typescript": "~5.3.3", | ||
"vitest": "^1.0.4", | ||
"vue": "^3.3.11", | ||
"yorkie": "^2.0.0" | ||
}, | ||
"gitHooks": { | ||
"pre-commit": "lint-staged", | ||
"commit-msg": "node scripts/verifyCommit.js" | ||
}, | ||
"lint-staged": { | ||
"*.?(m)js": [ | ||
"prettier --write" | ||
], | ||
"*.ts?(x)": [ | ||
"prettier --parser=typescript --write" | ||
] | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/posva/pinia-colada.git" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/posva/pinia-colada/issues" | ||
}, | ||
"homepage": "https://github.com/posva/pinia-colada#readme" | ||
} |
Oops, something went wrong.