Skip to content

Commit f898d50

Browse files
MacFJAMacFJA
committed
First version
0 parents  commit f898d50

17 files changed

+7334
-0
lines changed

‎.eslintrc.js

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
module.exports = {
2+
"env": {
3+
"browser": true,
4+
"es6": true
5+
},
6+
"extends": [
7+
"eslint:recommended",
8+
"plugin:import/errors",
9+
"plugin:@typescript-eslint/recommended"
10+
],
11+
"parserOptions": {
12+
"ecmaVersion": 2019,
13+
"sourceType": "module"
14+
},
15+
plugins: [
16+
"import",
17+
"@typescript-eslint"
18+
],
19+
"rules": {
20+
"indent": [
21+
"error",
22+
4
23+
],
24+
"linebreak-style": [
25+
"error",
26+
"unix"
27+
],
28+
"quotes": [
29+
"error",
30+
"double"
31+
],
32+
"semi": [
33+
"error",
34+
"never"
35+
],
36+
"import/export": ["error"],
37+
"import/order": ["error", {"newlines-between": "always", "alphabetize": {"order": "asc", "caseInsensitive": true}}],
38+
"import/newline-after-import": ["error"],
39+
"import/no-absolute-path": ["error"],
40+
"@typescript-eslint/no-explicit-any": ["off"]
41+
},
42+
"settings": {
43+
"import/extensions": [".js"],
44+
}
45+
}

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/node_modules/
2+
/tests/build/
3+
/dist/
4+
/docs/
5+
/types/

‎CHANGELOG.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [1.0.0]
10+
11+
First version
12+
13+
[Unreleased]: https://github.com/MacFJA/svelte-persistent-store/compare/1.0.0...HEAD
14+
[1.0.0]: https://github.com/MacFJA/svelte-persistent-store/releases/tag/1.0.0

‎CONTRIBUTING.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# How to contribute
2+
3+
## Reporting and improving
4+
5+
### Did you find a bug?
6+
7+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/MacFJA/svelte-persistent-store/issues).
8+
9+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/MacFJA/svelte-persistent-store/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible
10+
11+
### Did you write a patch that fixes a bug?
12+
13+
* Open a new GitHub pull request with the patch.
14+
15+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
16+
17+
### Do you have an idea to improve the application?
18+
19+
* **Ensure the suggestion was not already ask** by searching on GitHub under [Issues](https://github.com/MacFJA/svelte-persistent-store/issues).
20+
21+
* If you're unable to find an open issue about your feature, [open a new one](https://github.com/MacFJA/svelte-persistent-store/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible
22+
23+
### Do you want to contribute to the application documentation?
24+
25+
* **Ensure the documentation improvement was not already submitted** by searching on GitHub under [Issues](https://github.com/MacFJA/svelte-persistent-store/issues).
26+
27+
* If you're unable to find an open issue addressing this, clone the wiki git on your computer
28+
29+
* [Open a new issue](https://github.com/MacFJA/svelte-persistent-store/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible and the patch for the documentation
30+
31+
## Coding conventions
32+
33+
Check your code by running the command:
34+
```sh
35+
npm run lint
36+
npm run test
37+
```
38+
The command will output any information worth knowing. No error should be left.
39+
40+
----
41+
42+
Thanks!

‎LICENSE.md

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

‎README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Svelte Persistent store
2+
3+
A Svelte store that keep its value through pages and reloads
4+
5+
## Installation
6+
7+
```
8+
npm install @macfja/svelte-persistent-store
9+
```
10+
11+
## Usage
12+
13+
```javascript
14+
import { persist, localStorage } from "@macfja/svelte-persistent-store"
15+
import { writable } from "svelte/store"
16+
17+
let name = persist(writable('John'), localStorage(), 'name')
18+
19+
$name = 'Jeanne Doe'
20+
21+
// if you reload the page the value of $name is 'Jeanne Doe'
22+
```
23+
24+
## Storages
25+
26+
There are 3 storages built-in:
27+
28+
- `localStorage()`, that use `window.localStorage` to save values
29+
- `sessionStorage()`, that use `window.sessionStorage` to save values
30+
- `cookieStorage()`, that use `document.cookie` to save values
31+
32+
You can add more storages, you just need to implement the interface `StorageInterface`
33+
34+
## Contributing
35+
36+
Contributions are welcome. Please open up an issue or create PR if you would like to help out.
37+
38+
Read more in the [Contributing file](CONTRIBUTING.md)
39+
40+
## License
41+
42+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)