Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crazyfactory/tslint-rules
tslint rules
https://github.com/crazyfactory/tslint-rules
Last synced: about 1 month ago
JSON representation
tslint rules
- Host: GitHub
- URL: https://github.com/crazyfactory/tslint-rules
- Owner: crazyfactory
- Created: 2018-10-18T10:00:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T16:01:09.000Z (about 2 years ago)
- Last Synced: 2024-10-10T23:31:08.106Z (4 months ago)
- Language: TypeScript
- Size: 997 KB
- Stars: 1
- Watchers: 10
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# tslint-rules
[](https://travis-ci.org/crazyfactory/tslint-rules)
[](https://github.com/crazyfactory/tslint-rules/issues)
[](https://codecov.io/gh/crazyfactory/tslint-rules)
[](https://david-dm.org/crazyfactory/tslint-rules?type=dev)
[](https://david-dm.org/crazyfactory/tslint-rules)
Contains lint rules for Crazy Factory
- Typescript 3.x
- packs it for npm usage
- uses jest for testing
- uses travis and semantic-release for deployment
- uses linting, coverage and git hooks to increase code quality.
- is configured to support wallaby
## Usage
Initially you should:
- npm install `@crazyfactory/tslint-rules`
- update `tslint.json` (add rules directory)
- enable rules in `tslint.json`
## Rules
### `create-async-actions`
- In [ts-react-boilerplate](https://github.com/crazyfactory/ts-react-boilerplate), we use `createAsyncActions` to
create Redux async actions. Four actions are created from calling it - `BASE`, `BASE_PENDING`, `BASE_FULFILLED`, and
`BASE_REJECTED` as an example when `createAsyncActions("BASE", "BASE_PENDING", "BASE_FULFILLED", "BASE_REJECTED"` is
called. Still, as you see, we need to provide string literal as arugments due to typescript limitation, if we provide
any string variable, the type will be deduced to just `string`. This rule enforces 2nd, 3rd, and 4th argument to be
the concatenation of the first argument string and `_PENDING`, `_FULFILLED`, and `_REJECTED` respectively.
### `enum-sort-keys`
- Same as [object-literal-sort-keys](https://palantir.github.io/tslint/rules/object-literal-sort-keys/) but applied to
enum keys
### `import-react`
- Specify how you should import `react`. Either `import *` or `import React`.
- Rule options:
- `type: "default" | "star"`. Default is `star`
### `hex-format`
- Requires literal string in hex format to be uppercase/lowercase and/or of specific lengths.
- Rule options:
- `case: "uppercase" | "lowercase"`. Default is `lowercase`
- `allowedLengths: number[]`. Default is `[4, 7]`
### `interface-sort-keys`
- Please use [member-ordering](https://palantir.github.io/tslint/rules/member-ordering/) instead!
### `jsx-space-before-trailing-slash`
- Requires or bans space before `/>` part of jsx.
- Rule options:
- `["always", "never"]`. Default is `always`.
### `language`
- Requires that string argument called by `Translator` object is in the `reference.json`
- Rule options:
- `path`: path to `reference.json`
`reference.json` needs to be in the following format:
```
{
"reference": [
{
"base": "Translation String Here"
}
]
}
```
- `callerNames: string[]`: Name of translator object type, default is `["Translator"]`
### `no-dup-actions`
- Requires that all actions created by [createAsyncActions](https://github.com/crazyfactory/ts-react-boilerplate/blob/master/src/app/redux/modules/baseModule.ts)
and [createAction](https://github.com/piotrwitek/typesafe-actions#createaction) have unique name.