Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate and remove the @blockly/eslint-config plugin #1975

Open
1 task done
maribethb opened this issue Sep 26, 2023 · 2 comments
Open
1 task done

Deprecate and remove the @blockly/eslint-config plugin #1975

maribethb opened this issue Sep 26, 2023 · 2 comments
Labels
type: feature request New feature or request

Comments

@maribethb
Copy link
Contributor

Check for duplicates

  • I have searched for similar issues before opening a new one.

Component

plugins/eslint-config

Problem

After #1946 is merged, the shared eslint config will be unused by us and should not be used by external developers.

We don't need a shared eslint config. Third-party developers don't need to adhere to our style. It's too specific and beholden to years of legacy decision-making. We don't consider it a breaking change when we update the lint config, so if anyone has been using it, they've been plagued by random unannounced updates to their style guide that they then have to update their code for. It's not a good idea for them to use it.

We no longer need the shared config because we have the new eslint flat config. This provides a better experience when linting across the entire repository as lint messages are much simpler to see when they aren't hidden behind layers of lerna output.

Request

Run npm deprecate on the plugin, and mark it as private in the package.json so it doesn't get published again. Delete it from the repository after some time.

Please note only core Blockly team members should work on this issue due to npm permissions.

Alternatives considered

No response

Additional context

If you are currently using this shared config outside of blockly-samples, you should stop. If you have a solid use case, please comment on this issue. In general though, you don't want to rely on our style guide and we want to be able to make changes to our plugins without breaking you. We'd recommend you use a different eslint shared style guide such as eslint:recommended, eslint-config-google, etc. These will not be updated with breaking changes unexpectedly. Or you can create your own style guide following rules that work for you and your codebase. We have made certain concessions related to the core blockly codebase that don't have to apply to your code.

@alicialics
Copy link
Contributor

Currently the blockly-scripts build step forces a eslint check with @blockly/eslint-config

@maribethb
Copy link
Contributor Author

Yep, this issue only applies after #1946 is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants