From a8648113cfab8085afd1c802171aec0204d23236 Mon Sep 17 00:00:00 2001 From: Juan Cruz Insaurralde Date: Sun, 10 Sep 2023 20:12:56 -0300 Subject: [PATCH] added summary for other technologies --- sections/technologies/technologies.md | 84 ++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 1 deletion(-) diff --git a/sections/technologies/technologies.md b/sections/technologies/technologies.md index 9aa51ed..9b86cde 100644 --- a/sections/technologies/technologies.md +++ b/sections/technologies/technologies.md @@ -64,7 +64,89 @@ If you need help on installing these elements in your system, [consult our short ## Other technologies -_< TO BE DONE: explain rollup, nps, jest, prettier, eslint, editorconfig, typedoc... >_ + + + +As a means to bundle and compile code from the project modules, we use `rollup.js` which is designed for modern JavaScript development applications, focusing on creating efficient and optimized bundles for the web. +
+Expand to view more about rollup.js + +A good starting point to know the basics on `rollup.js` is [`rollupjs.org`](https://rollupjs.org/). +
+ +--- + + + + +To define and execute custom scripts within `Node.js`, the project uses a `npm` feature called `nps` (Node Package Scripts) which can automate various tasks, such as building, testing, deploying, and more. +
+Expand to view more about nps + +A good starting point to know the basics on `nps` is [`npmjs.com`](https://www.npmjs.com/package/nps). +
+ +--- + + + + +For style consistency, the inclusion of the opinionated code formatter `Prettier` helps to automatically enforce a general set of styling rules. +
+Expand to view more about Prettier + +A good starting point to know the basics on `Prettier` is [`prettier.io`](https://prettier.io/). +
+ +--- + + + + +In addition to `Prettier` for maintainability of codebase, `ESLint` statically analyzes the code for common errors, stylistic issues, and potential pitfalls, thus providing actionable feedback to fix such problems for `Javascript`/`Typescript`. +
+Expand to view more about ESLint + +A good starting point to know the basics on `ESLint` is [`eslint.org`](https://eslint.org/). +
+ +--- + + + + +For more style and formatting consistency, there is also the inclusion of `EditorConfig`, a file format that works across different code editors and IDEs. +
+Expand to view more about EditorConfig + +A good starting point to know the basics on `EditorConfig` is [`editorconfig.org`](https://editorconfig.org/). +
+ +--- + + + + +As a way to generate documentation, the `TypeDoc` tool reads the `TypeScript` source files, parses comments contained within them, and creates API documentation for a more comprehensive and well-structured documentation of the project. +
+Expand to view more about TypeDoc + +A good starting point to know the basics on `TypeDoc` is [`typedoc.org`](https://typedoc.org/guides/overview/). +
+ +--- + + + + +Last but not least, you will be creating, running, and managing test suites with `Jest` testing framework. It works with `TypeScript` code, providing a comprehensive set of tools and features to simplify the process of writing and maintaining tests. +
+Expand to view more about Jest + +A good starting point to know the basics on `Jest` is [`jestjs.io`](https://jestjs.io/). +
+ +--- [Back to Introduction](../introduction.md).