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

Migrate ESLint config #40

Closed
Justus-at-Tazama opened this issue May 30, 2024 · 0 comments · Fixed by #44
Closed

Migrate ESLint config #40

Justus-at-Tazama opened this issue May 30, 2024 · 0 comments · Fixed by #44
Assignees

Comments

@Justus-at-Tazama
Copy link
Contributor

Justus-at-Tazama commented May 30, 2024

As a Tazama contributor,
I want an automated way to validate my contributions in terms of code style and linting rules,
So that I can write code that will be acceptable to the Tazama community

Acceptance Criteria

  1. Migrate the implementation of ESLint from pre-v9 to post-v9 as per https://eslint.org/docs/latest/use/migrate-to-9.0.0#-new-default-config-format-eslintconfigjs
    Update: Decided on v8 for plugin support. Which is a flat config file for simple upgrade path when v9 is ready
  2. Replace the deprecated module "eslint-config-standard-with-typescript": "^43.0.0", with the replacement "eslint-config-love": "^51.0.0", as per https://www.npmjs.com/package/eslint-config-love
    3. 3. Add eslint-plugin-promise and eslint-plugin-import
  3. Add a rule top the linting to prevent module-scale linting overrides, if possible
    Update: Will require comment justification for inline eslint-disable rules, warning for now, error in future
  4. Replace the "license": "ISC", in the package.json with "license": "Apache-2.0",
  5. Ensure existing linting rules are migrated to the new "flat file config" in eslint.config.js
  6. Run npx eslint to confirm linting is working as before (regression testing)

See Override linting on a line-scale and not a module-scale
tazama-lf/docs#38

@Justus-at-Tazama Justus-at-Tazama changed the title Update dependencies Migrate ESLint config May 30, 2024
@Justus-at-Tazama Justus-at-Tazama changed the title Migrate ESLint config eslint-migration.md May 30, 2024
@Justus-at-Tazama Justus-at-Tazama changed the title eslint-migration.md Migrate ESLint config May 30, 2024
@rtkay123 rtkay123 self-assigned this Jun 7, 2024
@rtkay123 rtkay123 linked a pull request Jun 12, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants