@gliff-ai/eslint-config

gliff.ai eslint-config

👋 Welcome in! 👋

This repository contains the ESLint configuration that is shared for gliff.ai’s projects.

This repository aims to clearly share our ESLint configuration used in gliff.ai projects with contributors. This lint is designed to find and fix problems by analysing our JavaScript code to find problems like programming errors, bugs, stylistic errors and suspicious constructs and then can automatically fix many of the issues flagged.

❌ This repository does not accept most contributions unfortunately! However, an issue can still be raised if you recognise a problem you wish to bring to the gliff.ai teams attention. ❌

Table of Contents

Looking for something specific? 🔍

• Repository Introduction
• Table of Contents
• Access
• Development
• Linting and Formatting
• Testing
• Contribute
• Contact
• License

Access

{{back to navigation}}

Run npm install @gliff-ai/annotate in your command line to install the package from the npm registry.

To access our team's shared ESLint Config, run npm i @gliff-ai/eslint-config --save-dev and then within eslintrc.js run:

module.exports = {
  extends: [
      "@gliff-ai"
  ],
  parserOptions: {
    tsconfigRootDir: __dirname,
    project: ["./tsconfig.json"],
  },
  overrides: [
      {
          files: ["*.ts", "*.tsx"],
          rules: {}        
      }]
};

Contribute

{{back to navigation}}

This repository does not accept contributions unfortunately as content has been developed with specific gliff.ai team practises and preferences in mind. However, an issue can still be raised if you recognise a problem you wish to bring to the gliff.ai teams attention.

We do have several repositories within the gliff.ai github space that welcome all contributions and contributors on. These will be marked with the topic tag contributions-welcome meaning we welcome contributions on this repository! Search for them here!

Check out the gliff.ai Contribution Guide 👋 to learn more!

Contact

{{back to navigation}}

Need some help? 🤔 Have a question? 🧠
Reach out to the gliff.ai team at [e-mail] or on our GitHub discussions.

License

{{back to navigation}}

This code is licensed under a GNU AGPLv3 license 📝
Curious about our reasoning for this? Read about them here!