otacke/eslint-config-snordian-h5p

SNORDIAN's eslint config for H5P projects following H5P the style guide

SNORDIAN's Common ESLint config for H5P projects

H5P Group provides a set of coding guidelines. Unfortunately, they do not provide a general ESLint configuration themselves, but they use per repository configurations.

This is the common ESLint configuration based on those per repository configurations that helps to follow that guidelines. It also adds some rules which are not clearly specified by H5P Group, but that feel reasonable to have. In turn, this set of rules is even stricter than what H5P Group demands.

Requirements

You need to use ESLint 9 or later with flat config.

Usage

1. Assuming you are using npm, install the module with

npm install github:otacke/eslint-config-snordian-h5p

2. Assuming that you are using ECMA script modules, setting up a file eslint.config.js with

import eslintConfigSnordianH5P from 'eslint-config-snordian-h5p';

export default [eslintConfigSnordianH5P.configs['flat/recommended']];

should do the job. If you need to tweak the settings: Beware, I may not have fully understood flat config yet and may not have implemented everything to work as required.

3. Assuming you have a dedicated source (src) directory, do your linting with something such as

npx eslint './src/**/*.js'

Notes

I am not uploading this to npm, because I still have not lost hope that H5P Group itself is going to release such a configuration one day. Don't want to make them say "Nah, there's no need, there's already something out there, and we gladly let that person have responsibility for maintaining this."