perf: switch to typescript (#25)

Author: abolkog

.babelrc

@@ -0,0 +1,6 @@
+node_modules
+.eslintrc.js
+jest*js
+tailwind.config.js
+postcss.config.js
+

.eslintignore

@@ -0,0 +1,65 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    jest: true,
+  },
+  extends: [
+    'plugin:react/recommended',
+    'airbnb',
+    'airbnb-typescript',
+    'plugin:prettier/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    project: './tsconfig.json',
+  },
+  plugins: [
+    'react',
+    '@typescript-eslint',
+    'import',
+    'no-relative-import-paths',
+    'prettier',
+  ],
+  rules: {
+    'react/function-component-definition': 'off',
+    'react/prop-types': 'off',
+    'react/react-in-jsx-scope': 'off',
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      { ts: 'never', tsx: 'never' },
+    ],
+    'react/jsx-filename-extension': [
+      'error',
+      { extensions: ['.js', '.jsx', '.ts', '.tsx'] },
+    ],
+    'import/prefer-default-export': 'off',
+    'no-unused-vars': 'off',
+    'react/jsx-props-no-spreading': 'off',
+    'react/jsx-no-useless-fragment': 'off',
+    'react/require-default-props': 'off',
+    'no-relative-import-paths/no-relative-import-paths': [
+      'error',
+      { rootDir: 'src' },
+    ],
+    'no-restricted-exports': 'off',
+    'no-eval': 'off',
+  },
+  settings: {
+    'import/resolver': {
+      node: {
+        extensions: ['.js', '.jsx', '.d.ts', '.ts', '.tsx'],
+        moduleDirectory: ['node_modules', 'src'],
+      },
+    },
+    react: {
+      version: 'detect',
+    },
+  },
+};

.eslintrc

@@ -0,0 +1,31 @@
+name: Pull Request
+
+on: [pull_request]
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+      - name: Install dependencies
+        run: npm ci
+      - name: Code Lint
+        run: npm run lint
+      - name: Commit Lint
+        uses: wagoid/commitlint-github-action@v5
+        with:
+          failOnWarnings: true
+      - name: Test Coverage
+        uses: ArtiomTr/jest-coverage-report-action@v2
+        id: coverage
+        with:
+          output: report-markdown
+      - name: Publish Coverage
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          message: ${{ steps.coverage.outputs.report }}

.eslintrc.js

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

.github/workflows/pull_requests.yml

@@ -0,0 +1 @@
+v16.14.2

.husky/pre-commit

@@ -1,5 +1,4 @@
 {
   "singleQuote": true,
-  "printWidth": 100,
   "arrowParens": "avoid"
 }

.nvmrc

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Khalid Elshafie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.prettierrc

@@ -1,6 +1,7 @@
 ## js-playground (JavaScript Playground)
 
 ![GitHub package.json version](https://img.shields.io/github/package-json/v/abolkog/js-playground)
+![](https://img.shields.io/github/license/abolkog/js-playground.svg)
 
 A simple JavaScript playground / code sandbox hooked up with few libraries for quick code testing
 
@@ -9,7 +10,6 @@ A simple JavaScript playground / code sandbox hooked up with few libraries for q
 ## Available Libraries
 
 - [Redux](https://redux.js.org/)
-- [Moment](https://momentjs.com/)
 - [Lodash](https://lodash.com/)
 - [Axios](https://github.com/axios/axios)
 - [Luxon](https://moment.github.io/luxon/#/)
@@ -22,13 +22,40 @@ You can see demo at [This link](https://abolkog.github.io/js-playground/index.ht
 
 1- Clone the Repo
 
-2- Install the dependencies
+2- If you are using `nvm`, setup node version using the `.nvmrc` file
 
+```shell
+nvm use
 ```
+
+3- Install the dependencies
+
+```shell
 npm install
+```
+
+4- Start the dev server
+
+```shell
 npm start
 ```
 
-2- Visit [http://localhost:3000](http://localhost:3000) on your browser.
+5- Visit [http://localhost:3000](http://localhost:3000) on your browser.
+
+6- Start writing JS code !
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## Authors
+
+- **Khalid Elshafie** - _Initial work_ - [abolkog](https://github.com/abolkog)
+
+See also the list of [contributors](https://github.com/abolkog/js-playground/contributors) who participated in this project.
+
+## License
 
-3- Start writing JS code !
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details