@flux-ui/types 3.0.0-next.8 → 3.0.0-next.9
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 +2 -44
- package/package.json +4 -13
package/README.md
CHANGED
|
@@ -1,45 +1,3 @@
|
|
|
1
|
-
#
|
|
1
|
+
# `@flux-ui/types`
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
targets Vue 3+. Please read the following instructions and checks in order to proceed.
|
|
5
|
-
|
|
6
|
-
## 📦 Registry
|
|
7
|
-
|
|
8
|
-
- The UI library package is available under `@flux-ui/components`.
|
|
9
|
-
- The Dashboard library package is available under `@flux-ui/dashboard`.
|
|
10
|
-
- The internal package is available under `@flux-ui/internals`.
|
|
11
|
-
|
|
12
|
-
## ⚠️ Requirements
|
|
13
|
-
|
|
14
|
-
- Install Node.js ^22
|
|
15
|
-
- Install pnpm using `npm i -g pnpm`.
|
|
16
|
-
- Configure a new environment variable `FONTAWESOME_NPM_AUTH_TOKEN`. This should be a valid Font Awesome private npm auth token.
|
|
17
|
-
- Use `pnpm install` to install the required packages.
|
|
18
|
-
- Use `pnpm dev` to start a build watcher for both targets.
|
|
19
|
-
- Use `pnpm build` to build a production bundle.
|
|
20
|
-
- Use `pnpm link` to link the dist folder of flux to your global node_modules.
|
|
21
|
-
|
|
22
|
-
## 🪵 Git
|
|
23
|
-
|
|
24
|
-
All commit messages and branches will be in English.
|
|
25
|
-
|
|
26
|
-
### Branches
|
|
27
|
-
|
|
28
|
-
- **Main** — Contains the latest stable release and is the exact source that is running in production.
|
|
29
|
-
- **Develop** — Contains the latest staging release that is marked for deployment and is the exact source that is running on staging.
|
|
30
|
-
- **Feature branches** — Any feature should have its own feature branch. Once complete, the branch should be merged into the _develop_ branch and the feature branch should be deleted.
|
|
31
|
-
- **Bugfix branches** — When a bug is found, it should be fixed within a bugfix branch. Once complete the branch should be merged into the _develop_ branch and the feature branch should be deleted.
|
|
32
|
-
|
|
33
|
-
### Commit messages
|
|
34
|
-
|
|
35
|
-
Commit messages are bound to the following templates:
|
|
36
|
-
|
|
37
|
-
- `<type>: <message> `
|
|
38
|
-
- `<type>(<feature>): <message>`
|
|
39
|
-
- `<type>(<feature>): <message> [<issue-number>]`
|
|
40
|
-
|
|
41
|
-
#### Examples
|
|
42
|
-
|
|
43
|
-
- `feat(expandable): adds header slot to expandable.`
|
|
44
|
-
- `feat(expandable): adds header slot to expandable. [FLUX-123]`
|
|
45
|
-
- `chore: adds vue 3 build target.`
|
|
3
|
+
Contains all public types that are used in various `@flux-ui` packages.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flux-ui/types",
|
|
3
3
|
"description": "Contains all public types of Flux UI packages.",
|
|
4
|
-
"version": "3.0.0-next.
|
|
4
|
+
"version": "3.0.0-next.9",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"funding": "https://github.com/sponsors/basmilius",
|
|
@@ -9,21 +9,12 @@
|
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
11
|
"url": "git+https://github.com/basmilius/flux.git",
|
|
12
|
-
"directory": "packages/
|
|
12
|
+
"directory": "packages/types"
|
|
13
13
|
},
|
|
14
14
|
"keywords": [
|
|
15
|
-
"
|
|
16
|
-
"
|
|
17
|
-
"design system",
|
|
18
|
-
"vue",
|
|
19
|
-
"vue 3",
|
|
20
|
-
"ui",
|
|
21
|
-
"components",
|
|
22
|
-
"flux"
|
|
15
|
+
"flux",
|
|
16
|
+
"types"
|
|
23
17
|
],
|
|
24
|
-
"scripts": {
|
|
25
|
-
"prepublishOnly": "cp ../../README.md ."
|
|
26
|
-
},
|
|
27
18
|
"exports": {
|
|
28
19
|
".": "./src/index.ts"
|
|
29
20
|
},
|