@rocketui/vue 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -0
- package/package.json +83 -0
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Design System
|
|
2
|
+
|
|
3
|
+
## Recommended IDE Setup
|
|
4
|
+
|
|
5
|
+
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
|
|
6
|
+
|
|
7
|
+
## Type Support for `.vue` Imports in TS
|
|
8
|
+
|
|
9
|
+
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
|
|
10
|
+
|
|
11
|
+
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
|
|
12
|
+
|
|
13
|
+
1. Disable the built-in TypeScript Extension
|
|
14
|
+
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
|
|
15
|
+
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
|
|
16
|
+
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
|
|
17
|
+
|
|
18
|
+
## Customize configuration
|
|
19
|
+
|
|
20
|
+
See [Vite Configuration Reference](https://vitejs.dev/config/).
|
|
21
|
+
|
|
22
|
+
## Project Setup
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
yarn install
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Compile and Hot-Reload for Development
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
yarn dev
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Type-Check, Compile and Minify for Production
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
yarn build
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Run Unit Tests with [Vitest](https://vitest.dev/)
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
yarn test:unit
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Lint with [ESLint](https://eslint.org/)
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
yarn lint
|
|
50
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@rocketui/vue",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"main": "dist/design-system-vue.umd.cjs",
|
|
6
|
+
"module": "dist/design-system-vue.js",
|
|
7
|
+
"types": "dist/design-system-vue.d.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"dist"
|
|
10
|
+
],
|
|
11
|
+
"scripts": {
|
|
12
|
+
"dev": "vite",
|
|
13
|
+
"build": "run-p type-check build-only",
|
|
14
|
+
"build-only": "vite build",
|
|
15
|
+
"preview": "vite preview --port 4173",
|
|
16
|
+
"test:unit": "vitest",
|
|
17
|
+
"test:coverage": "vitest run --coverage",
|
|
18
|
+
"type-check": "vue-tsc --noEmit -p tsconfig.vitest.json --composite false",
|
|
19
|
+
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
|
|
20
|
+
"storybook": "start-storybook -p 6006",
|
|
21
|
+
"storybook:build": "build-storybook",
|
|
22
|
+
"storybook:chromatic": "npx chromatic --project-token=CHROMATIC_PROJECT_TOKEN --disable-telemetry",
|
|
23
|
+
"prepare": "husky install",
|
|
24
|
+
"prettier": "prettier --write ./src/**/*.{vue,ts,css,mdx}"
|
|
25
|
+
},
|
|
26
|
+
"dependencies": {
|
|
27
|
+
"@floating-ui/dom": "^1.0.7",
|
|
28
|
+
"lodash.kebabcase": "^4.1.1",
|
|
29
|
+
"material-icons": "^1.11.11",
|
|
30
|
+
"vue": "^3.2.37"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@babel/core": "^7.18.10",
|
|
34
|
+
"@rushstack/eslint-patch": "^1.1.4",
|
|
35
|
+
"@storybook/addon-actions": "^6.5.10",
|
|
36
|
+
"@storybook/addon-docs": "^6.5.10",
|
|
37
|
+
"@storybook/addon-essentials": "^6.5.10",
|
|
38
|
+
"@storybook/addon-links": "^6.5.10",
|
|
39
|
+
"@storybook/addons": "^6.5.12",
|
|
40
|
+
"@storybook/builder-vite": "^0.2.2",
|
|
41
|
+
"@storybook/testing-library": "^0.0.13",
|
|
42
|
+
"@storybook/theming": "^6.5.12",
|
|
43
|
+
"@storybook/vue3": "^6.5.10",
|
|
44
|
+
"@types/jsdom": "^20.0.0",
|
|
45
|
+
"@types/node": "^16.11.48",
|
|
46
|
+
"@vitejs/plugin-vue": "^3.0.3",
|
|
47
|
+
"@vitest/coverage-c8": "^0.22.1",
|
|
48
|
+
"@vue/eslint-config-prettier": "^7.0.0",
|
|
49
|
+
"@vue/eslint-config-typescript": "^11.0.0",
|
|
50
|
+
"@vue/test-utils": "^2.0.0",
|
|
51
|
+
"@vue/tsconfig": "^0.1.3",
|
|
52
|
+
"autoprefixer": "^10.4.8",
|
|
53
|
+
"babel-loader": "^8.2.5",
|
|
54
|
+
"chromatic": "^6.7.4",
|
|
55
|
+
"eslint": "^8.21.0",
|
|
56
|
+
"eslint-plugin-mdx": "^2.0.2",
|
|
57
|
+
"eslint-plugin-storybook": "^0.6.4",
|
|
58
|
+
"eslint-plugin-vue": "^9.3.0",
|
|
59
|
+
"husky": "^8.0.0",
|
|
60
|
+
"jsdom": "^20.0.0",
|
|
61
|
+
"lint-staged": "^13.0.3",
|
|
62
|
+
"npm-run-all": "^4.1.5",
|
|
63
|
+
"postcss": "^8.4.16",
|
|
64
|
+
"postcss-import": "^15.0.0",
|
|
65
|
+
"postcss-nested": "^5.0.6",
|
|
66
|
+
"prettier": "^2.7.1",
|
|
67
|
+
"storybook-design-token": "^2.7.1",
|
|
68
|
+
"tailwindcss": "^3.2.0",
|
|
69
|
+
"ts-dedent": "^2.2.0",
|
|
70
|
+
"typescript": "~4.7.4",
|
|
71
|
+
"vite": "^3.0.8",
|
|
72
|
+
"vite-plugin-dts": "^1.7.1",
|
|
73
|
+
"vitest": "^0.22.1",
|
|
74
|
+
"vue-loader": "^16.8.3",
|
|
75
|
+
"vue-tsc": "^0.39.5"
|
|
76
|
+
},
|
|
77
|
+
"lint-staged": {
|
|
78
|
+
"*.{vue,js,ts,mdx}": [
|
|
79
|
+
"yarn lint",
|
|
80
|
+
"yarn prettier"
|
|
81
|
+
]
|
|
82
|
+
}
|
|
83
|
+
}
|