eslint-plugin-jsx-a11y VS javascript

I try to focus on the issues rather than individuals, but the root of the problems in the listed eslint plugin libraries points to ljharb.

If you do some simple digging into these libraries, you will find that these types of commits are quite common within them.

https://github.com/jsx-eslint/eslint-plugin-react/commit/e1d...

https://github.com/jsx-eslint/jsx-ast-utils/commit/bad51d062...

https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/commit/...

He would rather see the download count of these polyfill libraries https://github.com/ljharb/ljharb#projects-i-maintain increase, compared to assessing the health of the JavaScript ecosystem.

jsx-a11y is all about ensuring your DOM elements are accessible. This plugin will prompt you to include the correct ARIA attributes such as labels and roles, in addition to things like alt text.

You can also add ESLint now (props to @femincan for the suggestion). It comes with recommended settings for these plugins: typescript, prettier, react, react-hooks, jsx-a11y.

WAI-ARIA is important if you are writing custom components and do not follow the general rules for HTML tags. For example, if you are using a `div` as a button, you would need to add tags for accessibility. Yes, there are some other instances, like adding alt text to images or adding a title to an iframe, but these can all be handled with warnings in the editor using the jsx-a11y eslint plugin. Some other nuance will be up to the developer to make sure they follow the proper accessibility structure, but most use cases are outlined in the Daisy UI tailwind examples, they do a great job of using HTML properly and give fully accessible examples for their components. Take a look at the accordion example, you can tab into the accordion and use the arrow keys to navigate.

jsx-a11 (ESLint plugin) checks a couple other things.

When using react, I've been using the recommended rules from eslint-plugin-jsx-a11y. Am I naive for relying a lot on that to get a11y right? Of course I try to write semantic html too and do research for each topic, but it's a bit overwhelming and I feel like the eslint rules help me a lot.

I found the documentation but no solution here: https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/label-has-associated-control.md

eslint-plugin-jsx-a11y: Checks for accessiblity issues.

For example, Deque's open-source Axe project can help identify issues such as common HTML semantic errors, contrast problems, and more. There are even libraries that help integrate Axe into your project's linters, such as one for React called eslint-plugin-jsx-a11y.

// Follow Established Style Guides // Adhere to established style guides such as Airbnb JavaScript Style Guide or Google JavaScript Style Guide to maintain consistency across your codebase. // These style guides provide comprehensive rules and recommendations for variable naming, declaration, and usage. // Example: Airbnb JavaScript Style Guide // https://github.com/airbnb/javascript /** * Represents a person with a given name and age. * @typedef {Object} Person * @property {string} name - The name of the person. * @property {number} age - The age of the person. */ /** * Create a new person. * @param {string} name - The name of the person. * @param {number} age - The age of the person. * @returns {Person} - The newly created person object. */ function createPerson(name, age) { return { name, age }; } const person1 = createPerson("John", 30); const person2 = createPerson("Jane", 25); console.log(person1); console.log(person2);

Repository: airbnb/javascript

Instead of writing our own exhaustive list of JavaScript rules, we can use a ruleset defined by the developers at Airbnb, and then adjust it to suit our preferences. The Airbnb JavaScript Style Guide is well known among JavaScript developers and used by some big companies: Lonely Planet, National Geographic and Sainsburys to name a few. It’s a great place to start.

Airbnb Style Guide

# question 1: ? How would you like to use ESLint? … To check syntax only To check syntax and find problems ❯ To check syntax, find problems, and enforce code style # question 2: ? What type of modules does your project use? … ❯ JavaScript modules (import/export) CommonJS (require/exports) None of these # question 3: ? Which framework does your project use? … ❯ React Vue.js None of these # question 4 (select "No", because we won't add TypeScript support for this project): ? Does your project use TypeScript? › No / Yes # question 5: ? Where does your code run? … Browser ✔ Node # question 6: ? How would you like to define a style for your project? … ❯ Use a popular style guide Answer questions about your style Inspect your JavaScript file(s) # question 7 (we'll rely on Airbnb's JavaScript style guide here): ? Which style guide do you want to follow? … ❯ Airbnb: https://github.com/airbnb/javascript Standard: https://github.com/standard/standard Google: https://github.com/google/eslint-config-google # question 8: ? What format do you want your config file to be in? … JavaScript YAML ❯ JSON # the final prompt here is where eslint will ask you if you want to install all the necessary dependencies. Select "Yes" and hit enter: Checking peerDependencies of eslint-config-airbnb@latest The config that you have selected requires the following dependencies: eslint-plugin-react@^7.21.5 eslint-config-airbnb@latest eslint@^5.16.0 || ^6.8.0 || ^7.2.0 eslint-plugin-import@^2.22.1 eslint-plugin-jsx-a11y@^6.4.1 eslint-plugin-react-hooks@^4 || ^3 || ^2.3.0 || ^1.7.0 ? Would you like to install them now with npm? › No / Yes

Extensible : ESLint supports the use of plugins and custom rules, enabling you to extend its functionality to suit your project requirements. Notably, there are popular ESLint plugins that align with well-established coding standards and styles. Examples include Airbnb JS Style Guide and Google JS Style Guide.

An obvious pick for React projects, but eslint-plugin-react along with their plugin:react/recommended rule set is a must. This will give you some sensible rules such as requiring a key to be specified in JSX arrays. eslint-config-airbnb is another good (if a bit loose) base rule set on top of eslint-plugin-react to start from.