Add hypetech dev prefered eslint rules

Author: marsicdev

.github/workflows/npm-publish.yml

@@ -0,0 +1,44 @@
+name: Publish to NPM
+
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    publish-npm:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            id-token: write
+        steps:
+            - uses: actions/checkout@v3
+            - name: Get package version
+              id: package-version
+              uses: martinbeentjes/[email protected]
+            - name: Setup node environment
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18.x'
+                  registry-url: https://registry.npmjs.org
+            - run: npm ci
+            - name: Publish to NPM
+              run: npm publish --provenance --access public
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+            - name: Collect release notes
+              id: collect-release-notes
+              run: |
+                  echo "::group::Prepare release notes"
+                  RELEASE_NOTES=$(awk -v ver=${{ steps.package-version.outputs.current-version }} '/^## \[/ { if ($2 == "["ver"]") { p=1 } else { p=0 } } p { print }' CHANGELOG.md | tail -n +3)
+                  echo "RELEASE_NOTES<<EOF" >> $GITHUB_ENV
+                  echo "$RELEASE_NOTES" >> $GITHUB_ENV
+                  echo "EOF" >> $GITHUB_ENV
+                  echo "::endgroup::"
+            - name: Create Release Tag
+              id: create-release
+              uses: softprops/action-gh-release@v1
+              with:
+                  tag_name: ${{ steps.package-version.outputs.current-version }}
+                  body: ${{ env.RELEASE_NOTES }}
+                  token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+node_modules/

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2023-08-21
+
+### Added
+
+-   ESlint configuration according to HypeTech Frontend Coding Standards.
+-   Install documentation
+-   Changes changelog
+-   Actions release workflow

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 HypeTech
+
+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.

README.md

@@ -0,0 +1,71 @@
+# HypeTech - eslint-config
+
+The official HypeTech eslint configuration, part of the Frontend Coding Standards.
+
+## Installation
+
+The configuration can be installed via your preferred package manager.
+
+With PNPM (preferred):
+
+```bash
+pnpm add @hypetech/eslint-config -D
+```
+
+With Yarn:
+
+```bash
+yarn add -D @hypetech/eslint-config
+```
+
+With NPM:
+
+```bash
+npm install --dev @hypetech/prettier-config
+```
+
+To inform eslint of this configuration, you have to add the `eslint` property to your `package.json` file:
+
+```json
+"eslintConfig": {
+   "extends": "@hypetech/eslint-config"
+}
+```
+
+Instead of manually editing your `package.json`, you can also utilize the `npm pkg` subcommand:
+
+```bash
+npm pkg set eslintConfig.extends=@hypetech/eslint-config
+```
+
+Alternatively, you can also create a `.eslintrc.cjs` file in your project root and add the following content:
+
+```js
+module.exports = {
+    root: true,
+    extends: '@hypetech/eslint-config',
+}
+```
+
+> Notice: You should add configuration to your `package.json` if you are creating a library, and use a `.eslintrc.cjs` file if you are creating an application. And you should avoid both ways in the same project.
+
+## Extending
+
+To extend the configuration, you will have to create a `.eslintrc.js` file (or `.eslintrc.cjs` if your package is a `"type": "module"`) and import the HypeTech configuration using `require`:
+
+```js
+module.exports = {
+    ...require('@hypetech/eslint-config'),
+    rules: {
+        'no-console': 'warn',
+    },
+}
+```
+
+# Contributing
+
+Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change.
+
+# License
+
+This project is licensed under the terms of the [MIT license](/LICENSE).

index.js

@@ -0,0 +1,82 @@
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    extends: [
+        'plugin:react/recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:react-hooks/recommended',
+        'prettier',
+        'plugin:prettier/recommended',
+        'plugin:@next/next/recommended',
+    ],
+    plugins: ['@typescript-eslint', 'import', 'unused-imports'],
+    parserOptions: {
+        ecmaVersion: 2020,
+        sourceType: 'module',
+        ecmaFeatures: {
+            jsx: true,
+        },
+    },
+    rules: {
+        '@typescript-eslint/no-empty-interface': 'error',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        '@typescript-eslint/padding-line-between-statements': [
+            'error',
+            {
+                blankLine: 'always',
+                prev: ['const', 'let', 'var', 'export', 'interface', 'type'],
+                next: '*',
+            },
+            {
+                blankLine: 'any',
+                prev: ['const', 'let', 'var'],
+                next: ['const', 'let', 'var'],
+            },
+            { blankLine: 'always', prev: '*', next: ['interface', 'type'] },
+        ],
+        'import/order': [
+            'error',
+            {
+                'newlines-between': 'always',
+                // alphabetize: { order: 'asc', caseInsensitive: true },
+                // Custom groups for sorting
+                pathGroups: [
+                    '@/',
+                    'types',
+                    'config',
+                    'lib',
+                    'app',
+                    'components',
+                    'pages',
+                    'res',
+                ].map(function (path) {
+                    return {
+                        pattern: path + '/**',
+                        group: 'external',
+                        position: 'after',
+                    }
+                }),
+                pathGroupsExcludedImportTypes: ['builtin'],
+            },
+        ],
+        'padding-line-between-statements': 'off',
+        'prettier/prettier': 'error',
+        'react/react-in-jsx-scope': 'off',
+        'unused-imports/no-unused-imports-ts': 'error',
+        'unused-imports/no-unused-vars-ts': [
+            'warn',
+            {
+                vars: 'all',
+                varsIgnorePattern: '^_',
+                args: 'after-used',
+                argsIgnorePattern: '^_',
+            },
+        ],
+    },
+    settings: {
+        react: {
+            version: 'detect',
+        },
+    },
+}