Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

recommended config #68

Closed
Zamiell opened this issue Jul 26, 2023 · 2 comments · Fixed by #69
Closed

recommended config #68

Zamiell opened this issue Jul 26, 2023 · 2 comments · Fixed by #69
Labels
enhancement New feature or request released

Comments

@Zamiell
Copy link
Contributor

Zamiell commented Jul 26, 2023

Hello, and thanks for the plugin, which I use in my TypeScript projects.

Most ESLint plugins contain a recommended config, which simplifies usage of the plugin.

Since this plugin only provides one rule, a recommended can simply setup for end users. Such a config would automatically enable the plugin and automatically enable the rule.

In other words, this is currently the config that I have to have in order to use this plugin:

const config = {
  plugins: [
    "deprecation",
    // Other plugins enabled here.
  ],
  rules: {
    "deprecation/deprecation": "error",
    // Other rules enabled here.
  },
};

But this could/should be simplified to:

const config = {
  extends: [
    "plugin:deprecation/recommended",
  ],
};

If you agree that this is a good idea, I will submit a PR, as setting this up is relatively simple.

@gund
Copy link
Owner

gund commented Jul 26, 2023

Looks like a nice proposal.
Surely a PR is welcome for this feature!

@gund gund closed this as completed in #69 Jul 27, 2023
gund added a commit that referenced this issue Jul 27, 2023
Allows to use simplified `deprecation/recommended` configuration:
```json
{
"extends": [
    "plugin:deprecation/recommended",
  ]
}
```

Closes #68
@gund gund added the enhancement New feature or request label Jul 27, 2023
@github-actions
Copy link

🎉 This issue has been resolved in version 1.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request released
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants