https://github.com/bytpher/tslint-ns-core

Recommended tslint configuration for NativeScript Core applications.
https://github.com/bytpher/tslint-ns-core

husky nativescript prettier tslint tyescript

Last synced: 1 day ago
JSON representation

Recommended tslint configuration for NativeScript Core applications.

• Host: GitHub
• URL: https://github.com/bytpher/tslint-ns-core
• Owner: bytpher
• Created: 2020-03-30T18:08:02.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T16:33:44.000Z (about 2 years ago)
• Last Synced: 2024-12-14T05:39:00.578Z (25 days ago)
• Topics: husky, nativescript, prettier, tslint, tyescript
• Size: 2.11 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# TSLint NativeScript Core 

Recommended tslint configuration for NativeScript Core applications.

## Requirements

This package works with prettier for an quick and easy code format

```bash

npm i -D prettier prettier-tslint pretty-quick

```

Packages:

* [prettier](https://github.com/prettier/prettier): Prettier is an opinionated code formatter

* [prettier-tslint](https://github.com/azz/prettier-tslint): Formats your TypeScript using `prettier` followed by `tslint --fix``

* [pretty-quick](https://github.com/azz/pretty-quick): Runs Prettier on your changed files.

## Installation

```bash

npm i -D @bytpher/tslint-ns-core

```

## Usage 

```json

{

  "extends": ["@bytpher/tslint-ns-core"]

}

```

## Pre-Commit Hook

You can use [husky](https://github.com/typicode/husky) to configure a pre-commit hook to run [pretty-quick](https://github.com/azz/pretty-quick)

```bash

npm i -D husky

```

Create a `.huskyrc.json` in the root of yor project and add the following configuration

```json

{

  "hooks": {

    "pre-commit": "pretty-quick --staged"

  }

}

```

This configuration will run [pretty-quick](https://github.com/azz/pretty-quick) before each commit and formatting the staged files allowing us a seamless code format between all developers working in the project