前言
在前端开发中，代码格式的规范性非常重要，不仅可以提高团队协作效率，而且可以减少开发者之间的差异性。而 TypeScript 作为一门语言，更是需要严格的代码规范。在开发过程中，我们可能会遇到代码格式不一致，不易阅读等问题，那么如何快捷地规范和美化代码呢？
本篇文章将介绍一个强大的 npm 包 @vegansk/typescript-formatter，它是一个可以自动化格式化 TypeScript 代码的工具。相较于手动修改代码来说，它更加方便、快捷、准确。下面我们将通过使用教程来详细讲解该工具的使用方法。
环境
在使用之前，需要先安装 Node.js 环境，建议选择 12.x 版本及以上。
安装
本工具是一个 npm 包，所以可以通过 npm 来安装，使用以下命令：
npm install -g @vegansk/typescript-formatter
使用
命令行使用
安装成功后，我们可以在命令行中使用该工具。以下是该工具只有一个命令：
tsfmt folder/file [options]
该命令有两个参数，第一个参数为文件路径可选文件夹，第二个参数为该命令的选项参数。
选项参数如下：
--indent_size：指定一个数值类型的缩进宽度，默认值为 2。--no-semi：表示不使用分号，默认值为 false。--single_quote：表示使用单引号， 默认值为 false。--no-use_tabs：表示使用空格而不使用 tab 缩进，默认为 false。--verify：表示只验证 TypeScript 文件而不格式化， 默认为 false。--ignore-config：表示忽略 .editorconfig 和 tslint 等配置文件，默认为 false。
例如：
tsfmt index.ts --indent_size=4 --no-semi --single_quote
表示使用 4 个空格进行缩进，不使用分号，使用单引号。
VS Code 插件
如果您使用 VS Code 编辑器，也可以直接安装该插件，安装方式如下：
- 在 VS Code 的扩展商店中搜索 "Typescript Formatter"
- 点击 "安装"
- 安装成功后，重启 VS Code。
使用该插件时，可以在 VS Code 的设置设置中设置选项参数。在 VS Code 的设置中找到“TypeScript Formatter”选项，有以下配置项：
indentSize：指定一个数值类型的缩进宽度，默认值为 2。noSemi：表示不使用分号，默认值为 false。singleQuote：表示使用单引号， 默认值为 false。useTabs：表示使用空格而不使用 tab 缩进，默认为 false。verify：表示只验证 TypeScript 文件而不格式化， 默认为 false。
例如：
"typescriptFormatter.indentSize": 4, "typescriptFormatter.noSemi": true, "typescriptFormatter.singleQuote": true
表示使用 4 个空格进行缩进，不使用分号，使用单引号。
示例代码
下面是一个 TypeScript 文件的示例代码，我们可以通过该工具自动格式化该文件：
-- -------------------- ---- -------
------ - ---------- ------ - ---- ----------------
------ - ------------ ---------- ---------- - ---- -----------------
------------
--------- ------------
------------ -------------------------
---------- ---------------------------
--
------ ----- -------------- ---------- ------ -
---------- ----------
------------------- --- ------------ --
---------- -
-------------- - ---------------
------ ---- --------------------- -------------------
--------- ---- --------------------- --------------------------
----------- --------
---
-
---------- -
----------------------------------
-
------------------ -
---------------------------
----------- ----------------------------------------
---
-
-格式化后：
-- -------------------- ---- -------
------ - ---------- ------ - ---- ----------------
------ - ------------ ---------- ---------- - ---- -----------------
------------
--------- ------------
------------ -------------------------
---------- --------------------------
--
------ ----- -------------- ---------- ------ -
---------- ----------
------------------- --- ------------ --
---------- -
-------------- - ---------------
------ ---- --------------------- -------------------
--------- ---- --------------------- --------------------------
----------- -------
---
-
---------- -
----------------------------------
-
------------------ -
---------------------------
----------- ---------------------------------------
---
-
-总结
本文介绍了 npm 包 @vegansk/typescript-formatter 的使用教程。该工具可以帮助开发者快速、精准地格式化 TypeScript 代码。我们可以在命令行中使用该工具，也可以直接在 VS Code 中安装该插件使用。相信通过本文的介绍和示例代码的演示，大家已经了解了该工具的基本使用方法，希望大家在开发过程中能够应用好该工具，避免出现代码规范性问题。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005663781e8991b448e22ce