ESLint Configs for Glints

This repository contains shared rules for ESLint.

It is used across many of our internal and external projects.

Usage Instructions

To integrate this into your project, install the package:

npm install --save-dev @glints/eslint-config  # If using npm
yarn add --dev @glints/eslint-config          # If using Yarn

Then add the following to your ESLint configuration:

"extends": [
  "@glints/eslint-config",

  // Rules below are for projects that use React/JSX.
  "@glints/eslint-config/react",
  "@glints/eslint-config/jsx-control-statements"
]

For TypeScript support, add the following rules:

"overrides": {
  "files": ["**/*.ts", "**/*.tsx"],
  "extends": ["@glints/eslint-config/typescript"]
}

Contribution Guidelines

Please do not bump version before your changes have been merged into the master branch. Also, please do not push git tags on this repo for commits that have not been merged to master yet, pushing these tags would cause an un-intended release to the NPM registry. Version bumps are supposed to be a shared global entity.

Refer to this link for documentation about sharable configurations and rules.

Before modifying the rules, please notify the codebase owners because it may impact many downstream projects.

We use EditorConfig to maintain consistent line-ending and indentation rules across all our projects. Ensure that you have the appropriate plugin installed in your preferred editor, or refer to .editorconfig.

About Glints

Glints is an online talent recruitment and career discovery platform headquartered in Singapore. It is a platform for young talent to build up their career readiness through internships and graduate jobs; developing skill sets required in different careers.

P.S. We deal with quite a number of interesting engineering problems centered on matching the right talent to employers. Sounds interesting? Send your resume to [email protected].