Skip to content

Commit 203710c

Browse files
felixpyfelixpy
committed
feat: initial commit
1 parent 2e9c5c9 commit 203710c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2722
-101
lines changed

‎.browserslistrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
> 1%
2+
last 2 versions
3+
IE 10

‎.editorconfig

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[*.{js,jsx,ts,tsx,vue}]
2+
indent_style = space
3+
indent_size = 2
4+
trim_trailing_whitespace = true
5+
insert_final_newline = true

‎.eslintrc.js

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
module.exports = {
2+
root: true,
3+
env: {
4+
node: true
5+
},
6+
extends: [
7+
'plugin:vue/essential',
8+
'@vue/standard',
9+
'plugin:prettier/recommended'
10+
],
11+
plugins: ['prettier'],
12+
rules: {
13+
'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
14+
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
15+
16+
'prettier/prettier': 'error'
17+
},
18+
parserOptions: {
19+
parser: 'babel-eslint'
20+
},
21+
overrides: [
22+
{
23+
files: [
24+
'**/__tests__/*.{j,t}s?(x)',
25+
'**/tests/unit/**/*.spec.{j,t}s?(x)'
26+
],
27+
env: {
28+
jest: true
29+
}
30+
}
31+
]
32+
};

‎.github/ISSUE_TEMPLATE.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Please help us process issues more efficiently by filing an
2+
issue using one of the following templates:
3+
4+
<https://github.com/openfext/vue-use/issues/new/choose>
5+
6+
Thank you!

‎.github/ISSUE_TEMPLATE/1-bug-report.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: 'Bug Report'
3+
about: Report a bug in the VueUse
4+
---
5+
6+
# Bug Report
7+
8+
## Information
9+
10+
### Affected Composition
11+
12+
The issue is caused by composition....
13+
14+
### Is this a regression
15+
16+
Yes, the previous version in which this bug was not present was: ....
17+
18+
### Description
19+
20+
A clear and concise description of the problem...
21+
22+
## Minimal Reproduction
23+
24+
Stackblitz application or GitHub repository...
25+
26+
## Exception or Error
27+
28+
```plain
29+
30+
```
31+
32+
## Your Environment
33+
34+
**Vue Version:**
35+
36+
```plain
37+
38+
```
39+
40+
**Vue Composition API:**
41+
42+
```plain
43+
44+
```
45+
46+
**Anything else relevant?**
47+
48+
Is this a browser specific issue? If so, please specify the browser and version.
49+
50+
Do any of these matter: operating system, IDE, package manager, HTTP server, ...? If so, please mention it below.

‎.github/ISSUE_TEMPLATE/2-feature-request.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 'Feature Request'
3+
about: Suggest a feature for VueUse
4+
---
5+
6+
# Feature Request
7+
8+
## Information
9+
10+
### Relevant Package
11+
12+
This feature request is for ....
13+
14+
### Description
15+
16+
A clear and concise description of the problem or missing capability...
17+
18+
### Describe the solution you'd like
19+
20+
If you have a solution in mind, please describe it.
21+
22+
### Describe alternatives you've considered
23+
24+
Have you considered any alternative solutions or workarounds?

‎.github/ISSUE_TEMPLATE/3-docs-bug.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: 'Docs Issue Report'
3+
about: Report an issue in VueUse's documentation
4+
---
5+
6+
# Docs Issue
7+
8+
## Information
9+
10+
### Description
11+
12+
A clear and concise description of the problem...
13+
14+
## 🔬 Minimal Reproduction
15+
16+
### What's the affected URL
17+
18+
...
19+
20+
### Reproduction Steps
21+
22+
If applicable please list the steps to take to reproduce the issue...
23+
24+
### Expected vs Actual Behavior
25+
26+
If applicable please describe the difference between the expected and actual behavior after following the repro steps...
27+
28+
## Screenshot
29+
30+
Often a screenshot can help to capture the issue better than a long description...
31+
32+
## Exception or Error
33+
34+
```plain
35+
36+
```
37+
38+
## Your Environment
39+
40+
### Browser info
41+
42+
Is this a browser specific issue? If so, please specify the device, browser, and version.
43+
44+
### Anything else relevant
45+
46+
Please provide additional info if necessary.

‎.github/PULL_REQUEST_TEMPLATE.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# PR Checklist
2+
3+
Please check if your PR fulfills the following requirements:
4+
5+
- [ ] The commit message follows our guidelines: <https://github.com/openfext/vue-use/blob/master/CONTRIBUTING.md#commit>
6+
- [ ] Tests for the changes have been added (for bug fixes / features)
7+
- [ ] Docs have been added / updated (for bug fixes / features)
8+
9+
## PR Type
10+
11+
What kind of change does this PR introduce?
12+
13+
<!-- Please check the one that applies to this PR using "x". -->
14+
15+
- [ ] Bugfix
16+
- [ ] Feature
17+
- [ ] Code style update (formatting, local variables)
18+
- [ ] Refactoring (no functional changes, no api changes)
19+
- [ ] Build related changes
20+
- [ ] CI related changes
21+
- [ ] Documentation content changes
22+
- [ ] Other... Please describe:
23+
24+
## What is the current behavior?
25+
26+
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
27+
28+
Issue Number: N/A
29+
30+
## What is the new behavior?
31+
32+
## Does this PR introduce a breaking change?
33+
34+
- [ ] Yes
35+
- [ ] No
36+
37+
<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
38+
39+
## Other information

