mozilla / eslint-config-amo

Shared eslint config for all amo related js projects

eslint-config-amo

Shared eslint config for all amo related JS projects.

Versioning

This project follows the semantic versioning specification.

In order to release a new version, please follow these steps:

1. Make sure your local master branch is up-to-date.

2. Run the following command from the master branch to (1) bump the version accordingly and (2) create a commit and a tag for the release:

   npm version minor
   

   Note: change minor to patch or major depending on the release (but minor is the most frequent).

3. Push to the main repository (denoted upstream below):

   git push upstream master --tag
   

4. Create a GitHub Release for the new tag: https://github.com/mozilla/eslint-config-amo/releases (you can either select the tag itself or create a new "draft"). Please add a short description of the changes (see the other releases for inspiration).

eslint-config-amo's Issues

Add no-trailing-spaces rule

https://eslint.org/docs/rules/no-trailing-spaces

Most people have their editors configured to auto-strip whitespace but if one person doesn't, the next person will auto-strip the whitespace 🤔 It also creates confusing diffs because it's not obvious what happened -- i.e. you can't see any changes.

Disable ESLint rule `react/sort-comp`

See: mozilla/addons-frontend#5357

Prevent unnamed functions for better debugging

Unnamed functions make certain types of debugging harder (like profiling). It would be nice to avoid them.

This rule looks like it will enforce named arrow functions: https://github.com/getify/eslint-plugin-proper-arrows

This looks like it will enforced named function functions: https://eslint.org/docs/rules/func-names

I haven't tested either one.

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Add a rule to prevent static import of (already) dynamically imported files

See also: mozilla/addons-frontend#7017 (comment)

---

The idea is to avoid referencing code from a dynamically (code-splitted) imported file so that we don't impact the main bundle.

Maybe there is a plugin that exists already, and if that suits our needs, then no need to write a rule. We can adopt the plugin in addons-frontend directly.

Require space after async keyword before arrow functions

We want code like this:

async () => {}

To be allowed.

Wiki changes

FYI: The following changes were made to this repository's wiki:

• defacing spam has been removed

• Restricting write access to contributors is strongly encouraged. Please make that change (documentation).

These were made as the result of a recent automated defacement of publically writeable wikis.

Back out the change for @typescript-eslint/camelcase

It turns out that there's a new version of typescript-eslint which removes the @typescript-eslint/camelcase rule and therefore we should remove the override here as well. With typescript-eslint v3.0 this will cause errors.

Please add a LICENSE to this repository.

Typically MPL2 for code is encouraged, but whatever you think is best is fine. (Or, if this is not intended to be an open repository, making it private is also acceptable.)

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• Lock file maintenance

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update Node.js to v19

Detected dependencies

circleci

.circleci/config.yml

• cimg/node 14.21
• cimg/node 16.19

npm

package.json

• eslint-config-airbnb 19.0.4
• eslint-config-airbnb-base 15.0.0
• eslint-config-prettier 8.6.0
• eslint-plugin-import 2.26.0
• eslint-plugin-jest 27.2.0
• eslint-plugin-jsx-a11y 6.6.1
• eslint-plugin-prettier 4.2.1
• eslint-plugin-react 7.31.11
• eslint-plugin-react-hooks 4.6.0
• eslint ^8.0.0
• jest ^29.0.0
• prettier ^2.2.1
• eslint ^8.0.0
• jest ^29.0.0
• prettier ^2.2.1

---

• Check this box to trigger a request for Renovate to run again on this repository

Please use Dependabot instead of Renovate

We want to use Dependabot consistently across all our (add-ons) repos. Please update the config to use Dependabot instead of Renovate. You may also want to remove the Renovate config and its GitHub integration. Thanks!

Add semi-colon rules

We always want semi-colons at the end of the line (not the beginning, etc). https://eslint.org/docs/rules/semi

Setup greenkeeper

Requires fixing #2 first

Config should allow template literals in strings.

Currently a line like:

const quotes = `We could almost call it "music" but it's not`;

Will error since it wants single quotes. We should allow template literals too.

Travis CI free usage ends Dec 3; mozilla repos should switch to other CI platforms

We're opening this issue because your project has used Travis CI within the last 6 months. If you have already migrated off it, you can close and ignore this issue.

Travis CI is ending free builds on public repositories. travis-ci.com stopped providingthem in early November, and travis-ci.org will stop after December 31, 2020. To avoid disruptions to your workflows, you must migrate to another CI service.

For production use cases, we recommend switching to CircleCI. This service is already widely used within Mozilla. There is a guide to migrating from Travis CI to CircleCI available here.

For non production use cases, we recommend either CircleCI or Github Actions. There is a guide to migrating from Travis CI to Github Actions available here. Github Actions usage within Mozilla is new, and you will have to work with our github administrators to enable specific actions following this process.

If you have any questions, reach out in #github-admin:mozilla.org on matrix.

Investigate configuring sort-imports

See http://eslint.org/docs/rules/sort-imports

We already arrange imports in groups we could go further and have a rule for sorting imports.

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

• engines was only updated if it defined a single version, not a range.
• .nvmrc was updated to Node.js 10
• .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Setup basic tests

This should ideally run some basic tests to make sure the config doesn't get broken by modifications. This is also needed as pre-cursor to running greenkeeper on this repo.

Give access to add-ons developers

I don't have write access to this repo but I should; I assume that goes for other Mozilla add-on devs as well. Please add us peons!

Allow for... of syntax

Based on the comment at mozilla/addons-frontend#4354 (comment), we should update the eslint configuration to allow for... of syntax.

Add no-dupe-class-members

https://eslint.org/docs/rules/no-dupe-class-members

I noticed a duplicate class member on addons-frontend. It was actually a duplicate definition of static defaultProps so I'm not sure if it's covered by this rule or not.

Rename to "addons"

AMO is a weird, Mozilla-internal designation that is weird and won't make sense to lots of other folks. We don't even call the repos using this "AMO" anymore, it's just a word we say out loud to each other that has crept into our brains as normal when it's really not. 😅

I know this ruleset is only used by projects largely staffed by Mozilla where we know what "AMO" means but we should rename this to "mozilla-addons" or something like that. It will make the eslint configs that extend it read much nicer than they currently do.

Sure it'll mean an npm/yarn package name change but that's fine the old one will always exist. After 0.1.0 or something it should be eslint-config-addons.

Update NPM tokens

A disabled test should be an error

This should be error not warn:

eslint-config-amo/index.js

Line 88 in 82a97e5

'jest/no-disabled-tests': 'warn',

A test gets disabled in jest by adding skip to it, like describe.skip(...). I can't think of why anyone would need to commit code like this so it should be an error. This will prevent accidental commits since not everyone reads the lint warnings.

Build on npm

Build this as a package on npm

Disable no-await-in-loop rule

This is a followup from mozilla/addons-frontend#4534 (comment).

This is something we inherit from eslint-config-airbnb-base but which we do not want to enforce. We need to override this rule in our own config.

Disable camelcase rule

We need to disable the base camelcase rule if we want our projects to ignore the rule.

Disable `@typescript-eslint/camelcase` rule

Moved from mozilla/addons-code-manager#1353

Let's disable @typescript-eslint/camelcase, it adds very little value and it is annoying because we always have to disable it anyway.

Support eslint 4

Because of the version of airbnb config we're using we get this error using eslint 4: Unexpected top-level property "ecmaFeatures".

Seems like they're working on support: airbnb/javascript#1447.

Seems there isn't anything in our config that will break it.