Initial commit

Author: ismanapa

.eslintrc.js

@@ -0,0 +1,19 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  extends: [
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+  ],
+  plugins: ["simple-import-sort", "import"],
+  parserOptions: {
+    ecmaVersion: 12,
+    sourceType: "module",
+  },
+  rules: {
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "import/first": "error",
+    "import/newline-after-import": "error",
+    "import/no-duplicates": "error",
+  },
+};

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on: push
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+    name: 🚀 Lint and test
+    timeout-minutes: 5
+    steps:
+      - name: 👍 Checkout
+        uses: actions/checkout@v2
+
+      - name: 📦 Cache node modules
+        uses: actions/cache@v2
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - name: 📥 Install dependencies
+        run: npm install
+
+      - name: 💅 Lint code style
+        run: npm run lint
+
+      - name: ✅ Run tests
+        run: npm run test

.gitignore

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

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Codely Enseña y Entretiene SL
+
+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,41 @@
+# 🔷🌱 TypeScript Basic Skeleton
+
+Template intended to serve as a starting point if you want to bootstrap a project in TypeScript.
+
+The purpose of this repository is to leave it with the bare minimum dependencies and tools needed to run TypeScript snippets or start you project without any opinionated decision already made.
+
+## Features
+
+- [TypeScript](https://www.typescriptlang.org/) (v4)
+- [Prettier](https://prettier.io/)
+- [ESLint](https://eslint.org/) with:
+  - [Simple Import Sort](https://github.com/lydell/eslint-plugin-simple-import-sort/)
+  - [Import plugin](https://github.com/benmosher/eslint-plugin-import/)
+  - And a few other ES2015+ related rules
+- [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
+- [GitHub Action workflows](https://github.com/features/actions) set up to run tests and linting on push
+- [SWC](https://swc.rs/): Execute your tests in less than 200ms
+
+## Running the app
+
+- Install the dependencies: `npm install`
+- Execute the tests: `npm run test`
+- Check linter errors: `npm run lint`
+- Fix linter errors: `npm run lint:fix`
+
+## Related skeleton templates
+
+Opinionated TypeScript skeletons ready for different purposes:
+
+- [🔷🕸️ TypeScript Web Skeleton](https://github.com/CodelyTV/typescript-web-skeleton)
+- [🔷🌍 TypeScript API Skeleton](https://github.com/CodelyTV/typescript-api-skeleton)
+- [🔷✨ TypeScript DDD Skeleton](https://github.com/CodelyTV/typescript-ddd-skeleton)
+
+This very same basic skeleton philosophy implemented in other programming languages:
+
+- [✨ JavaScript Basic Skeleton](https://github.com/CodelyTV/javascript-basic-skeleton)
+- [☕ Java Basic Skeleton](https://github.com/CodelyTV/java-basic-skeleton)
+- [📍 Kotlin Basic Skeleton](https://github.com/CodelyTV/kotlin-basic-skeleton)
+- [🧬 Scala Basic Skeleton](https://github.com/CodelyTV/scala-basic-skeleton)
+- [🦈 C# Basic Skeleton](https://github.com/CodelyTV/csharp-basic-skeleton)
+- [🐘 PHP Basic Skeleton](https://github.com/CodelyTV/php-basic-skeleton)

jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  testMatch: ["**/tests/**/*.test.ts"],
+  transform: {
+    "\\.ts$": "@swc/jest",
+  },
+};