Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

eslint-config-zillow-typescript

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-config-zillow-typescript

Zillow's ESLint config for TypeScript, following our code conventions

  • 1.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
29
decreased by-35.56%
Maintainers
1
Weekly downloads
 
Created
Source

eslint-config-zillow-typescript

Zillow's ESLint config for TypeScript, following our code conventions

npm version Build Status

Usage

Note: Unlike other Zillow eslint config plugins, this module is designed to be used in tandem with another extended config such as eslint-config-zillow.

To install with all necessary peerDependencies, use install-peerdeps:

npx install-peerdeps --dev eslint-config-zillow eslint-config-zillow-typescript

All exported configs should be added to your ESlint configuration file extends. For example, in a JSON .eslintrc:

{
  "extends": ["zillow", "zillow-typescript"]
}

Project Config

All flavors of this config expect your tsconfig.json to be in the current working directory (relative to your eslint config), which is extremely common. If it is elsewhere (say, a monorepo leaf), you will need to override various parserOptions:

// .eslintrc.js
module.exports = {
  extends: ['zillow', 'zillow-typescript'],
  parserOptions: {
    tsconfigRootDir: __dirname,
    project: ['./tsconfig.eslint.json', './packages/*/tsconfig.json'],
  },
};

prettier Editor Plugin Integration

Unfortunately, super-useful editor plugins like prettier-atom and prettier-vscode do not load Prettier settings from ESLint config, which is where we load our Prettier options from. To workaround this, add a .prettierrc.js or prettier.config.js file to your repo root with the following content:

module.exports = require('prettier-config-zillow');

Development

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?

You can run tests (from the repo root) with npm test.

You can make sure this module lints with itself using npm run lint (from the repo root).

Keywords

FAQs

Package last updated on 30 Sep 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc