Merge pull request #1 from CodelyTV/remove-web

feat: add swc and remove all web related dependencies
ci: unify lint and tests workflows in order to speed-up feedback loop
doc: update readme instructions removing web related references
feat: replace ts-jest with SWC (and update the other deps 👼)
chore: fix security issues
feat: replace web content with pure TypeScript examples
doc: link to other skeleton repositories
feat: remove Webpack as it is not needed for bare minimum TypeScript
feat: remove Cypress in order to leave this repository with the bare minimum needed to run TypeScript and move Cypress to typescript-web-skeleton

Co-authored-by: ismanapa <[email protected]>

Author: JavierCane

.eslintrc.js

@@ -4,18 +4,16 @@ module.exports = {
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended",
   ],
-  plugins: ["eslint-plugin-html", "simple-import-sort", "import"],
+  plugins: ["simple-import-sort", "import"],
   parserOptions: {
     ecmaVersion: 12,
     sourceType: "module",
   },
   rules: {
-    // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     "simple-import-sort/imports": "error",
     "simple-import-sort/exports": "error",
     "import/first": "error",
     "import/newline-after-import": "error",
     "import/no-duplicates": "error",
   },
-  ignorePatterns: ["webpack.*.js"],
 };

.github/workflows/lint.yml renamed to .github/workflows/ci.yml

@@ -1,15 +1,17 @@
-name: lint
+name: CI
 
 on: push
 
 jobs:
-  lint:
+  unit:
     runs-on: ubuntu-latest
-
+    name: 🚀 Lint and test
+    timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v2
+      - name: 👍 Checkout
+        uses: actions/checkout@v2
 
-      - name: Cache node modules
+      - name: 📦 Cache node modules
         uses: actions/cache@v2
         env:
           cache-name: cache-node-modules
@@ -21,8 +23,11 @@ jobs:
             ${{ runner.os }}-build-
             ${{ runner.os }}-
 
-      - name: Install Dependencies
+      - name: 📥 Install dependencies
         run: npm install
 
-      - name: Lint
+      - name: 💅 Lint code style
         run: npm run lint
+
+      - name: ✅ Run tests
+        run: npm run test

.github/workflows/test.yml

@@ -1,28 +1 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Dependency directories
 node_modules/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# Build output
-dist

.gitignore

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 CodelyTV
+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

LICENSE

@@ -1,65 +1,41 @@
-# TypeScript Bootstrap (base / project starter)
+# 🔷🌱 TypeScript Skeleton
 
-This is a repository intended to serve as a starting point if you want to bootstrap a project in TypeScript.
+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)
-- [Webpack](https://webpack.js.org/) (v5)
-- [Babel](https://babeljs.io/) with [preset-env](https://babeljs.io/docs/en/babel-preset-env)
 - [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/)
-  - [HTML plugin](https://github.com/BenoitZugmeyer/eslint-plugin-html)
   - And a few other ES2015+ related rules
 - [Jest](https://jestjs.io) with [DOM Testing Library](https://testing-library.com/docs/dom-testing-library/intro)
-- [Cypress](https://www.cypress.io/) with [Testing Library](https://testing-library.com/docs/cypress-testing-library/)
 - [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 dependencies
-npm install
-
-# run in dev mode on port 8080
-npm run dev
-
-# generate production build
-npm run build
-
-# run generated content in dist folder on port 8080
-npm run start
-```
-
-## Testing
-
-### Jest with Testing Library
-
-```
-npm run test
-```
-
-### Cypress
-
-```
-# run in dev mode on port 8080
-npm run dev
+- Install the dependencies: `npm install`
+- Execute the tests: `npm run test`
+- Check linter errors: `npm run lint`
+- Fix linter errors: `npm run lint:fix`
 
-# open Cypress to run tests on dev mode
-npm run cy:open
+## Related skeleton templates
 
-# open Cypress on CLI
-npm run cy:run
-```
+Opinionated TypeScript skeletons ready for different purposes:
 
-## Linting
+- [🔷🕸️ 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)
 
-```
-# run linter
-npm run lint
+This very same basic skeleton philosophy implemented in other programming languages:
 
-# fix lint issues
-npm run lint:fix
-```
+- [✨ 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)