4.0.1 (2023-01-09)

Bug Fixes

• deps: bump json5 from 2.2.1 to 2.2.2 addressing CVE-2022-46175 (2a1fd61)

4.0.0 (2022-07-04)

⚠ BREAKING CHANGES

• drop support for node.js 10.x (#686)

Features

• generate .editorconfig (#500) (81397e0)

Bug Fixes

• deps: update dependency eslint-config-prettier to v8 (#624) (23a4abb)
• deps: update dependency eslint-plugin-prettier to v4 (#657) (5408bfe)
• deps: update dependency prettier to ~2.5.0 (#660) (8789fd4)
• deps: update dependency prettier to ~2.6.0 (#670) (2feba2c)
• deps: update dependency prettier to ~2.7.0 (#696) (3c677fd)
• deps: update dependency write-file-atomic to v4 (#687) (f16a3e1)
• deps: update typescript-eslint monorepo to v5 (#688) (ed2fd0c)
• deps: upgrade to eslint 8.x (#693) (7ae5c8b)
• drop update notifier (#706) (cab7704)
• pin prettier to 2.3.x (#641) (323fb4a)

Build System

• drop support for node.js 10.x (#686) (12cd913)

Features

• support comments in JSON (#571) (cb6d2ca)

Bug Fixes

• deps: update dependency eslint-config-prettier to v7 (#601) (6e26681)
• deps: upgrade to latest version of meow (#616) (634bad9)

Bug Fixes

• deps: update dependency execa to v5 (#600) (4e5f1e5)
• deps: update dependency meow to v8 (#591) (c7e223e)

Bug Fixes

• deps: loosen ts peer dependency (#589) (8f1d381)

Bug Fixes

• rule: turn off @typescript-eslint/no-var-requires (#578) (3b37229)

⚠ BREAKING CHANGES

• change default check to lint (#570)
• deps: require TypeScript 4.x (#565)

Features

• Add TypeScript v4 support (#551) (0883956)
• change default check to lint (#570) (c527b66)
• generate .eslintignore when running init (#521) (8bce036)

Bug Fixes

• add build/.eslintrc.json to files field (#553) (3b516ad)
• deps: require TypeScript 4.x (#565) (cbc5267)
• deps: update dependency update-notifier to v5 (#574) (9a882bf)
• deps: update typescript-eslint monorepo to v2.34.0 (#509) (998a4ac)
• deps: update typescript-eslint monorepo to v3 (major) (#528) (e22e173)
• deps: update typescript-eslint monorepo to v4 (#556) (54148df)
• better error message for broken tsconfig.json (#501) (0c17a76)
• prohibit calls for it.only and describe.only (#499) (071c33c)

Bug Fixes

• Revert 'update dependency eslint to v7'" (#507) (0f9950b)
• deps: pin release of eslint-typescript (#508) (bd86b42)
• deps: update dependency eslint to v7 (#504) (6aee159)

Bug Fixes

• throw an error if running with an unsupported version of nodejs (#493) (94fdf1e)
• deps: update dependency meow to v7 (#502) (cf91cda)

⚠ BREAKING CHANGES ⚠

This is a major rewrite of the tool. Based on community guidance, we've switched from using tslint to eslint. Please read all of the steps below to upgrade.

Configuring eslint

With the shift to eslint, gts now will format and lint JavaScript as well as TypeScript. Upgrading will require a number of manual steps. To format JavaScript and TypeScript, you can run:

$ npx gts fix

To specify only TypeScript:

$ npx gts fix '**/*.ts'

Delete tslint.json

This file is no longer used, and can lead to confusion.

Create a .eslintrc.json

Now that we're using eslint, you need to extend the eslint configuration baked into the module. Create a new file named .eslintrc.json, and paste the following:

{
  "extends": "./node_modules/gts"
}

Create a .eslintignore

The .eslintignore file lets you ignore specific directories. This tool now lints and formats JavaScript, so it's really important to ignore your build directory! Here is an example of a .eslintignore file:

**/node_modules
build/

Create a .prettierrc.js

The formatting rules in gts need to be extended. Create a file named .prettierrc.js, and add the following:

module.exports = {
  ...require('gts/.prettierrc.json')
}

Rule changes

The underlying linter was changed, so naturally there are going to be a variety of rule changes along the way. To see the full list, check out .eslintrc.json.

Require Node.js 10.x and up

Node.js 8.x is now end of life - this module now requires Ndoe.js 10.x and up.

Features

• add the eol-last rule (#425) (50ebd4d)
• allow eslintrc to run over tsx files (#469) (a21db94)
• disable global rule for checking TODO comments (#459) (96aa84a)
• override require-atomic-updates (#468) (8105c93)
• prefer single quotes if possible (#475) (39a2705)
• use eslint instead of tslint (#400) (b3096fb)

Bug Fixes

• use .prettierrc.js (#437) (06efa84)
• deps: update dependency chalk to v4 (#477) (061d64e)
• deps: update dependency eslint-plugin-node to v11 (#426) (a394b7c)
• deps: update dependency execa to v4 (#427) (f42ef36)
• deps: update dependency prettier to v2 (#464) (20ef43d)
• disable no-use-before-define (#431) (dea2c22)
• deps: update dependency update-notifier to v4 (#403) (57393b7)
• deps: upgrade to meow 6.x (#423) (8f93d00)
• align back to the google style guide (#440) (8bd78c4)
• disable empty-function check (#467) (6455d7a)
• drop support for node 8 (#422) (888c686)
• emit .prettierrc.js with init (#462) (b114614)
• enable trailing comma (#470) (6518f58)
• include *.tsx and *.jsx in default fix command (#473) (0509780)