This package contains an ESLint shareable config that is used by Etherpad and Etherpad plugins in the https://github.com/ether namespace. You are encouraged to use it for your own Etherpad plugins so that your code stays consistent with the Etherpad codebase.
etherpad
: Base config containing settings that are common to all files.etherpad/node
: Extendsetherpad
for code that runs in Node.js.etherpad/browser
: Extendsetherpad
for code that runs in the browser.etherpad/tests
: Extendsetherpad
for test code.etherpad/tests/backend
: Extendsetherpad/node
andetherpad/tests
for backend test code.etherpad/tests/cypress
: Extendsetherpad/node
andetherpad/tests
for Cypress test code.etherpad/tests/frontend
: Extendsetherpad/browser
andetherpad/tests
for frontend test code.etherpad/plugin
: Applies the above configs to the appropriate files. Assumes the plugin follows the typical file layout.
-
Install the shareable config and its dependencies:
npm install --save-dev eslint eslint-config-etherpad typescript
-
Create a
.eslintrc.cjs
in your project's root directory:'use strict'; // This is a workaround for https://github.com/eslint/eslint/issues/3458 require('eslint-config-etherpad/patch/modern-module-resolution'); module.exports = { root: true, extends: 'etherpad/plugin', };
-
If you
require('ep_etherpad-lite/*')
anywhere in your server-side code, add a peer dependency to yourpackage.json
so that then
ESLint plugin (for Node.js) won't complain about unavailable modules:"peerDependencies": { "ep_etherpad-lite": ">=1.8.6" },
Adding an entry to
peerDependencies
does not causenpm install
to install that peer dependency; you must manually install it yourself:npm install --no-save ep_etherpad-lite@file:/path/to/etherpad-lite/src
The above command creates a symlink at
node_modules/ep_etherpad-lite
that points to/path/to/etherpad-lite/src
. Unfortunately,npm
automatically deletes that symlink whenever you runnpm install
to install, add, or update a regular dependency, so remember to re-run the above command each time you runnpm install
. -
Optional but recommended: Define a
lint
script in yourpackage.json
so that you can runnpm run lint
to check the code:"scripts": { "lint": "eslint ." },
-
Optional but recommended: Specify the minimum version of Node.js you support (ideally this would match Etherpad's minimum required version) so that the
n
ESLint plugin (for Node.js) can warn you when you use incompatible features:"engines": { "node": ">=12.17.0" },
-
Apply automatic fixes. If you added the optional
lint
script topackage.json
, you can run:npm run lint -- --fix
Or you can run:
npx eslint --fix .
If you need to tune the configs, you can specify
overrides
in your .eslintrc.cjs
. For example:
'use strict';
// This is a workaround for https://github.com/eslint/eslint/issues/3458
require('eslint-config-etherpad/patch/modern-module-resolution');
module.exports = {
root: true,
extends: 'etherpad/plugin',
overrides: [
{
files: ['static/js/shared/**/*'],
env: {
shared-node-browser: true,
},
extends: 'etherpad/node',
},
],
};
Copyright © 2020 Richard Hansen [email protected]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.