‎.gitignore

+19-100
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,23 @@
1-
# Logs
2-
logs
3-
*.log
4-
npm-debug.log*
5-
yarn-debug.log*
6-
yarn-error.log*
7-
lerna-debug.log*
8-
9-
# Diagnostic reports (https://nodejs.org/api/report.html)
10-
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11-
12-
# Runtime data
13-
pids
14-
*.pid
15-
*.seed
16-
*.pid.lock
17-
18-
# Directory for instrumented libs generated by jscoverage/JSCover
19-
lib-cov
20-
21-
# Coverage directory used by tools like istanbul
22-
coverage
23-
*.lcov
24-
25-
# nyc test coverage
26-
.nyc_output
27-
28-
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29-
.grunt
30-
31-
# Bower dependency directory (https://bower.io/)
32-
bower_components
33-
34-
# node-waf configuration
35-
.lock-wscript
36-
37-
# Compiled binary addons (https://nodejs.org/api/addons.html)
38-
build/Release
39-
40-
# Dependency directories
41-
node_modules/
42-
jspm_packages/
43-
44-
# TypeScript v1 declaration files
45-
typings/
46-
47-
# TypeScript cache
48-
*.tsbuildinfo
49-
50-
# Optional npm cache directory
51-
.npm
52-
53-
# Optional eslint cache
54-
.eslintcache
55-
56-
# Microbundle cache
57-
.rpt2_cache/
58-
.rts2_cache_cjs/
59-
.rts2_cache_es/
60-
.rts2_cache_umd/
61-
62-
# Optional REPL history
63-
.node_repl_history
64-
65-
# Output of 'npm pack'
66-
*.tgz
67-
68-
# Yarn Integrity file
69-
.yarn-integrity
70-
71-
# dotenv environment variables file
72-
.env
73-
.env.test
74-
75-
# parcel-bundler cache (https://parceljs.org/)
76-
.cache
77-
78-
# Next.js build output
79-
.next
80-
81-
# Nuxt.js build / generate output
82-
.nuxt
1+
.DS_Store
2+
node_modules
833
dist
4+
lib
5+
yarn.lock
6+
package-lock.json
847

85-
# Gatsby files
86-
.cache/
87-
# Comment in the public line in if your project uses Gatsby and *not* Next.js
88-
# https://nextjs.org/blog/next-9-1#public-directory-support
89-
# public
90-
91-
# vuepress build output
92-
.vuepress/dist
93-
94-
# Serverless directories
95-
.serverless/
96-
97-
# FuseBox cache
98-
.fusebox/
8+
# Test
9+
test/unit/coverage
9910

100-
# DynamoDB Local files
101-
.dynamodb/
11+
# Log files
12+
npm-debug.log*
13+
yarn-debug.log*
14+
yarn-error.log*
10215

103-
# TernJS port file
104-
.tern-port
16+
# Editor directories and files
17+
.idea
18+
.vscode
19+
*.suo
20+
*.ntvs*
21+
*.njsproj
22+
*.sln
23+
*.sw*

‎.postcssrc.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module.exports = {
2+
plugins: {
3+
autoprefixer: {}
4+
}
5+
}

‎.prettierrc

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"eslintIntegration": true,
3+
"singleQuote": true
4+
}

‎.storybook/addons.js

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import '@storybook/addon-actions/register';
2+
import '@storybook/addon-links/register';
3+
import '@storybook/addon-notes/register';
4+
import '@storybook/addon-knobs/register';
5+
import '@storybook/addon-options/register';
6+
import '@storybook/addon-storysource/register';

‎.storybook/config.js

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { configure, addParameters, addDecorator } from '@storybook/vue';
2+
import { withKnobs } from '@storybook/addon-knobs';
3+
import { themes } from '@storybook/theming';
4+
5+
addParameters({
6+
options: {
7+
theme: themes.light
8+
}
9+
});
10+
11+
addDecorator(
12+
withKnobs({
13+
escapeHTML: false
14+
})
15+
);
16+
17+
// automatically import all files ending in *.stories.js
18+
configure(
19+
[require.context('../stories', true, /\.stories\.(js|mdx)$/)],
20+
module
21+
);

‎.storybook/presets.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = [
2+
/* '@storybook/addon-docs/vue/preset' */
3+
];

0 commit comments

Comments
 (0)