@remcohaszing/eslint 11.0.0

package/LICENSE.md

@@ -0,0 +1,18 @@
+# MIT License
+
+Copyright © 2019 Remco Haszing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the “Software”), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,134 @@
+# @remcohaszing/eslint
+
+> A strict ESLint configuration
+
+[![build status](https://github.com/remcohaszing/@remcohaszing/eslint/workflows/ci/badge.svg)](https://github.com/remcohaszing/@remcohaszing/eslint/actions)
+[![codecov](https://codecov.io/gh/remcohaszing/@remcohaszing/eslint/branch/main/graph/badge.svg)](https://codecov.io/gh/remcohaszing/@remcohaszing/eslint)
+[![npm](https://img.shields.io/npm/v/@remcohaszing/eslint)](https://www.npmjs.com/package/@remcohaszing/eslint)
+[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
+
+This is a strict shareable ESLint configuration. All ESLint core rules and a variety of ESLint
+plugins have been carefully considered. Overrides are used to apply rules based on context.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+  - [TypeScript](#typescript)
+  - [Markdown](#markdown)
+  - [Disabling rules](#disabling-rules)
+- [Ignored files](#ignored-files)
+- [Warnings](#warnings)
+- [Compatibility](#compatibility)
+- [License](#license)
+
+## Installation
+
+Install `@remcohaszing/eslint` using `npm`.
+
+```sh
+npm install --save-dev \
+  eslint \
+  @remcohaszing/eslint \
+  prettier
+```
+
+## Configuration
+
+First [configure Prettier](https://prettier.io/docs/en/configuration.html). For example, create a
+`.editorconfig` with the following content:
+
+```ini
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 100
+trim_trailing_whitespace = true
+```
+
+And create a `.prettierrc.yaml` with the following content:
+
+```yaml
+proseWrap: always
+singleQuote: true
+trailingComma: all
+```
+
+Next, create `eslint.config.js` with the following content:
+
+```js
+export { default } from '@remcohaszing/eslint'
+```
+
+### TypeScript
+
+This configuration enabled ESLint for TypeScript automatically.
+
+Some rules from `@typescript-eslint/eslint-plugin` require TypeScript type checking features to be
+enabled. Unfortunately, this makes ESLint slow. Enabling these rules is recommended for small
+projects only. To enable this, add the following to `eslint.config.js`:
+
+```js
+import config, { typechecking } from '@remcohaszing/eslint'
+
+export default [...config, ...typechecking]
+```
+
+### Markdown
+
+Code blocks in Markdown are linted by default using
+[`@eslint/markdown`](https://github.com/eslint/markdown). The type checking rules from
+`@typescript-eslint/eslint-plugin` don’t work with markdown code blocks.
+
+`prettier/prettier` is disabled, because it doesn’t play nice with `eslint-plugin-markdown`.
+
+Some other rules have been turned off, because these rules may conflict with the purpose of the
+documentation.
+
+### Disabling rules
+
+Rules can be disabled by adding an extra ESLint configuration item to the configuration array. For
+example:
+
+```js
+import config from '@remcohaszing/eslint'
+
+export default [
+  ...config,
+  {
+    rules: {
+      'no-console': 'off'
+    }
+  }
+]
+```
+
+## Ignored files
+
+By default ESLint ignores `node_modules/` and all dotfiles. This ESLint configuration also ignores
+the patterns from `.gitignore`.
+
+## Warnings
+
+All ESLint that are turned on will trigger error, not warnings. The notable exceptions is
+`@typescript-eslint/no-deprecated`.
+
+This is to allow a smooth migration if a dependency decides to deprecate an API. To turn make
+warnings cause ESLint to exit with exit code 1, run:
+
+```sh
+eslint
+```
+
+## Compatibility
+
+This project requires Node.js 22 or greater.
+
+## License
+
+[MIT](./LICENSE.md) © [Remco Haszing](https://github.com/remcohaszing)

package/lib/allowedProperties.js

@@ -0,0 +1,33 @@
+/**
+ * These property names are allowed, because exist in commonly used specifications.
+ */
+export const allowedProperties = [
+  // OAuth2
+  'access_token',
+  'client_id',
+  'client_secret',
+  'error_description',
+  'error_uri',
+  'expires_in',
+  'grant_type',
+  'redirect_uri',
+  'refresh_token',
+  'response_type',
+  'token_type',
+
+  // OpenID
+  'email_verified',
+  'id_token',
+
+  // Web app manifest
+  'background_color',
+  'iarc_rating_id',
+  'short_name',
+  'prefer_related_applications',
+  'related_applications',
+  'start_url',
+  'theme_color',
+
+  // React
+  '__html'
+]