Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/carnesen/tslint-config

TSLint configurations for @carnesen projects
https://github.com/carnesen/tslint-config

carnesen tslint tslint-config typescript

Last synced: 26 days ago
JSON representation

TSLint configurations for @carnesen projects

Host: GitHub
URL: https://github.com/carnesen/tslint-config
Owner: carnesen
License: mit
Created: 2018-09-10T20:38:31.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2020-05-20T09:27:39.000Z (over 4 years ago)
Last Synced: 2024-09-18T11:57:22.383Z (about 2 months ago)
Topics: carnesen, tslint, tslint-config, typescript
Language: TypeScript
Homepage:
Size: 22.5 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: license.txt

Awesome Lists containing this project

README

# @carnesen/tslint-config [![Build Status](https://github.com/carnesen/tslint-config/workflows/test/badge.svg)](https://github.com/carnesen/tslint-config/actions?query=workflow%3Atest+branch%3Amaster)
TSLint configurations for `@carnesen` projects

## Install

These instructions assume that you're already using TypeScript and are now just adding `tslint`.

```
npm install --save-dev tslint @carnesen/tslint-config
```

## Usage
Create a file `tslint.json` at the root of your project with contents:

```json
{
"extends": [
"@carnesen/tslint-config"
]
}
```
That tells TSLint to use the "main" export of this package, [its `tslint.json`](tslint.json) file. Add these lines to your `package.json`'s "scripts" field:
```
"lint": "tslint --project .",
"lint:fix": "npm run lint -- --fix",
```
Finally add `&& npm run lint` to your package's "test" script to make sure you don't forget to lint! I strongly recommend setting up your editor to automatically fix lint errors on save. That makes it so that the linter mostly stays out of your way. In Visual Studio Code, [this plugin](https://marketplace.visualstudio.com/items?itemName=eg2.tslint) works great.

## Rules
This package's rules extend those espoused by [by AirBnB](https://github.com/airbnb/javascript), consumed as [tslint-config-airbnb](https://www.npmjs.com/package/tslint-config-airbnb). Those rules are mostly concerned with syntax. For code formatting, this package uses [`tslint-config-prettier`](https://github.com/alexjoverm/tslint-config-prettier), which disables all rules that are unnecessary or might conflict with [Prettier](https://prettier.io/) in conjunction with [`tslint-plugin-prettier`](https://github.com/ikatyang/tslint-plugin-prettier), which "runs Prettier as a TSLint rule and reports differences as individual TSLint issues". I wrote up some thoughts [here](https://github.com/googleapis/google-cloud-node/issues/2842#issuecomment-425229710) on why that's a much better approach than using `tslint` and `prettier` separately. Finally this configuration also enables the [dtslint "expect" rule](https://github.com/Microsoft/dtslint/blob/4539c93657ea93e96eff84aa835422f6eed3e3b7/src/rules/expectRule.ts), which allows you to make type assertions that are checked at the same time as the lint rules:

```ts
// $ExpectType "foo"
'foo';

// $ExpectType string[]
['foo', 'bar', 'baz'];
```
These are a nice way of writing programmatic tests for types beyond what you can achieve with unit testing alone.

Here are some projects that make use of this one if you want to see some code looks like that adhere to these rules:
- [@carnesen/bitcoin-config](https://github.com/carnesen/bitcoin-config): Constants, utilities, and TypeScript types for bitcoin server software configuration with Node.js
- [@carnesen/cli](https://github.com/carnesen/cli): A library for building Node.js command-line interfaces
- [@carnesen/coded-error](https://github.com/carnesen/coded-error): An enhanced `Error` class with additional properties "code" and "data"

## Related
- [@carnesen/tsconfig](https://github.com/carnesen/tsconfig): TypeScript configurations for @carnesen projects

## More information
If you encounter any bugs or have any questions or feature requests, please don't hesitate to file an issue or submit a pull request on this project's repository on GitHub.

## License