gibbok / typescript-book Goto Github PK

I have been using TypeScript for a while but haven't checked out any materials that systematically explain its inner workings. I found this book to be truly helpful. Thank you for your wonderful work!

In the section about reversed mapping of enums, there is a code example showcasing a Language enum with 2 string enum members. However, there are a few minor issues with that example. Firstly, it does not demonstrate how the reverse mapping maps the value back to its key. Secondly, according to the TypeScript documentation, string enum members do not automatically generate a reverse mapping.

Perhaps the following example would be better? I can create a pull request if you find it acceptable.

enum Grade {
  A = 90,
  B = 80,
  C = 70
}

// reverse mapping maps an enum value back to its corresponding key
const myGrade = Grade.A;
console.log(Grade[myGrade]) // => "A"
console.log(Grade[90]) // => "A"

Setup GitHub Actions, we need to ensure that we are able to:

• Check for any Markdown lint errors.
• Compile all TypeScript snippets and check for errors.
• Check for formatting issues using Prettier.

If any errors are found during these checks, the build should fail (some scripts are already done in folder tools).

I have an error when using the "send to kindle" functionnality with the epub version. Kindle does not provide the detail of the error. However, after processing the epub in an epub validator, it reports the following issues :

Validating using EPUB version 3.2 rules.
ERROR(RSC-012): epub/EPUB/text/ch001.xhtml(104,29): Fragment identifier is not defined.
ERROR(RSC-012): epub/EPUB/text/ch001.xhtml(118,59): Fragment identifier is not defined.
ERROR(RSC-012): epub/EPUB/text/ch001.xhtml(248,25): Fragment identifier is not defined.
ERROR(RSC-012): epub/EPUB/text/ch001.xhtml(319,26): Fragment identifier is not defined.
ERROR(RSC-012): epub/EPUB/text/ch001.xhtml(322,53): Fragment identifier is not defined.
ERROR(RSC-012): epub/EPUB/text/ch001.xhtml(325,45): Fragment identifier is not defined.
ERROR(RSC-012): epub/EPUB/text/ch001.xhtml(330,52): Fragment identifier is not defined.
Check finished with errors
Messages: 0 fatals / 7 errors / 0 warnings / 0 infos
EPUBCheck completed

After extracting the epub, indeed, in the file epub/EPUB/text/ch001.xhtml, you have a few links with fragment identifier which do not exist in the ch001.xhtml file.

For example : #typescript-configuration-file-tsconfigjson

<li><a href="ch001.xhtml#configuration">Configuration</a></li>
<li><a href="#typescript-configuration-file-tsconfigjson">TypeScript Configuration File ​​tsconfig.json</a>
<ul>
<li><a href="ch001.xhtml#target">target</a></li>

I think you used the README.md file to generate the epub. However between pandoc and Github, they don't process anchor the same way. So for example, the heading Get & Set in Github is generated as get--set but pandoc generates get-set. You have other cases with special chars like . too.

Note that there is no carriage return before the ## Introduction heading too so it is not process correctly by pandoc.

However I am not sure if all this is the cause of the error on kindle side.

Improve titles capitalization in the English version.

Fix typo, "preserver" to "preserve". Visible in line 564 of the Chinese translation.

Format code snippet (line 287) in the Chinese version.

Property does not exist on type '{ x: number; }'.

I would love to turn over a Chinese version to help more developers learn how to use typescript more cleanly

can we have a pdf version? Thanks!

As your audience grows, consider adding some online experiences to help your readers. Here are my suggestions：

1. Add an online playground, you can practice while learning, practice can better deepen understanding and memory
2. Add the right navigation bar for quick location
3. Adding a bookmark feature, I want to store some difficult points in a place that can be quickly returned for easy reading back

I think it is a very good contribution and I would like to contribute with the Spanish translation, so we all could enjoy this content.
I look forward to hearing from you.
Best regards.

Some comments in the Chinese version are in English. They should be translated to Simplified Chinese.

Hello,

I hope you're doing well. I recently came across your repository. I noticed that your repository doesn't have a Persian translation, and I'm interested in contributing by adding a Persian translation if you're open to it.

As a Persian-speaking user, I believe adding a Persian translation to your repository can help the Persian-speaking developer community benefit from your project to the fullest extent.

Are you interested in the idea of adding a Persian translation to your repository? If you're open to it, I would be delighted to collaborate and provide smooth and accurate translations for you.

I'm looking forward to hearing from you. If you have any questions or requests, please let me know.

I would appreciate any contributions to translations of the book. To submit a contribution, please make a pull request, ensuring that you:

• Follow the structure outlined for the book.
• Translate comments within the code.
• Use the tools in the 'tools' folder to check for markdown formatting, TypeScript compilation of snippets, and website generation.

Thank you for your help and support on this project 🙇