@urbandoor/lint v0.0.7

UrbanDoor Web Syle Guide (@urbandoor/lint)

An opinionated approach to TypeScript

Install

npm install --save-dev @urbandoor/lint

Usage

Add @urbandoor/lint to your tslint.json.

{
  "extends": ["@urbandoor/lint"]
}

Roadmap

• generate TOC for README during build-and-deploy
• rewrite using yaml so we can add comments
• use gatsby to generate a documentation site from yaml
• wireup netlify to host documentation site
• update to latest set of rules
• wireup dependabot
• wireup probot to remind us to check for new rules on dependabot PRs
• wireup semantic release (use server repo and web-app repo to check for breaking changes)
• add custom rules
  • format code comments
  • one of disallow getters for component snippets or require getters for component snippets
• Improve the completed-docs rule to
  1. exclude React lifecycle methods
  2. exclude any X.Props type or namespace where X is React Component class
• Pull in eslint rules for typescript (specifically, eslint-plugin-jsx-a11y and eslint-plugin-react) and provide eslint instructions
• pull in prettier
• move to monorepo with packages for e.g:
  • @urbandoor/eslint-config
  • @urbandoor/tslint-config
  • @urbandoor/prettier
  • each of our custom tslint rules
• Provide instructions on using tslint-language-server
• use "warning"/"error" instead of true/false

Contribute

Pull Requests are welcome, but please start with an issue before proposing a change that's more than a few lines.

License

MIT © Urbandoor Inc. 2018 until at least now