Skip to content

Commit 775463e

Browse files
committed
feat: 🎸 Initial commit
Initial commit of vue-zephyrs rewrite.
0 parents  commit 775463e

39 files changed

+28328
-0
lines changed

.eslintignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
build/
2+
node_modules/
3+
src/shims-tsx.d.ts
4+
src/shims-vue.d.ts
5+
*.config.js
6+
src/main.ts
7+
test/
8+
dist/*.hot-update.json
9+
dist/index.html
10+
dist/webpack-stats.json
11+
testumdbuild
12+
*.d.ts

.eslintrc.js

Lines changed: 32 additions & 0 deletions
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/vue3-essential",
8+
"eslint:recommended",
9+
"@vue/typescript/recommended",
10+
"@vue/prettier",
11+
"@vue/prettier/@typescript-eslint"
12+
],
13+
parserOptions: {
14+
parser: '@typescript-eslint/parser',
15+
ecmaVersion: 2020,
16+
},
17+
rules: {
18+
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
19+
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off"
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+
};

.gitignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.DS_Store
2+
node_modules
3+
/dist
4+
/testumdbuild
5+
6+
# local env files
7+
.env.local
8+
.env.*.local
9+
10+
# Log files
11+
npm-debug.log*
12+
yarn-debug.log*
13+
yarn-error.log*
14+
pnpm-debug.log*
15+
16+
# Editor directories and files
17+
.idea
18+
.vscode
19+
*.suo
20+
*.ntvs*
21+
*.njsproj
22+
*.sln
23+
*.sw?

.huskyrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"hooks": {
3+
"pre-commit": "lint-staged",
4+
"commit-msg": "commitlint -e -V"
5+
}
6+
}

.lintstagedrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"**/*.+(ts|js|vue)": [
3+
"yarn lint"
4+
]
5+
}

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# vue 3 Component Library BoilerPlate
2+
3+
4+
**Technology Used:**\
5+
[Vuejs 3.0](https://github.com/vuejs/vue-next)\
6+
[Typescript](https://github.com/microsoft/TypeScript)\
7+
[Rollup](https://github.com/rollup/rollup)
8+
9+
## Project setup
10+
Please follow below mentioned step to run this project:
11+
12+
- Clone the repo
13+
```shell
14+
https://github.com/shubhadip/vue3-component-library
15+
```
16+
17+
### Run
18+
```
19+
yarn install
20+
```
21+
22+
### Compiles and hot-reloads for development
23+
```
24+
yarn serve
25+
```
26+
27+
### Compiles and minifies for production
28+
```
29+
yarn build
30+
```
31+
32+
### Build Library
33+
```
34+
yarn build:js
35+
```
36+
37+
### Build Library With Separate Css file
38+
```
39+
yarn build:js_css
40+
```
41+
42+
### Lints and fixes files
43+
```
44+
yarn lint
45+
```
46+
47+
48+
## Usage Of Components Built
49+
**As Component**
50+
```
51+
import { TestWorld } from 'vue3-component-library/dist/esm/testworld';
52+
...
53+
components:{
54+
TestWorld
55+
}
56+
```
57+
58+
**As Plugin**
59+
```
60+
import { TestWorld } from 'vue3-component-library';
61+
...
62+
app.use(TestWorld)
63+
```

babel.config.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
presets: ["@babel/preset-typescript", "@babel/preset-env"]
3+
};

commitlint.config.js

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/**
2+
* Definition Description
3+
- feat A new feature
4+
- fix A bug fix
5+
- docs Documentation only changes
6+
- style Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
7+
- refactor A code change that neither fixes a bug nor adds a feature
8+
- perf A code change that improves performance
9+
- test Adding missing or correcting existing tests
10+
- chore Changes to the build process or auxiliary tools and libraries such as documentation generation
11+
12+
*
13+
X.Y.Z => Release versioning format
14+
- fix(pencil): loader element not loading fix => Will bump up Z
15+
- feat(pencil): new datepicker component added => Will bump up Y
16+
- perf(pencil): vue3 released => Will bump the X
17+
- BREAKING CHANGE: vue3 released => Will bump the Y
18+
- Refer for the format of commit messages: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
19+
*/
20+
module.exports = {
21+
extends: ['@commitlint/config-conventional'],
22+
ignores: [(message) => message.includes('WIP')],
23+
rules: {
24+
'body-max-line-length': [0, 'always', Infinity], // added this due to semantic release bug
25+
},
26+
};

0 commit comments

Comments
 (0)