@zidsa/zidmui 1.4.38

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.
Files changed (2) hide show
  1. package/README.md +40 -0
  2. package/package.json +188 -0
package/README.md ADDED
@@ -0,0 +1,40 @@
1
+ ## Installation
2
+
3
+ This project uses pnpm as package manager, It's imperative to use pnpm to keep package lock consistent. Please make sure to install it first https://pnpm.io/installation.
4
+
5
+ ```sh
6
+ pnpm add @zidsa/zidmui
7
+ ```
8
+
9
+ Install https://taskfile.dev/installation/ to run project tasks
10
+
11
+ ```bash
12
+ $ task install
13
+ ```
14
+
15
+ ## Running the app
16
+
17
+ ```bash
18
+ # run build
19
+ $ task build
20
+
21
+ # list all available tasks
22
+ $ task
23
+ ```
24
+
25
+ ## Test
26
+
27
+ ```bash
28
+ # unit tests
29
+ $ task test
30
+ ```
31
+
32
+ ## Lint
33
+
34
+ ```bash
35
+ # lint and fix any issues
36
+ $ task lint
37
+
38
+ # lint and and report any issues without fixing them
39
+ $ task lint-check
40
+ ```
package/package.json ADDED
@@ -0,0 +1,188 @@
1
+ {
2
+ "name": "@zidsa/zidmui",
3
+ "type": "module",
4
+ "version": "1.4.38",
5
+ "description": "Zid MUI shared components and utilities",
6
+ "author": "Abdulaziz Homaily <a.homaily@gmail.com>",
7
+ "license": "MIT",
8
+ "publishConfig": {
9
+ "registry": "https://registry.npmjs.org/",
10
+ "access": "public"
11
+ },
12
+ "homepage": "https://github.com/zidsa/zidmui#readme",
13
+ "repository": "https://github.com/zidsa/zidmui",
14
+ "packageManager": "pnpm@10.18.0",
15
+ "bugs": {
16
+ "url": "https://github.com/zidsa/zidmui/issues"
17
+ },
18
+ "scripts": {
19
+ "preinstall": "npx -y only-allow pnpm",
20
+ "build": "tsc && vite build",
21
+ "tscheck": "tsc --noEmit",
22
+ "format": "prettier --write \"src/**/*.{ts,tsx,js,jsx}\"",
23
+ "lint": "oxlint \"src/**/*.{ts,tsx,js,jsx}\" --fix",
24
+ "lint-oxlint": "oxlint . --tsconfig tsconfig.json --type-aware",
25
+ "lint-check": "oxlint \"src/**/*.{ts,tsx,js,jsx}\"",
26
+ "release": "release-it",
27
+ "storybook": "storybook dev -p 6006",
28
+ "build-storybook": "storybook build"
29
+ },
30
+ "files": [
31
+ "dist",
32
+ "README.md"
33
+ ],
34
+ "exports": {
35
+ "./icons/arrows/*": {
36
+ "require": "./dist/cjs/icons/arrows/*.js",
37
+ "types": "./dist/types/icons/arrows/*.d.ts",
38
+ "import": "./dist/es/icons/arrows/*.js"
39
+ },
40
+ "./icons/buildings/*": {
41
+ "require": "./dist/cjs/icons/buildings/*.js",
42
+ "types": "./dist/types/icons/buildings/*.d.ts",
43
+ "import": "./dist/es/icons/buildings/*.js"
44
+ },
45
+ "./icons/business/*": {
46
+ "require": "./dist/cjs/icons/business/*.js",
47
+ "types": "./dist/types/icons/business/*.d.ts",
48
+ "import": "./dist/es/icons/business/*.js"
49
+ },
50
+ "./icons/communication/*": {
51
+ "require": "./dist/cjs/icons/communication/*.js",
52
+ "types": "./dist/types/icons/communication/*.d.ts",
53
+ "import": "./dist/es/icons/communication/*.js"
54
+ },
55
+ "./icons/currencies/*": {
56
+ "require": "./dist/cjs/icons/currencies/*.js",
57
+ "types": "./dist/types/icons/currencies/*.d.ts",
58
+ "import": "./dist/es/icons/currencies/*.js"
59
+ },
60
+ "./icons/design/*": {
61
+ "require": "./dist/cjs/icons/design/*.js",
62
+ "types": "./dist/types/icons/design/*.d.ts",
63
+ "import": "./dist/es/icons/design/*.js"
64
+ },
65
+ "./icons/development/*": {
66
+ "require": "./dist/cjs/icons/development/*.js",
67
+ "types": "./dist/types/icons/development/*.d.ts",
68
+ "import": "./dist/es/icons/development/*.js"
69
+ },
70
+ "./icons/device/*": {
71
+ "require": "./dist/cjs/icons/device/*.js",
72
+ "types": "./dist/types/icons/device/*.d.ts",
73
+ "import": "./dist/es/icons/device/*.js"
74
+ },
75
+ "./icons/document/*": {
76
+ "require": "./dist/cjs/icons/document/*.js",
77
+ "types": "./dist/types/icons/document/*.d.ts",
78
+ "import": "./dist/es/icons/document/*.js"
79
+ },
80
+ "./icons/editor/*": {
81
+ "require": "./dist/cjs/icons/editor/*.js",
82
+ "types": "./dist/types/icons/editor/*.d.ts",
83
+ "import": "./dist/es/icons/editor/*.js"
84
+ },
85
+ "./icons/finance/*": {
86
+ "require": "./dist/cjs/icons/finance/*.js",
87
+ "types": "./dist/types/icons/finance/*.d.ts",
88
+ "import": "./dist/es/icons/finance/*.js"
89
+ },
90
+ "./icons/food/*": {
91
+ "require": "./dist/cjs/icons/food/*.js",
92
+ "types": "./dist/types/icons/food/*.d.ts",
93
+ "import": "./dist/es/icons/food/*.js"
94
+ },
95
+ "./icons/health-medical/*": {
96
+ "require": "./dist/cjs/icons/health-medical/*.js",
97
+ "types": "./dist/types/icons/health-medical/*.d.ts",
98
+ "import": "./dist/es/icons/health-medical/*.js"
99
+ },
100
+ "./icons/logos/*": {
101
+ "require": "./dist/cjs/icons/logos/*.js",
102
+ "types": "./dist/types/icons/logos/*.d.ts",
103
+ "import": "./dist/es/icons/logos/*.js"
104
+ },
105
+ "./icons/map/*": {
106
+ "require": "./dist/cjs/icons/map/*.js",
107
+ "types": "./dist/types/icons/map/*.d.ts",
108
+ "import": "./dist/es/icons/map/*.js"
109
+ },
110
+ "./icons/media/*": {
111
+ "require": "./dist/cjs/icons/media/*.js",
112
+ "types": "./dist/types/icons/media/*.d.ts",
113
+ "import": "./dist/es/icons/media/*.js"
114
+ },
115
+ "./icons/others/*": {
116
+ "require": "./dist/cjs/icons/others/*.js",
117
+ "types": "./dist/types/icons/others/*.d.ts",
118
+ "import": "./dist/es/icons/others/*.js"
119
+ },
120
+ "./icons/system/*": {
121
+ "require": "./dist/cjs/icons/system/*.js",
122
+ "types": "./dist/types/icons/system/*.d.ts",
123
+ "import": "./dist/es/icons/system/*.js"
124
+ },
125
+ "./icons/user-faces/*": {
126
+ "require": "./dist/cjs/icons/user-faces/*.js",
127
+ "types": "./dist/types/icons/user-faces/*.d.ts",
128
+ "import": "./dist/es/icons/user-faces/*.js"
129
+ },
130
+ "./icons/weather/*": {
131
+ "require": "./dist/cjs/icons/weather/*.js",
132
+ "types": "./dist/types/icons/weather/*.d.ts",
133
+ "import": "./dist/es/icons/weather/*.js"
134
+ },
135
+ "./hooks/*": {
136
+ "require": "./dist/cjs/hooks/*.js",
137
+ "types": "./dist/types/hooks/*.d.ts",
138
+ "import": "./dist/es/hooks/*.js"
139
+ },
140
+ "./theme/*": {
141
+ "require": "./dist/cjs/theme/*.js",
142
+ "types": "./dist/types/theme/*.d.ts",
143
+ "import": "./dist/es/theme/*.js"
144
+ },
145
+ "./components/*": {
146
+ "require": "./dist/cjs/components/*.js",
147
+ "types": "./dist/types/components/*.d.ts",
148
+ "import": "./dist/es/components/*.js"
149
+ }
150
+ },
151
+ "peerDependencies": {
152
+ "@mui/lab": "7.0.0-beta.11",
153
+ "@mui/material": "7.3.5",
154
+ "react": "19.2.4",
155
+ "react-dom": "19.2.4",
156
+ "react-hook-form": "7.71.1",
157
+ "use-debounce": "10.1.0"
158
+ },
159
+ "devDependencies": {
160
+ "@commitlint/cli": "20.4.1",
161
+ "@commitlint/config-conventional": "20.4.1",
162
+ "@release-it/conventional-changelog": "10.0.5",
163
+ "@storybook/addon-docs": "10.2.8",
164
+ "@storybook/addon-themes": "10.2.8",
165
+ "@storybook/react-vite": "10.2.8",
166
+ "@types/react": "19.2.14",
167
+ "@vitejs/plugin-react": "5.1.4",
168
+ "glob": "12.0.0",
169
+ "globals": "16.5.0",
170
+ "lefthook": "2.1.1",
171
+ "oxlint": "1.47.0",
172
+ "oxlint-tsgolint": "0.12.2",
173
+ "prettier": "3.8.1",
174
+ "release-it": "19.2.4",
175
+ "storybook": "10.2.8",
176
+ "typescript": "5.9.3",
177
+ "vite": "7.3.1",
178
+ "vite-plugin-dts": "4.5.4"
179
+ },
180
+ "engines": {
181
+ "node": ">=22.14.0",
182
+ "pnpm": ">=10.0.0",
183
+ "npm": "please use pnpm"
184
+ },
185
+ "dependencies": {
186
+ "@emotion/styled": "11.14.1"
187
+ }
188
+ }