The gts (Google TypeScript Style) npm package is a toolkit for setting up and maintaining a consistent TypeScript code style in your projects. It includes configurations for TypeScript, ESLint, and Prettier, and provides scripts for formatting and linting your code.
Setup
Initializes a new TypeScript project with Google TypeScript Style configurations. This command sets up the necessary configuration files and dependencies.
npx gts initLinting
Runs ESLint with the Google TypeScript Style configurations to check for code style issues and potential errors in your TypeScript code.
npx gts lintFormatting
Formats your TypeScript code according to the Google TypeScript Style guidelines using Prettier. This command can also fix some linting issues automatically.
npx gts fixTypeScript Compilation
Compiles your TypeScript code to JavaScript using the TypeScript compiler with the configurations provided by gts.
npx gts buildESLint is a widely-used tool for identifying and fixing problems in JavaScript and TypeScript code. While gts uses ESLint under the hood, ESLint itself is more flexible and can be configured to use various style guides and rulesets.
Prettier is an opinionated code formatter that supports many languages, including TypeScript. gts uses Prettier for formatting, but Prettier can be used independently or with other style guides.
TSLint is a linter specifically for TypeScript. Although it has been deprecated in favor of ESLint, it was previously a popular choice for TypeScript projects. gts uses ESLint, which is now the recommended tool for linting TypeScript.
typescript-eslint is a set of tools that allows ESLint to run on TypeScript code. It provides the necessary parser and plugins to lint TypeScript effectively. gts uses typescript-eslint as part of its setup.
Google TypeScript Style
gts is Google's TypeScript style guide, and the configuration for our formatter, linter, and automatic code fixer. No lint rules to edit, no configuration to update, no more bike shedding over syntax.
To borrow from standardjs:
gts fix and say goodbye to messy or inconsistent code.Under the covers, we use tslint to enforce the style guide and provide automated fixes, and prettier to re-format code.
The easiest way to get started is to run:
npx gts init
When you run the npx gts init command, it's going to do a few things for you:
tsconfig.json file to your project that uses the Google TypeScript Style.package.json.package.json:
check: Lints and checks for formatting problems.fix: Automatically fixes formatting and linting problems (if possible).clean: Removes output files.compile: Compiles the source code using TypeScript compiler.pretest, posttest and prepare: convenience integrations.The commands above will all run in the scope of the current folder. Some commands can be run on individual files:
gts check index.ts
gts check one.ts two.ts three.ts
gts check *.ts
Show your love for gts and include a badge!
[](https://github.com/google/gts)
Made with ❤️ by the Google Node.js team.
NOTE: This is not an official Google product.
FAQs
Google TypeScript Style
The npm package gts receives a total of 116,946 weekly downloads. As such, gts popularity was classified as popular.
We found that gts demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.