@paperless/conventions 2.16.3 → 2.17.7

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 (3) hide show
  1. package/CHANGELOG.md +70 -0
  2. package/package.json +6 -2
  3. package/README.md +0 -148
package/CHANGELOG.md CHANGED
@@ -3,6 +3,76 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [2.17.7](https://github.com/Employes/Paperless/compare/v2.17.6...v2.17.7) (2025-12-12)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **ci:** set correct repository urls ([00786f0](https://github.com/Employes/Paperless/commit/00786f0cdd0b104053da2bc29a59dafbb5e6dfb9))
12
+
13
+
14
+
15
+
16
+
17
+ ## [2.17.6](https://github.com/Employes/Paperless/compare/v2.17.5...v2.17.6) (2025-12-12)
18
+
19
+ **Note:** Version bump only for package @paperless/conventions
20
+
21
+
22
+
23
+
24
+
25
+ ## [2.17.5](https://github.com/Employes/Paperless/compare/v2.17.4...v2.17.5) (2025-12-12)
26
+
27
+ **Note:** Version bump only for package @paperless/conventions
28
+
29
+
30
+
31
+
32
+
33
+ ## [2.17.4](https://github.com/Employes/Paperless/compare/v2.17.3...v2.17.4) (2025-12-12)
34
+
35
+ **Note:** Version bump only for package @paperless/conventions
36
+
37
+
38
+
39
+
40
+
41
+ ## [2.17.3](https://github.com/Employes/Paperless/compare/v2.17.2...v2.17.3) (2025-12-12)
42
+
43
+ **Note:** Version bump only for package @paperless/conventions
44
+
45
+
46
+
47
+
48
+
49
+ ## [2.17.2](https://github.com/Employes/Paperless/compare/v2.17.1...v2.17.2) (2025-12-12)
50
+
51
+
52
+ ### Bug Fixes
53
+
54
+ * **ci:** Use npm publish instead of yarn ([fd3644d](https://github.com/Employes/Paperless/commit/fd3644d6f0553610199e0e9b0dabe2c777d38e42))
55
+
56
+
57
+
58
+
59
+
60
+ ## [2.17.1](https://github.com/Employes/Paperless/compare/v2.17.0...v2.17.1) (2025-12-12)
61
+
62
+ **Note:** Version bump only for package @paperless/conventions
63
+
64
+
65
+
66
+
67
+
68
+ # [2.17.0](https://github.com/Employes/Paperless/compare/v2.16.3...v2.17.0) (2025-12-12)
69
+
70
+ **Note:** Version bump only for package @paperless/conventions
71
+
72
+
73
+
74
+
75
+
6
76
  ## [2.16.3](https://github.com/Employes/Paperless/compare/v2.16.2...v2.16.3) (2025-12-02)
7
77
 
8
78
  **Note:** Version bump only for package @paperless/conventions
package/package.json CHANGED
@@ -1,16 +1,20 @@
1
1
  {
2
2
  "name": "@paperless/conventions",
3
3
  "description": "Paperless eslint, typescript & prettier recommended configuration",
4
- "version": "2.16.3",
4
+ "version": "2.17.7",
5
5
  "license": "ISC",
6
6
  "publishConfig": {
7
7
  "registry": "https://registry.npmjs.org"
8
8
  },
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "git+https://github.com/Employes/Paperless.git"
12
+ },
9
13
  "scripts": {
10
14
  "build": "echo 'skipped conventions'",
11
15
  "build:prod": "yarn build",
12
16
  "preyarn:publish": "cp ../../README.md .",
13
- "yarn:publish": "yarn publish",
17
+ "npm:publish": "npm publish",
14
18
  "prettier:check": "yarn prettier \"./**/*.{ts,tsx,html,scss,json}\"",
15
19
  "prettier:write": "yarn prettier:check -w"
16
20
  },
package/README.md DELETED
@@ -1,148 +0,0 @@
1
- <div class="pb-10">
2
- <p align="center">
3
-
4
- <a href="https://paperless.employes.nl">
5
- <img src="https://github.com/Employes/paperless/raw/main/packages/core/src/assets/images/paperless.png" alt="Employes UI" width="400" />
6
- </a>
7
- <br />
8
-
9
- <span>
10
- A collection of Web, React & Angular components that conform to the Employes design system.
11
- </span>
12
-
13
- </p>
14
-
15
- <div align="center">
16
-
17
- [![](https://badgen.net/npm/v/@paperless/core/latest?label=@paperless/core)](https://www.npmjs.com/package/@paperless/core)
18
- [![](https://badgen.net/npm/v/@paperless/angular/latest?label=@paperless/angular)](https://www.npmjs.com/package/@paperless/angular)
19
- [![](https://badgen.net/npm/v/@paperless/react/latest?label=@paperless/react)](https://www.npmjs.com/package/@paperless/react)
20
- [![](https://badgen.net/npm/v/@paperless/conventions/latest?label=@paperless/conventions)](https://www.npmjs.com/package/@paperless/conventions)
21
-
22
- </div>
23
-
24
- <div align="center" >
25
- <a href="https://paperless.employes.nl">https://paperless.employes.nl</a>
26
- </div>
27
- </div>
28
-
29
- ## 📦 Install
30
-
31
- #### React
32
-
33
- ```bash
34
- npm install @paperless/core @paperless/react
35
- ```
36
-
37
- ```bash
38
- yarn add @paperless/core @paperless/react
39
- ```
40
-
41
- #### Angular
42
-
43
- ```bash
44
- npm install @paperless/core @paperless/angular
45
- ```
46
-
47
- ```bash
48
- yarn add @paperless/core @paperless/angular
49
- ```
50
-
51
- #### Web Components
52
-
53
- ```bash
54
- npm install @paperless/core
55
- ```
56
-
57
- ```bash
58
- yarn add @paperless/core
59
- ```
60
-
61
- ## 🚀 Usage
62
-
63
- #### React
64
-
65
- ```jsx
66
- // setup
67
- import { applyPolyfills, defineCustomElements } from '@paperless/core/loader';
68
-
69
- applyPolyfills().then(() => defineCustomElements());
70
-
71
- // usage
72
- import { Button } from '@employes/paperless';
73
-
74
- const App = () => <Button>Click me!</Button>;
75
- ```
76
-
77
- #### Angular
78
-
79
- ```jsx
80
- // main.ts
81
- import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
82
- import { applyPolyfills, defineCustomElements } from '@paperless/core/loader';
83
-
84
- applyPolyfills()
85
- .then(() => defineCustomElements())
86
- .then(() => platformBrowserDynamic().bootstrapModule(AppModule))
87
- .catch((err) => console.error(err));
88
-
89
- // App Module
90
- import { PaperlessModule } from '@employes/paperless-ngx';
91
-
92
- @NgModule({
93
- declarations: [AppComponent],
94
- imports: [
95
- BrowserModule,
96
-
97
- // add this in your app module
98
- PaperlessModule.forRoot(),
99
-
100
- // add this in any module using paperless components
101
- PaperlessModule,
102
- ],
103
- providers: [],
104
- bootstrap: [AppComponent],
105
- })
106
- export class AppModule {}
107
-
108
- // Any component
109
- @Component({
110
- selector: 'app-root',
111
- templateUrl: `
112
- <p-button>Click me!</p-button>
113
- `,
114
- })
115
- export class AppComponent {}
116
- ```
117
-
118
- #### Web Components
119
-
120
- Add the following code snippet in your project to start using the components
121
-
122
- ```javascript
123
- import { defineCustomElements } from '@paperless/core/loader';
124
- defineCustomElements();
125
- ```
126
-
127
- And in your html:
128
-
129
- ```html
130
- <p-button>Click me!</p-button>
131
- ```
132
-
133
- ## ⌨️ Typescript
134
-
135
- The library is javascript based but types are supported with `d.ts` files.
136
- You should get the types automatically when installing `@paperless/core`.
137
-
138
- ## 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
139
-
140
- We welcome contributions to @paperless!
141
-
142
- Read our [contributing
143
- guide](https://github.com/Employes/paperless/blob/main/CONTRIBUTING.md) and help us build or improve our components.
144
-
145
- ## 📝 License
146
-
147
- This project is offered under [Apache
148
- License 2.0](https://github.com/employes/paperless/blob/main/LICENSE).