chore: cleanup (#256)

Tobi-mmt · web-flow · commit 26ed83190da5 · 2022-05-02T11:48:40.000+02:00
* docs(readme): use typescript

* chore: add prettier

* chore: fix prettier issues

* chore: update lockfile version

* chore: seperate prettier from eslint

* chore: extend eslint file types

* chore: revert lockfile to version 1

* chore: update deps
diff --git a/.editorconfig b/.editorconfig
@@ -9,6 +9,7 @@ end_of_line = lf
 
 [*.md]
 trim_trailing_whitespace = false
+indent_style = space
 
 [.github/**/*]
 indent_style = space
diff --git a/.eslintrc b/.eslintrc
@@ -3,13 +3,9 @@
 		"eslint:recommended",
 		"plugin:react/recommended",
 		"plugin:@typescript-eslint/recommended",
-		"plugin:prettier/recommended"
-	],
-	"plugins": [
-		"react",
-		"@typescript-eslint",
 		"prettier"
 	],
+	"plugins": ["react", "@typescript-eslint"],
 	"env": {
 		"browser": true,
 		"jest": true
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/empty.md b/.github/ISSUE_TEMPLATE/empty.md
@@ -1,8 +1,7 @@
 ---
 name: Empty Issue
 about: Create an empty issue without boilerplate
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -13,12 +13,12 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main, beta ]
+    branches: [main, beta]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
-    - cron: '28 3 * * 5'
+    - cron: "28 3 * * 5"
 
 jobs:
   analyze:
@@ -32,41 +32,41 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ["javascript"]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        config-file: ./.github/codeql/codeql-config.yml
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          config-file: ./.github/codeql/codeql-config.yml
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
 
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
 
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
 
-    #- run: |
-    #   make bootstrap
-    #   make release
+      #- run: |
+      #   make bootstrap
+      #   make release
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
diff --git a/.husky/.gitignore b/.husky/.gitignore
@@ -0,0 +1 @@
+_
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+node_modules
+dist
+docs
+CHANGELOG.md
diff --git a/.storybook/main.js b/.storybook/main.js
@@ -1,18 +1,21 @@
 module.exports = {
-	stories: ['../stories/**/*.stories.tsx'],
-	addons: [{
-		name: '@storybook/addon-essentials',
-		options: {
-			actions: false
-		}
-	}],
+	stories: ["../stories/**/*.stories.tsx"],
+	addons: [
+		{
+			name: "@storybook/addon-essentials",
+			options: {
+				actions: false,
+			},
+		},
+	],
 	typescript: {
 		check: false,
 		checkOptions: {},
-		reactDocgen: 'react-docgen-typescript',
+		reactDocgen: "react-docgen-typescript",
 		reactDocgenTypescriptOptions: {
 			shouldExtractLiteralValuesFromEnum: true,
-			propFilter: (prop) => (prop.parent ? !/node_modules/.test(prop.parent.fileName) : true),
+			propFilter: (prop) =>
+				prop.parent ? !/node_modules/.test(prop.parent.fileName) : true,
 		},
 	},
 };
diff --git a/.storybook/preview.js b/.storybook/preview.js
@@ -1,3 +1,3 @@
 export const parameters = {
-	layout: 'padded',
+	layout: "padded",
 };
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,7 @@
 # Contributing
 
 When contributing to this repository, please first discuss the change you wish to make via issue,
-email, or any other method with the owners of this repository before making a change. 
+email, or any other method with the owners of this repository before making a change.
 
 ## Pull Request Process
 
@@ -10,35 +10,35 @@ email, or any other method with the owners of this repository before making a ch
 3. Make sure to have the latest dependencies installed via `npm install`.
 4. Do your changes and write clear commit messages following our conventions (see previous commits or `commitlint.config.js`).
 5. Test your changes and make sure `npm run lint` passes with no errors. ;)
-6. Update the `CHANGELOG.md` according to your change.	
+6. Update the `CHANGELOG.md` according to your change.
 7. Update the `README.md` if needed.
 8. Push your changes and submit a pull request and mention the issue inside the pull request body.
 
 ## Issue Process
 
-When Opening an issue please keep in mind that we might not be able to support 
-every feature request as we tend to make this project as easy to use and 
+When Opening an issue please keep in mind that we might not be able to support
+every feature request as we tend to make this project as easy to use and
 flexible as possible.
 
 Please provide as much detail to your issues as possible.
 If some parts of the templates doesn't fit to your issue simply delete it.
 
 ## Build process
 
-We have npm scripts which are the source for every build step or anything similar 
-like building the distribution file, creating the storybook files, starting the 
+We have npm scripts which are the source for every build step or anything similar
+like building the distribution file, creating the storybook files, starting the
 storybook server, linting and so on.
 
 The targets meant to be used are:
 
-| Target        | Description   |
-| ------------- |:--------------|
-| `build`      | builds all distribution files |
-| `build-storybook` | builds the storybook files to the `docs` folder |
-| `storybook` | starts the storybook development server on port 6006 |
-| `lint` | runs `eslint` with plugins |
-| `lint-fix` | runs the automatic fixer of `eslint` |
-| `clean` | cleans all generated files i.e. `node_modules` and `dist` |
+| Target            | Description                                               |
+| ----------------- | :-------------------------------------------------------- |
+| `build`           | builds all distribution files                             |
+| `build-storybook` | builds the storybook files to the `docs` folder           |
+| `storybook`       | starts the storybook development server on port 6006      |
+| `lint`            | runs `eslint` with plugins                                |
+| `lint-fix`        | runs the automatic fixer of `eslint`                      |
+| `clean`           | cleans all generated files i.e. `node_modules` and `dist` |
 
 You can see all targets which meant to be used from the developer in the `package.json` under the `script` section.
 If you encounter any problem try to run `npm run clean` at first.
@@ -48,4 +48,5 @@ If you encounter any problem try to run `npm run clean` at first.
 Each push to the `main` branch will build a new version. [semantic-release](https://github.com/semantic-release/semantic-release) creates a changelog, increases the version number, creates a git tag, a github release and deploys it to npm.
 
 ### pre-release
+
 To create a pre-release just push changes to the `beta` branch. This will deploy a beta version (e.g. `1.2.5-beta1`) and publish it as a pre-release on npm.
diff --git a/README.md b/README.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +node_modules
 +dist
 +docs
 +CHANGELOG.md