@blumintinc/eslint-plugin-blumint 1.0.2 → 1.0.3

package/README.md

@@ -1,299 +1,80 @@
-<!-- Project shields -->
+# @blumintinc/eslint-plugin-blumint
 
-[![Setup Automated][gitpod-shield]][gitpod-url]
+Custom eslint rules for use at BluMint
 
-<!-- Header -->
-<br />
-<p align="center">
-  <!---TODO: Update below with repository URL -->
-  <a href="https://github.com/BluMintInc/template-gitpod">
-    <img src="assets/logo.svg" alt="Logo" height=100>
-  </a>
-  <p align="center">
-    <!---TODO: Update below with repository name -->
-    TEMPLATE
-    <br />
-    <!---TODO: Update below with repository URL -->
-    <a href="https://github.com/BluMintInc/template-gitpod/issues">Report Bug</a>
-    ·
-    <!---TODO: Update below with repository URL -->
-    <a href="https://github.com/BluMintInc/template-gitpod/issues">Request Feature</a>
-  </p>
-</p>
-<br />
+## Installation
 
-## Table of Contents
+You'll first need to install [ESLint](https://eslint.org/):
 
-- [About this Project](#about-this-project)
-  - [Built With](#built-with)
-  - [Environment Dependencies](#environment-dependencies)
-  - [Recommended Browser Extensions](#recommended-browser-extensions)
-- [Getting Started](#getting-started)
-  - [Zero-Installation Development](#zero-installation-development)
-  - [Docker Installation](#docker-installation)
-- [Contributing](#contributing)
-  - [Agile Development](#agile-development)
-  - [Testing](#testing)
-  - [Gitflow](#gitflow)
-  - [Commitizen](#commitizen)
-  - [Diagramming](#diagramming)
-- [Workflow Automation](#workflow-automation)
-  - [CI](#ci)
-  - [CD](#cd)
-  - [Dependency Management](#dependency-management)
-  - [Static Code Analysis](#static-code-analysis)
-- [License](#license)
-
-<br />
-
-## About this Project
-
-This repository is a template repository for Gitpod-based development of a service.
-
-### Built with
-
-- [Typescript](https://www.typescriptlang.org/)
-- [Jest](https://mochajs.org/)
-
-### Environment Dependencies
-
-- [NodeJS](https://nodejs.org) (16 with npm ^8.16.0)
-
-### Recommended Browser Extensions
-
-It is recommended that you install the following browser extensions for the best experience
-interacting with this repository:
-
-1. [Gitpod Browser Extension](https://www.gitpod.io/docs/browser-extension/)
-
-<br />
-
-## Getting Started
-
-### Zero-Installation Development
-
-<!---TODO: Update below with repository URL -->
-
-[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/BluMintInc/template-gitpod)
-
-It is highly recommended to conduct development of this repository
-via [Gitpod's online IDE](https://www.gitpod.io/docs/ide/). Click the following to
-get started with zero installation requirements:
-
-<p>
-  <!---TODO: Update below with repository URL -->
-  <a href="https://gitpod.io/#https://github.com/BluMintInc/template-gitpod" target="_blank" rel="nofollow noopener noreferrer">
-    <img src="https://gitpod.io/button/open-in-gitpod.svg" alt="Open in Gitpod">
-  </a>
-</p>
-
-Gitpod is a one-click online IDE for Cloud-based development. The following video
-provides a very effective introduction to Gitpod: [https://www.youtube.com/watch?v=qLv6-Uop0yc](https://www.youtube.com/watch?v=qLv6-Uop0yc).
-
-<br />
-
-### Docker Installation
-
-Alternatively, this repo supports [VS Code Remote Container Development](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) for Dockerized development inside VSCode.
-
-**Step #1**: To get started, first make sure to install the followin prerequisites:
-
-1.  Visual Studio Code
-
-    - Manual installation: https://code.visualstudio.com/download
-    - Windows (via [Chocolately](https://chocolatey.org/)):
-      ```bash
-      choco install vscode
-      ```
-    - Mac or Linux (via [Homebrew](https://brew.sh/)):
-      ```sh
-      brew update
-      brew tap homebrew/cask-cask
-      brew cask search visual-studio-code
-      brew cask install visual-studio-code
-      ```
-
-2.  [Visual Studio Code Remote Development](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
-    extension pack, which can be installed into VS Code with [this manual installation link](vscode:extension/ms-vscode-remote.vscode-remote-extensionpack).
-
-3.  [Docker Desktop](https://www.docker.com/products/docker-desktop)
-    - Manual installation: https://www.docker.com/products/docker-desktop for Widows / Mac
-    - Windows (via [Chocolately](https://chocolatey.org/)):
-      ```bash
-      choco install docker-desktop
-      ```
-      and follow
-    - Mac or Linux (via [Homebrew](https://brew.sh/)):
-      ```sh
-      brew cask install docker
-      ```
-    - Linux (Ubuntu, Debian):
-      ```sh
-      sudo apt-get update
-      sudo apt-get remove docker docker-engine docker.io
-      sudo apt install docker.io
-      sudo systemctl start docker
-      sudo systemctl enable docker
-      ```
-
-**Step #2**: Start the Docker daemon if it has already not started automatially after the
-installation finishes (run the Docker Desktop application). To ensure docker is running,
-attempt the following commands:
-
-```bash
-docker version
-docker run hello-world
+```sh
+npm i eslint --save-dev
 ```
 
-**Step #3**: Start VS Code and press _F1_ to run
-**Remote-Containers: Clone Repository in Container Volume..** from the Command Palette.
-
-<!---TODO: Update below with repository URL -->
-
-**Step #4**: Enter this repository's Git URI: https://github.com/BluMintInc/template-gitpod.git.
-VS Code will install all required dependencies and set up the environment from the Dockerfile configuration.
+Next, install `@blumintinc/eslint-plugin-blumint`:
 
-<br />
-
-## Contributing
-
-### [Agile Development](https://agilemanifesto.org/)
-
-We are uncovering better ways of developing
-software by doing it and helping others do it.
-
-Through this work we have come to value:
-
-- **Individuals and interactions** over _processes and tools_
-- **Working software** over _comprehensive documentation_
-- **Customer collaboration** over _contract negotiation_
-- **Responding to change** over _following a plan_
-
-That is, while there is value in the items on
-_the right_, we value the items **on the left** more.
-
-Furthermore, we value these principles:
-
-1. Our highest priority is to satisfy the customer
-   through early and continuous delivery
-   of valuable software.
-2. Welcome changing requirements, even late in
-   development. Agile processes harness change for
-   the customer's competitive advantage.
-3. Deliver working software frequently, from a
-   couple of weeks to a couple of months, with a
-   preference to the shorter timescale.
-4. Business people and developers must work
-   together daily throughout the project.
-5. Build projects around motivated individuals.
-   Give them the environment and support they need,
-   and trust them to get the job done.
-6. The most efficient and effective method of
-   conveying information to and within a development
-   team is face-to-face conversation.
-7. Working software is the primary measure of progress.
-8. Agile processes promote sustainable development.
-   The sponsors, developers, and users should be able
-   to maintain a constant pace indefinitely.
-9. Continuous attention to technical excellence
-   and good design enhances agility.
-10. Simplicity--the art of maximizing the amount
-    of work not done--is essential.
-11. The best architectures, requirements, and designs
-    emerge from self-organizing teams.
-12. At regular intervals, the team reflects on how
-    to become more effective, then tunes and adjusts
-    its behavior accordingly.
-
-### Testing
-
-Each contributor to this repository is obligated to provide sufficient test coverage over their contributions. 
-We use the [Jest](https://jestjs.io/) test framework.
-
-### [Gitflow](https://nvie.com/posts/a-successful-git-branching-model/)
-
-Version control with git on this repo is in strict adherence to
-the [Gitflow Workflow](https://nvie.com/posts/a-successful-git-branching-model/).
-Gitflow was architectured by Vincent Driesssen in 2010 and since has been adopted with massive
-popularity as a very effective development workflow under distributed version control.
-
-This project makes use of the [git-flow](https://github.com/nvie/gitflow) integration setup in
-the Docker container, which lets you execute `git flow` commands on the terminal rather than 
-`git` commands directly.
-
-The project also utilizes [githooks](https://git-scm.com/docs/githooks/en) to enforce gitflow and 
-prevent users from accidently pushing to the main branch.
-
-Plase read the following article for a sufficient introduction to the Gitflow
-Workflow: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow.
-
-### [Commitizen](https://commitizen-tools.github.io/commitizen/)
-
-This project uses [githooks](https://git-scm.com/docs/githooks/en) to enforce standarized commits 
-according to the [Commitizen](https://commitizen-tools.github.io/commitizen/) style. Running 
-`git commit` on the command line instigates a series of prompts guiding you through the standard.
-
-### Diagramming
-
-All diagrams should be included on the repository to which they pertain. We use 
-[PlantUML](https://plantuml.com/) to build all of our diagrams. PlantUML has a Domain Specific 
-Language (DSL) for declaratively building [various types of diagrams](https://plantuml.com/). 
-You can write a .wsd, .pu, .puml, .plantuml, or .iuml file containing PlantUML DSL and the 
-[PlantUML Extension](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) 
-will enable you to render that diagram in a live preview by pressing Alt + D.
-
-<br />
-<br />
-
-## Workflow Automation
-
-This repository uses [Github Actions](https://docs.github.com/en/actions) for several workflow 
-automations as well as several organizational [Github Integrations](https://github.com/integrations).
-
-### CI
-
-Pre-commit [githooks](https://git-scm.com/docs/githooks/en) lint the codebase and then run all the 
-project's [Jest](https://jestjs.io/) tests to prevent regressions from even being checked into 
-the codebase. On top of this, the 
-[Test](https://github.com/BluMintInc/template-gitpod/blob/master/.github/workflows/test-report.yml) 
-Action runs the project's [Jest](https://jestjs.io/) tests to check PRs before they are merged.
-
-### CD
-<!---TODO: Update below paragraph with repository URLs -->
-The [Release](https://github.com/BluMintInc/template-gitpod/blob/master/.github/workflows/semantic-release.yml) 
-Action triggers on commits to the main branch utilzing the repository's 
-[Commitizen](https://commitizen-tools.github.io/commitizen/) commit style to automatically version published 
-code according to [SemVar](https://semver.org/). The 
-[Release](https://github.com/BluMintInc/template-gitpod/blob/master/.github/workflows/semantic-release.yml) 
-Action also publishes the project to our private npmjs repository scoped under [@blumint](https://www.npmjs.com/settings/minimap-inc/packages).
+```sh
+npm install @blumintinc/eslint-plugin-blumint --save-dev
+```
 
-This repository also makes use of the [Semantic Pull Probot](https://github.com/zeke/semantic-pull-requests) to 
-vet and squash the commits of merged PRs onto the main branch. For more information, see 
-[Semantic Release](https://github.com/semantic-release/semantic-release).
+## Usage
 
-### Dependency Management
+Add `@blumintinc/blumint` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
-The [Dependabot](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security#what-is-dependabot) integration will periodically 
-make PRs suggesting modifications to the dependecy structure to eliminiate vulnerabilities, update depricated 
-dependencies, and perform other miscellenous tasks.
+```json
+{
+    "plugins": [
+        "@blumintinc/blumint"
+    ]
+}
+```
 
-### Static Code Analysis
 
-The [Accuracies](https://github.com/marketplace/accurics) integration analyzes the codebase for policy violations and 
-vulnerabilities with the use of Cloud infrastructure (AWS, GCP, etc.) and makes PRs to corrct any detected 
-issues before they become a problem.
+Then configure the rules you want to use under the rules section.
 
-The [Codacy](https://app.codacy.com/) bot will scan PRs and the repository as a whole to detect security vulnerabilities, code smells, performance inefficiencies, compatibility issues, unnecessarily complex code, missing documentation, and unused code.
+```json
+{
+    "rules": {
+        "blumint/rule-name": "error"
+    }
+}
+```
 
-<br />
-<br />
+Or use the recommended config:
 
-## License
+```json
+{
+    "extends": ["some-other-plugin", "plugin:@blumintinc/blumint/recommended"]
+}
+```
 
-No license is included, as all work is proprietary.
+## Rules
+
+<!-- begin auto-generated rules list -->
+
+💼 Configurations enabled in.\
+⚠️ Configurations set to warn in.\
+✅ Set in the `recommended` configuration.\
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+
+| Name                                                                               | Description                                                                                                                                     | 💼 | ⚠️ | 🔧 |
+| :--------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | :- | :- | :- |
+| [array-methods-this-context](docs/rules/array-methods-this-context.md)             | Prevent misuse of Array methods in OOP                                                                                                          |    | ✅  |    |
+| [class-methods-read-top-to-bottom](docs/rules/class-methods-read-top-to-bottom.md) | Ensures classes read linearly from top to bottom.                                                                                               |    | ✅  | 🔧 |
+| [dynamic-https-errors](docs/rules/dynamic-https-errors.md)                         | Dynamic error details should only be in the third argument of the HttpsError constructor. The second argument is hashed to produce a unique id. |    | ✅  |    |
+| [export-if-in-doubt](docs/rules/export-if-in-doubt.md)                             | All top-level const definitions, type definitions, and functions should be exported                                                             |    |    |    |
+| [extract-global-constants](docs/rules/extract-global-constants.md)                 | Extract constants/functions to the global scope when possible                                                                                   |    |    |    |
+| [generic-starts-with-t](docs/rules/generic-starts-with-t.md)                       | Enforce TypeScript generic types to start with T                                                                                                |    | ✅  |    |
+| [no-async-array-filter](docs/rules/no-async-array-filter.md)                       | Disallow async callbacks for Array.filter                                                                                                       | ✅  |    |    |
+| [no-async-foreach](docs/rules/no-async-foreach.md)                                 | Disallow Array.forEach with an async callback function                                                                                          | ✅  |    |    |
+| [no-conditional-literals-in-jsx](docs/rules/no-conditional-literals-in-jsx.md)     | Disallow use of conditional literals in JSX code                                                                                                | ✅  |    |    |
+| [no-filter-without-return](docs/rules/no-filter-without-return.md)                 | Disallow Array.filter callbacks without an explicit return (if part of a block statement)                                                       | ✅  |    |    |
+| [no-misused-switch-case](docs/rules/no-misused-switch-case.md)                     | Prevent misuse of logical OR in switch case statements                                                                                          | ✅  |    |    |
+| [no-unpinned-dependencies](docs/rules/no-unpinned-dependencies.md)                 | Enforces pinned dependencies                                                                                                                    | ✅  |    | 🔧 |
+| [no-useless-fragment](docs/rules/no-useless-fragment.md)                           | Prevent unnecessary use of React fragments                                                                                                      |    | ✅  | 🔧 |
+| [prefer-fragment-shorthand](docs/rules/prefer-fragment-shorthand.md)               | Prefer <> shorthand for <React.Fragment>                                                                                                        |    | ✅  | 🔧 |
+| [prefer-type-over-interface](docs/rules/prefer-type-over-interface.md)             | Prefer using type alias over interface                                                                                                          |    | ✅  | 🔧 |
+| [require-memo](docs/rules/require-memo.md)                                         | React components must be memoized                                                                                                               | ✅  |    | 🔧 |
+
+<!-- end auto-generated rules list -->
 
-<!-- Markdown links & images -->
 
-[gitpod-shield]: https://img.shields.io/badge/setup-automated-blue?logo=gitpod
-<!---TODO: Update below with repository URL -->
-[gitpod-url]: https://gitpod.io/#https://github.com/BluMintInc/template-gitpod

package/lib/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const array_methods_this_context_1 = require("./rules/array-methods-this-context");
+const class_methods_read_top_to_bottom_1 = require("./rules/class-methods-read-top-to-bottom");
+const dynamic_https_errors_1 = require("./rules/dynamic-https-errors");
+const export_if_in_doubt_1 = require("./rules/export-if-in-doubt");
+const extract_global_constants_1 = require("./rules/extract-global-constants");
+const generic_starts_with_t_1 = require("./rules/generic-starts-with-t");
+const no_async_array_filter_1 = require("./rules/no-async-array-filter");
+const no_async_foreach_1 = require("./rules/no-async-foreach");
+const no_conditional_literals_in_jsx_1 = require("./rules/no-conditional-literals-in-jsx");
+const no_filter_without_return_1 = require("./rules/no-filter-without-return");
+const no_misused_switch_case_1 = require("./rules/no-misused-switch-case");
+const no_unpinned_dependencies_1 = require("./rules/no-unpinned-dependencies");
+const no_useless_fragment_1 = require("./rules/no-useless-fragment");
+const prefer_fragment_shorthand_1 = require("./rules/prefer-fragment-shorthand");
+const prefer_type_over_interface_1 = require("./rules/prefer-type-over-interface");
+const require_memo_1 = require("./rules/require-memo");
+module.exports = {
+    meta: {
+        name: '@blumintinc/eslint-plugin-blumint',
+        version: '1.0.3',
+    },
+    parseOptions: {
+        ecmaVersion: 2020,
+    },
+    configs: {
+        recommended: {
+            plugins: ['@blumintinc/blumint'],
+            rules: {
+                '@blumintinc/blumint/array-methods-this-context': 'warn',
+                '@blumintinc/blumint/class-methods-read-top-to-bottom': 'warn',
+                '@blumintinc/blumint/dynamic-https-errors': 'warn',
+                // '@blumintinc/blumint/export-if-in-doubt': 'warn',
+                // '@blumintinc/blumint/extract-global-constants': 'warn',
+                '@blumintinc/blumint/generic-starts-with-t': 'warn',
+                '@blumintinc/blumint/no-async-array-filter': 'error',
+                '@blumintinc/blumint/no-async-foreach': 'error',
+                '@blumintinc/blumint/no-conditional-literals-in-jsx': 'error',
+                '@blumintinc/blumint/no-filter-without-return': 'error',
+                '@blumintinc/blumint/no-misused-switch-case': 'error',
+                '@blumintinc/blumint/no-unpinned-dependencies': 'error',
+                '@blumintinc/blumint/no-useless-fragment': 'warn',
+                '@blumintinc/blumint/prefer-fragment-shorthand': 'warn',
+                '@blumintinc/blumint/prefer-type-over-interface': 'warn',
+                '@blumintinc/blumint/require-memo': 'error',
+            },
+        },
+    },
+    rules: {
+        'array-methods-this-context': array_methods_this_context_1.arrayMethodsThisContext,
+        'class-methods-read-top-to-bottom': class_methods_read_top_to_bottom_1.classMethodsReadTopToBottom,
+        'dynamic-https-errors': dynamic_https_errors_1.dynamicHttpsErrors,
+        'export-if-in-doubt': export_if_in_doubt_1.exportIfInDoubt,
+        'extract-global-constants': extract_global_constants_1.extractGlobalConstants,
+        'generic-starts-with-t': generic_starts_with_t_1.genericStartsWithT,
+        'no-async-array-filter': no_async_array_filter_1.noAsyncArrayFilter,
+        'no-async-foreach': no_async_foreach_1.noAsyncForEach,
+        'no-conditional-literals-in-jsx': no_conditional_literals_in_jsx_1.noConditionalLiteralsInJsx,
+        'no-filter-without-return': no_filter_without_return_1.noFilterWithoutReturn,
+        'no-misused-switch-case': no_misused_switch_case_1.noMisusedSwitchCase,
+        'no-unpinned-dependencies': no_unpinned_dependencies_1.noUnpinnedDependencies,
+        'no-useless-fragment': no_useless_fragment_1.noUselessFragment,
+        'prefer-fragment-shorthand': prefer_fragment_shorthand_1.preferFragmentShorthand,
+        'prefer-type-over-interface': prefer_type_over_interface_1.preferTypeOverInterface,
+        'require-memo': require_memo_1.requireMemo,
+    },
+};
+//# sourceMappingURL=index.js.map

package/lib/rules/array-methods-this-context.d.ts

@@ -0,0 +1,3 @@
+import { TSESLint } from '@typescript-eslint/utils';
+export declare const ARRAY_METHODS: string[];
+export declare const arrayMethodsThisContext: TSESLint.RuleModule<'preferArrow' | 'unexpected', never[]>;

package/lib/rules/array-methods-this-context.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.arrayMethodsThisContext = exports.ARRAY_METHODS = void 0;
+const createRule_1 = require("../utils/createRule");
+exports.ARRAY_METHODS = [
+    'map',
+    'filter',
+    'forEach',
+    'reduce',
+    'some',
+    'every',
+];
+exports.arrayMethodsThisContext = (0, createRule_1.createRule)({
+    create(context) {
+        return {
+            CallExpression(node) {
+                // Array method called with a class method reference
+                if (node.callee.type === 'MemberExpression' &&
+                    node.callee.property.type === 'Identifier' &&
+                    exports.ARRAY_METHODS.includes(node.callee.property.name) &&
+                    node.arguments.length > 0 &&
+                    node.arguments[0].type === 'MemberExpression' &&
+                    node.arguments[0].object.type === 'ThisExpression') {
+                    context.report({
+                        node: node.arguments[0],
+                        messageId: 'unexpected',
+                    });
+                }
+                // Function expression bound to `this` in array method
+                else if (node.callee.type === 'MemberExpression' &&
+                    node.callee.property.type === 'Identifier' &&
+                    exports.ARRAY_METHODS.includes(node.callee.property.name) &&
+                    node.arguments.length > 0 &&
+                    node.arguments[0].type === 'CallExpression' &&
+                    node.arguments[0].callee.type === 'MemberExpression' &&
+                    node.arguments[0].callee.object.type === 'FunctionExpression' &&
+                    node.arguments[0].callee.property.type === 'Identifier' &&
+                    node.arguments[0].callee.property.name === 'bind' &&
+                    node.arguments[0].arguments.length > 0 &&
+                    node.arguments[0].arguments[0].type === 'ThisExpression') {
+                    context.report({
+                        node: node.arguments[0],
+                        messageId: 'preferArrow',
+                    });
+                }
+            },
+        };
+    },
+    name: 'array-methods-this-context',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Prevent misuse of Array methods in OOP',
+            recommended: 'error',
+        },
+        schema: [],
+        messages: {
+            unexpected: 'Use an arrow function to preserve "this" context.',
+            preferArrow: 'Use an arrow function instead of binding this.',
+        },
+    },
+    defaultOptions: [],
+});
+//# sourceMappingURL=array-methods-this-context.js.map

package/lib/rules/class-methods-read-top-to-bottom.d.ts

@@ -0,0 +1,2 @@
+import { TSESLint } from '@typescript-eslint/utils';
+export declare const classMethodsReadTopToBottom: TSESLint.RuleModule<'classMethodsReadTopToBottom', never[]>;

package/lib/rules/class-methods-read-top-to-bottom.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.classMethodsReadTopToBottom = void 0;
+const createRule_1 = require("../utils/createRule");
+const ClassGraphBuilder_1 = require("../utils/graph/ClassGraphBuilder");
+function getMemberName(member) {
+    if (member.type === 'MethodDefinition' ||
+        member.type === 'PropertyDefinition') {
+        return member.key.type === 'Identifier' ? member.key.name : null;
+    }
+    return null;
+}
+exports.classMethodsReadTopToBottom = (0, createRule_1.createRule)({
+    name: 'class-methods-read-top-to-bottom',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Ensures classes read linearly from top to bottom.',
+            recommended: 'warn',
+        },
+        schema: [],
+        messages: {
+            classMethodsReadTopToBottom: 'Methods should be ordered for top-down readability.',
+        },
+        fixable: 'code', // To allow ESLint to autofix issues.
+    },
+    defaultOptions: [],
+    create(context) {
+        let className;
+        return {
+            ClassDeclaration(node) {
+                className = node.id?.name || '';
+            },
+            'ClassBody:exit'(node) {
+                const graphBuilder = new ClassGraphBuilder_1.ClassGraphBuilder(className, node);
+                const sortedOrder = graphBuilder.memberNamesSorted;
+                const actualOrder = node.body
+                    .map((member) => member.type === 'MethodDefinition' ||
+                    member.type === 'PropertyDefinition'
+                    ? member.key.name
+                    : null)
+                    .filter(Boolean);
+                for (let i = 0; i < actualOrder.length; i++) {
+                    if (actualOrder[i] !== sortedOrder[i]) {
+                        const sourceCode = context.getSourceCode();
+                        const newClassBody = sortedOrder
+                            .map((n) => {
+                            // Fetch the actual AST node corresponding to the name
+                            const memberNode = node.body.find((member) => getMemberName(member) === n);
+                            const comments = sourceCode.getCommentsBefore(memberNode);
+                            memberNode.range = [
+                                Math.min(memberNode.range[0], Math.min(...comments.map((comment) => comment.range[0]))),
+                                Math.max(memberNode.range[1], Math.max(...comments.map((comment) => comment.range[1]))),
+                            ];
+                            return sourceCode.getText(memberNode);
+                        })
+                            .join('\n');
+                        return context.report({
+                            node,
+                            messageId: 'classMethodsReadTopToBottom',
+                            fix(fixer) {
+                                return fixer.replaceTextRange([node.range[0] + 1, node.range[1] - 1], // Exclude the curly braces
+                                newClassBody);
+                            },
+                        });
+                    }
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=class-methods-read-top-to-bottom.js.map

package/lib/rules/dynamic-https-errors.d.ts

@@ -0,0 +1,2 @@
+import { TSESLint } from '@typescript-eslint/utils';
+export declare const dynamicHttpsErrors: TSESLint.RuleModule<'dynamicHttpsErrors', never[]>;

package/lib/rules/dynamic-https-errors.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dynamicHttpsErrors = void 0;
+/* eslint-disable @blumintinc/blumint/extract-global-constants */
+const createRule_1 = require("../utils/createRule");
+const isHttpsErrorCall = (callee) => {
+    if (callee.type === 'MemberExpression') {
+        return (callee.object.type === 'Identifier' &&
+            callee.object.name === 'https' &&
+            callee.property.type === 'Identifier' &&
+            callee.property.name === 'HttpsError');
+    }
+    else if (callee.type === 'Identifier') {
+        return callee.name === 'HttpsError';
+    }
+    return false;
+};
+exports.dynamicHttpsErrors = (0, createRule_1.createRule)({
+    name: 'dynamic-https-errors',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Dynamic error details should only be in the third argument of the HttpsError constructor. The second argument is hashed to produce a unique id.',
+            recommended: 'warn',
+        },
+        schema: [],
+        messages: {
+            dynamicHttpsErrors: 'Found dynamic error details in the second argument of the HttpsError constructor - the "message" field. This field is hashed to produce a unique id for error monitoring. Move any dynamic details to the third argument - the "details" field - to preserve the unique id and to monitor the error correctly.',
+        },
+    },
+    defaultOptions: [],
+    create(context) {
+        const checkForHttpsError = (node) => {
+            const callee = node.callee;
+            if (isHttpsErrorCall(callee)) {
+                const secondArg = node.arguments[1];
+                if (secondArg && secondArg.type === 'TemplateLiteral') {
+                    if (secondArg.expressions.length > 0) {
+                        context.report({
+                            node: secondArg,
+                            messageId: 'dynamicHttpsErrors',
+                        });
+                    }
+                }
+            }
+        };
+        return {
+            NewExpression(node) {
+                return checkForHttpsError(node);
+            },
+            CallExpression(node) {
+                return checkForHttpsError(node);
+            },
+        };
+    },
+});
+//# sourceMappingURL=dynamic-https-errors.js.map

package/lib/rules/export-if-in-doubt.d.ts

@@ -0,0 +1,2 @@
+import { TSESLint } from '@typescript-eslint/utils';
+export declare const exportIfInDoubt: TSESLint.RuleModule<'exportIfInDoubt', never[]>;