@paperless/conventions 0.0.0

package/.editorconfig

@@ -0,0 +1,14 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = tab
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 140
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/.eslintrc.js

@@ -0,0 +1,29 @@
+module.exports = {
+	parserOptions: {
+		project: './tsconfig.json',
+	},
+	extends: [
+		'airbnb',
+		'eslint:recommended',
+		'plugin:@stencil/recommended',
+		'plugin:import/errors',
+		'plugin:react/recommended',
+		'plugin:jsx-a11y/recommended',
+		'plugin:prettier/recommended',
+		'prettier/react',
+		'plugin:@angular-eslint/recommended',
+		'plugin:@angular-eslint/template/process-inline-templates',
+	],
+	overrides: [
+		{
+			files: ['*.html'],
+			extends: ['plugin:@angular-eslint/template/recommended'],
+			rules: {
+				/**
+				 * Any template/HTML related rules you wish to use/reconfigure over and above the
+				 * recommended set provided by the @angular-eslint project would go here.
+				 */
+			},
+		},
+	],
+};

package/README.md

@@ -0,0 +1,119 @@
+<p align="center">
+
+  <a href="https://paperless.employes.nl">
+      <img src="https://github.com/Employes/paperless/raw/main/packages/core/src/assets/images/paperless.png" alt="Employes UI" width="400" />
+  </a>
+  <br />
+<span>
+A collection of React & Angular components that conform to the Employes design system.
+</span>
+
+</p>
+
+<div align="center">
+
+[![](https://badgen.net/npm/v/@paperless/core/latest?label=@paperless/core)](https://www.npmjs.com/package/@paperless/core)
+[![](https://badgen.net/npm/v/@paperless/angular/latest?label=@paperless/angular)](https://www.npmjs.com/package/@paperless/angular)
+[![](https://badgen.net/npm/v/@paperless/angular/latest?label=@paperless/react)](https://www.npmjs.com/package/@paperless/react)
+
+</div>
+
+<div align="center">
+ <a href="https://paperless.employes.nl">https://paperless.employes.nl</a>
+</div>
+
+## 📦 Install
+
+#### React
+
+```bash
+npm install @paperless/core @paperless/react
+```
+
+```bash
+yarn add @paperless/core @paperless/react
+```
+
+#### Angular
+
+```bash
+npm install @paperless/core @paperless/angular
+```
+
+```bash
+yarn add @paperless/core @paperless/angular
+```
+
+#### Web Components
+
+```bash
+npm install @paperless/core
+```
+
+```bash
+yarn add @paperless/core
+```
+
+## 🚀 Usage
+
+#### React
+
+```jsx
+import { Button } from '@employes/paperless';
+
+const App = () => <Button>Click me!</Button>;
+```
+
+#### Angular
+
+```jsx
+import { PaperlessModule } from '@employes/paperless-ngx';
+
+@NgModule({
+    declarations: [AppComponent],
+    imports: [BrowserModule, PaperlessModule],
+    providers: [],
+    bootstrap: [AppComponent],
+})
+export class AppModule {}
+
+@Component({
+    selector: 'app-root',
+    templateUrl: `
+      <p-button>Click me!</p-button>
+    `,
+})
+export class AppComponent {}
+```
+
+#### Web Components
+
+Add the following code snippet in your project to start using the components
+
+```javascript
+import { defineCustomElements } from '@paperless/core/loader';
+defineCustomElements();
+```
+
+And in your html:
+
+```html
+<p-button>Click me!</p-button>
+```
+
+## ⌨️ Typescript
+
+The library is javascript based but types are supported with `d.ts` files.
+You should get the types automatically when installing `@paperless/core`.
+
+## 🤝 Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+
+We welcome contributions to @paperless!
+
+Read our [contributing
+guide](https://github.com/Employes/paperless/blob/main/CONTRIBUTING.md) and help us build or improve our components.
+
+## 📝 License
+
+This project is offered under [Apache
+License 2.0](https://github.com/employes/paperless/blob/main/LICENSE).

package/index.js

@@ -0,0 +1,3 @@
+const eslintrc = require('./.eslintrc.js');
+
+module.exports = eslintrc;

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@paperless/conventions",
+	"description": "Paperless eslint, typescript & prettier recommended configuration",
+	"version": "0.0.0",
+	"main": "index.js",
+	"license": "ISC",
+	"scripts": {
+		"build": "echo 'skipped conventions'",
+		"build:prod": "yarn build",
+		"preyarn:publish": "cp ../../README.md .",
+		"yarn:publish": "yarn publish"
+	},
+	"publishConfig": {
+		"access": "public",
+		"registry": "https://registry.npmjs.org"
+	},
+	"devDependencies": {
+		"@angular-eslint/eslint-plugin": "^13.2.1",
+		"@angular-eslint/eslint-plugin-template": "^13.2.1",
+		"@angular-eslint/template-parser": "^13.2.1",
+		"@stencil/eslint-plugin": "^0.4.0",
+		"@typescript-eslint/eslint-plugin": "^5.19.0",
+		"@typescript-eslint/parser": "^5.19.0",
+		"eslint": "^8.13.0",
+		"eslint-plugin-react": "^7.29.4",
+		"prettier": "^2.6.2",
+		"typescript": "^4.6.3"
+	},
+	"peerDependencies": {
+		"@angular-eslint/eslint-plugin": "^13.2.1",
+		"@angular-eslint/eslint-plugin-template": "^13.2.1",
+		"@angular-eslint/template-parser": "^13.2.1",
+		"@stencil/eslint-plugin": "^0.4.0",
+		"@typescript-eslint/eslint-plugin": "^5.19.0",
+		"@typescript-eslint/parser": "^5.19.0",
+		"eslint": "^8.13.0",
+		"eslint-plugin-react": "^7.29.4",
+		"prettier": "^2.6.2",
+		"typescript": "^4.6.3"
+	}
+}

package/prettier.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+	trailingComma: 'es5',
+	tabs: true,
+	tabWidth: 4,
+	singleQuote: true,
+	printWidth: 80,
+};

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+	"compileOnSave": false,
+	"compilerOptions": {
+		"rootDir": ".",
+		"sourceMap": true,
+		"declaration": false,
+		"moduleResolution": "node",
+		"downlevelIteration": true,
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true,
+		"importHelpers": true,
+		"target": "es2015",
+		"module": "esnext",
+		"allowJs": false,
+		"typeRoots": ["node_modules/@types"],
+		"lib": ["es2019", "dom"],
+		"forceConsistentCasingInFileNames": true,
+		"skipLibCheck": true,
+		"skipDefaultLibCheck": true,
+		"baseUrl": ".",
+		"resolveJsonModule": true,
+		"noImplicitReturns": false,
+		"noImplicitThis": false,
+		"noImplicitAny": false,
+		"strictNullChecks": false,
+		"suppressImplicitAnyIndexErrors": true,
+		"noUnusedLocals": true,
+		"allowSyntheticDefaultImports": true
+	},
+	"exclude": ["node_modules", "tmp", "dist"],
+	"angularCompilerOptions": {
+		"enableIvy": true
+	}
+}