Merge pull request #2 from NicolasOmar/second-exercise

Typescript | Second exercise
NicolasOmar · Nov 26, 2022 · 1304963 · 1304963
2 parents e1b220e + 11869be
commit 1304963
Show file tree

Hide file tree

Showing 19 changed files with 200 additions and 9 deletions.
diff --git a/1-base-project/.gitignore → 1-basics/.gitignore b/1-base-project/.gitignore → 1-basics/.gitignore
diff --git a/1-base-project/configs/server.json → 1-basics/configs/server.json b/1-base-project/configs/server.json → 1-basics/configs/server.json
diff --git a/1-base-project/package.json → 1-basics/package.json b/1-base-project/package.json → 1-basics/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "1-base-project",
+  "name": "1-basics",
   "version": "0.1.0",
-  "private": true,
+  "private": false,
   "scripts": {
     "start": "lite-server -c configs/server.json",
     "build": "tsc public/scripts/app.ts"

diff --git a/1-base-project/public/favicon.ico → 1-basics/public/favicon.ico b/1-base-project/public/favicon.ico → 1-basics/public/favicon.ico
diff --git a/1-base-project/public/index.html → 1-basics/public/index.html b/1-base-project/public/index.html → 1-basics/public/index.html
@@ -4,7 +4,7 @@
     <meta charset="UTF-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Base TS Project | Exercise #1</title>
+    <title>Typescript Practice | Exercise #1</title>
     <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
     <script defer src="./scripts/app.js"></script>
   </head>

diff --git a/1-base-project/public/scripts/app.js → 1-basics/public/scripts/app.js b/1-base-project/public/scripts/app.js → 1-basics/public/scripts/app.js
diff --git a/1-base-project/public/scripts/app.ts → 1-basics/public/scripts/app.ts b/1-base-project/public/scripts/app.ts → 1-basics/public/scripts/app.ts
diff --git a/2-configs/.gitignore b/2-configs/.gitignore
@@ -0,0 +1,26 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# specific files
+package-lock.json
diff --git a/2-configs/configs/server.json b/2-configs/configs/server.json
@@ -0,0 +1,3 @@
+{
+  "server": { "baseDir": "./public" }
+}
diff --git a/2-configs/package.json b/2-configs/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "2-configs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "start": "lite-server -c configs/server.json",
+    "build": "tsc",
+    "build:watch": "tsc -w"
+  },
+  "devDependencies": {
+    "lite-server": "^2.6.1"
+  }
+}
diff --git a/2-configs/public/dist/analytics.js b/2-configs/public/dist/analytics.js
@@ -0,0 +1,7 @@
+"use strict";
+let logged;
+const sendAnalytics = (data) => {
+    console.log(data);
+    logged = true;
+};
+sendAnalytics('Sending to the server...');
diff --git a/2-configs/public/dist/app.js b/2-configs/public/dist/app.js
@@ -0,0 +1,4 @@
+"use strict";
+const button = document.querySelector('.clickeable');
+const clickHandler = (text) => console.warn(text);
+button === null || button === void 0 ? void 0 : button.addEventListener('click', () => clickHandler('Thank you for click me'));
diff --git a/2-configs/public/favicon.ico b/2-configs/public/favicon.ico
diff --git a/2-configs/public/index.html b/2-configs/public/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Typescript Practice | Exercise #2</title>
+    <link rel="shortcut icon" href="favicon.ico" type="image/x-icon">
+    <script defer src="./dist/app.js"></script>
+    <script defer src="./dist/analytics.js"></script>
+  </head>
+  <body>
+    <button class="clickeable">Click me!</button>
+  </body>
+</html>
diff --git a/2-configs/public/scripts/analytics.ts b/2-configs/public/scripts/analytics.ts
@@ -0,0 +1,8 @@
+let logged
+
+const sendAnalytics = (data: string): void => {
+  console.log(data)
+  logged = true
+}
+
+sendAnalytics('Sending to the server...')
diff --git a/2-configs/public/scripts/app.ts b/2-configs/public/scripts/app.ts
@@ -0,0 +1,4 @@
+const button = document.querySelector('.clickeable')
+const clickHandler = (text: string): void => console.warn(text)
+
+button?.addEventListener('click', () => clickHandler('Thank you for click me'))
diff --git a/2-configs/tsconfig.json b/2-configs/tsconfig.json
@@ -0,0 +1,106 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./public/dist",                           /* Specify an output folder for all emitted files. */
+    "removeComments": true,                              /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    "noEmitOnError": true,                               /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": [
+    "./public/scripts"
+  ]
+}
diff --git a/README.md b/README.md
@@ -15,7 +15,8 @@ npm run setup-all
 | App Setup | Command |
 | ------ | ------ |
 | All | `npm run setup-all` |
-| Base project | `npm run setup-base-project` |
+| Basics | `npm run setup-basics` |
+| Configs | `npm run setup-configs` |
 
 ## How to run it
 To run any specific exercise, execute the following command in the project´s folder:
@@ -24,11 +25,15 @@ npm start
 ```
 
 ## Repo Structure & what i learned in each exercise
- - Base project (`1-base-project` folder)
+ - Basics (`1-basics` folder)
    - Create, code and compile a `.ts` file into javascript
    - Understanding of `Core Types` like `number`, `string`, `boolean`, `array` and `object`
    - Understanding of `Tuples`, `Enums`, `Union` and `Literal/Custom` Types
    - Understanding of `void`, `undefined`, `unknown` and `never` Types
+ - Configs (`2-configs` folder)
+   - Adding `watch mode` to mantain updated changes and check possible errors before hand
+   - Create a typescript configuration file with `tsc --init` and tweak for a custom config
+   - Understand how Typescript compiles ES6+ code (like `let/const`, `arrow functions`, `default function parameters`, `spread operator` and `destructuring`)
 
 ## Version (currently ![Typescript practice version](https://img.shields.io/github/package-json/v/nicolasomar/typescript-practice?color=success&label=%20&style=flat-square))
 | Number | Meaning |

diff --git a/package.json b/package.json
@@ -1,8 +1,7 @@
 {
   "name": "typescript-practice",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Repository created to record my practice learning Typescript",
-  "main": "index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NicolasOmar/typescript-practice.git"
@@ -14,7 +13,8 @@
   },
   "homepage": "https://github.com/NicolasOmar/typescript-practice#readme",
   "scripts": {
-    "setup-base-project": "cd ./1-base-project && npm i",
-    "setup-all": "npm i -g typescript && npm run setup-base-project"
+    "setup-basics": "cd ./1-basics && npm i",
+    "setup-configs": "cd ./2-configs && npm i",
+    "setup-all": "npm i -g typescript && npm run setup-basics && npm run setup-configs"
   }
 }