@muenchen/muc-patternlab-vue 1.2.0 → 1.3.0

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 +41 -18
  2. package/package.json +3 -2
package/README.md CHANGED
@@ -1,12 +1,30 @@
1
1
  ![logo-footer-muenchen-de.svg](docs/images/logo-footer-muenchen-de.svg)
2
2
 
3
+ <p>
4
+ <a href="https://github.com/it-at-m/muc-patternlab-vue/actions/workflows/build.yaml?query=branch%3Amain">
5
+ <img src="https://img.shields.io/github/actions/workflow/status/it-at-m/muc-patternlab-vue/build.yaml
6
+ "
7
+ alt="Build Status">
8
+ </a>
9
+ <a href="https://gitmoji.dev">
10
+ <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg"
11
+ alt="Gitmoji">
12
+ </a>
13
+ <a href="https://github.com/semantic-release/semantic-release">
14
+ <img src="https://img.shields.io/badge/semantic--release-gitmoji-e10079?logo=semantic-release"
15
+ alt="semantic-release: gitmoji">
16
+ </a>
17
+ </p>
18
+
3
19
  # muc-patternlab-vue
4
20
 
5
- This repository contains a ready-to-use Vue-Components-Library based on [munich.de's MDE5 Patternlab](https://patternlab.muenchen.space/).
21
+ This repository contains a ready-to-use Vue-Components-Library based
22
+ on [munich.de's MDE5 Patternlab](https://patternlab.muenchen.space/).
6
23
 
7
24
  In its current state only some components exist. The library will continually grow as the need for new components grows.
8
25
 
9
- We intend to let this project be a community project in which every developer who needs new components contributes the results of his work into this library.
26
+ We intend to let this project be a community project in which every developer who needs new components contributes the
27
+ results of his work into this library.
10
28
 
11
29
  ## Roadmap
12
30
 
@@ -16,7 +34,8 @@ In the near future we plan to
16
34
  - Create more components
17
35
  - Integrate MDE5 Patternlab npm-Package as soon as it's available
18
36
 
19
- See the [open issues](https://github.com/it-at-m/muc-patternlab-vue/issues) for a full list of proposed features (and known issues).
37
+ See the [open issues](https://github.com/it-at-m/muc-patternlab-vue/issues) for a full list of proposed features (and
38
+ known issues).
20
39
 
21
40
  ## Usage
22
41
 
@@ -39,27 +58,32 @@ npm run docs:dev
39
58
  2. Create Vue-Component (with composition api) and index.ts-File which exports your component
40
59
  3. Add your new Component to `./src/components/index.ts`
41
60
  4. Create documentation for your component
42
- 1. Create at least one "Basic" demo at `./docs/components/demo/<your-component>`
43
- 2. Create a doc-File for your component at `./docs/components/<your-component>.md`
44
- 3. Add your component doc to the sidebar at `./docs/.vitepress/config.ts`
61
+ 1. Create at least one "Basic" demo at `./docs/components/demo/<your-component>`
62
+ 2. Create a doc-File for your component at `./docs/components/<your-component>.md`
63
+ 3. Add your component doc to the sidebar at `./docs/.vitepress/config.ts`
45
64
 
46
65
  ### Using MDE5 Patternlab-Icons
47
66
 
48
- Patternlab-Icons are provided by a svg-Sprite which is automatically injected in this repos App.vue-File for local testing. You can expect the users of this library to do the same thing.
67
+ Patternlab-Icons are provided by a svg-Sprite which is automatically injected in this repos App.vue-File for local
68
+ testing. You can expect the users of this library to do the same thing.
49
69
 
50
- So to use an icon from Patternlab you can simply follow the official documentation: https://patternlab.muenchen.space/?p=viewall-guidelines-icons
70
+ So to use an icon from Patternlab you can simply follow the official
71
+ documentation: https://patternlab.muenchen.space/?p=viewall-guidelines-icons
51
72
 
52
73
  ```html
74
+
53
75
  <svg aria-hidden="true" class="icon">
54
- <use xlink:href="#icon-{name}"></use>
76
+ <use xlink:href="#icon-{name}"></use>
55
77
  </svg>
56
78
  ```
57
79
 
58
80
  ## Contributing
59
81
 
60
- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
82
+ Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any
83
+ contributions you make are **greatly appreciated**.
61
84
 
62
- If you have a suggestion that would make this better, please open an issue with the tag "enhancement", fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
85
+ If you have a suggestion that would make this better, please open an issue with the tag "enhancement", fork the repo and
86
+ create a pull request. You can also simply open an issue with the tag "enhancement".
63
87
  Don't forget to give the project a star! Thanks again!
64
88
 
65
89
  1. Open an issue with the tag "enhancement"
@@ -75,19 +99,18 @@ More about this in the [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) file.
75
99
 
76
100
  This project uses [semantic-release](https://github.com/semantic-release/semantic-release)!
77
101
 
78
- It follows [Angulars Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format). For example:
102
+ It follows [gitmoji commit conventions](https://gitmoji.dev/). For example:
79
103
 
80
- | Commit message | Release type |
81
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
82
- | `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
83
- | `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
84
- | `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release |
104
+ | Commit message | Release type |
105
+ |-------------------------------------------------------------------------------------------------------------------------------------|---------------|
106
+ | `:lipstick` / `:lock:` / `:ambulance:` / `:bug: stop graphite breaking when too much pressure applied` | Patch Release |
107
+ | `:sparkles: add 'graphiteWidth' option` | Minor Release |
108
+ | `:boom: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | Major Release |
85
109
 
86
110
  ## License
87
111
 
88
112
  Distributed under the MIT License. See [LICENSE](LICENSE) file for more information.
89
113
 
90
-
91
114
  ## Contact
92
115
 
93
116
  it@M - opensource@muenchen.de
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "author": "FabianWilms",
4
4
  "description": "A vue component library of some of the components available from https://patternlab.muenchen.space",
5
5
  "license": "MIT",
6
- "version": "1.2.0",
6
+ "version": "1.3.0",
7
7
  "private": false,
8
8
  "module": "./dist/muc-patternlab-vue.es.js",
9
9
  "types": "./dist/types/index.d.ts",
@@ -63,7 +63,8 @@
63
63
  "npm-run-all2": "^6.1.1",
64
64
  "prettier": "^3.0.3",
65
65
  "rimraf": "^5.0.1",
66
- "semantic-release": "^23.0.0",
66
+ "semantic-release": "^22.0.0",
67
+ "semantic-release-gitmoji": "^1.6.5",
67
68
  "typescript": "~5.4.0",
68
69
  "vite": "^5.0.11",
69
70
  "vite-plugin-dts": "^3.0.0",