npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tslint-config-kata

v1.1.3

Published

TSLint config used at Kata.ai

Downloads

33

Readme

tslint-config-kata

TSLint config used at Kata.ai

This is the common TSLint config used by projects at Kata.ai. All TSLint rules follow the Kata Platform Development Standard.

Installation

Install tslint and tslint-config-kata using your favourite package manager:

# yarn
yarn add --dev tslint tslint-config-kata
# npm
npm install --save-dev tslint tslint-config-kata

Then, on your tslint.json file, extend tslint-config-kata.

{
  "extends": ["tslint-config-kata"]
}

If you're using this TSLint config for React-based projects, extend tslint-config-kata/react instead.

{
  "extends": ["tslint-config-kata/react"]
}

For more setups, take a look at the templates directory

Versioning

Note that this package does not specifically follow Semantic Versioning, since all changes in this package are relative to the changes in our Development Standard. Major version bumps will occur when we transition into a new major version of TSLint.

To recap:

  • major: Will be bumped when we transition to a new major version of TSLint
  • minor: Potentially breaking changes that's still within the same major version of TSLint
  • patch: Minor patches/bugfixes

Using Prettier

Prettier is a tool to automatically format your code during save. It supports various editors, from VSCode, Atom, Sublime, and even Emacs.

To use this TSLint config in conjunction with Prettier, copy the .prettierrc file in this repository and paste it to your project.

Then install the Prettier TSLint config and plugin:

$ yarn add --dev tslint-plugin-prettier tslint-config-prettier prettier

And finally, include them as follows. (IMPORTANT: tslint-config-prettier MUST be extended last in the extends array!)

{
  "rulesDirectory": ["tslint-plugin-prettier"],
  "extends": ["tslint-config-kata", "tslint-config-prettier"],
  "linterOptions": {
    "exclude": ["node_modules/**"]
  },
  "rules": {
    "prettier": true
  }
}

Contributing

Issues and Pull Requests welcome! Please read the Contributing Guidelines beforehand.

License

MIT (c) 2018 Kata.ai.

Maintainers