Create new rule for no aliasing imports and clean out repo for use for future rules

[CDeltakai]

Description

This PR implements the first custom rule which is no-alias-imports which will disallow the use of alias imports in configured files and optionally provide an auto-fix that will replace said import with a relative import instead.

This PR will also clean out the repo of unnecessary files from its original template (js-logger) and prepare it for use as a linter plugin.

Issues Fixed

• Fixes Create NPM project for custom linter rule for replacing aliased imports #3

Tasks

• 1. Implement no-aliased-imports linting rule
• 2. Clean out repo of unnecessary files from original template repo
• 3. Prepare it for import into other codebases

Final checklist

• Domain specific tests
• Full tests
• Updated inline-comment documentation
• Lint fixed
• Squash and rebased
• Sanity check the final build

[tegefaulkes]

@CDeltakai can we get a progress update for this?

[CDeltakai]

@CDeltakai can we get a progress update for this?

Currently the plugin works fine as long as it's imported, and the rules can be referenced and used directly like so:
'@matrixai/no-aliased-imports': 'error',
However, there seems to be some issues getting a config with recommended rules and settings set up at the moment.

[CDeltakai]

I believe getting the recommended config to work is being a bigger hassle than expected due to the fact that the esling.config.mjs in Polykey-Enterprise is using compat.extends which translates old ESLintRC style configs to be usable in the flat config style. However, this is also seemingly blocking the ability to use configs normally using the new config style.

There seems to be a way around this by ensuring backwards compatibility on the plugin and exporting a CommonJS entry point alongside a pure ESM one, but this will take extra work to ensure it works properly.

If a recommended config is not absolutely necessary, the plugin will work fine as is so long as its imported like the other eslint plugins, but it will take some more research for me to figure out exactly how to get the configs to work with our current eslint.config.mjs.

[tegefaulkes]

I'm not sure what you're describing here. What is the problem exactly? Are you running into errors?

[CDeltakai]

The primary error that I'm trying to fix is this:

Oops! Something went wrong! :(

ESLint: 9.18.0

ESLint couldn't find the plugin "@matrixai/eslint-plugin".

(The package "@matrixai/eslint-plugin" was not found when loaded as a Node module from the directory "/home/matthew/Coding/Polykey-Enterprise".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

    npm install @matrixai/eslint-plugin@latest --save-dev

The plugin "@matrixai/eslint-plugin" was referenced from the config file in "".

If you still can't figure out the problem, please see https://eslint.org/docs/latest/use/troubleshooting.

Linting failed with exit code 2.

which occurs when I try to implement the linting plugin like so:

export default [
  ...fixupConfigRules(
    compat.extends(
      'eslint:recommended',
      'plugin:@typescript-eslint/recommended',
      'plugin:react/recommended',
      'plugin:react-hooks/recommended',
      'plugin:prettier/recommended',
      'plugin:tailwindcss/recommended',
      'plugin:jsx-a11y/recommended',
      'plugin:@matrixai/eslint-plugin/recommended',
    ),

However, if you comment out the plugin part here and just import and use the rule normally, the linting rule works fine.

[CDeltakai]

I've come up with a workaround (or a workaround of a workaround since the compat.extends thing was originally meant to be a workaround in order to make old .eslintrc specific linting rules work with the new flat config system).

The compat.extends thing seems extremely stubborn and for whatever reason simply doesn't know how to read the custom plugin when read via it. Instead, I've chosen to convert the plugin entirely to a pure ESM format which means that now it will only work when imported into a flat config like eslint.config.mjs. This way, configs can be loaded directly like so:

//esling.config.mjs
import _matrixLintPlugin from "@matrixai/eslint-plugin";

export default [
  _matrixLintPlugin.configs.recommended,

 {
    plugins: {
      '@matrixai' : _matrixLintPlugin,
     // any other plugins
    }
 }

// everything else below
]

This will then load all the rules configured in the recommended config inside the plugin, meaning you don't have to manually set up any rules if you don't want to. This is pretty much the same as with the .eslintrc style imports with the compat.extends which does the same thing for old .eslintrc lint plugins.

Assuming we intend to migrate all of our codebases to use ESLint 9.0.0+ which all use the flat config style (eslint.config.mjs), this is probably the most practical solution and is the recommended approach according to docs anyway.

[CMCDragonkai]

Yes all repos will be esling v9. Ignore repos that aren't that yet. They are all going to use the same linting standard.