Design Doc: linter module `v0.1.0`

[shinGangan]

Design Doc

Context

Create a module that extends the Nuxt ESLint module and adds commonly used ESLint rules. There is a possibility of adding Prettier, StyleLint, MarkdownLint, etc. in the future, but v0.1.0 will only add ESLint.

Design

module example

// module.ts

export default defineNuxtModule<ModuleOptions>({
  // ...
  async setup(_options, _nuxt) {
    // 1. add eslint config template

    // 2. install module
  }
});

Set ESLint module as follows.

• stylistic: true
• checker: false

Set ESLint rules as follows. Note that the contents set in @nuxt/eslint-config are not set.

• @typescript-eslint/explicit-function-return-type
• @typescript-eslint/no-import-type-side-effects
  • Will not be added if officially adopted
• @typescript-eslint/naming-convention
  • under consideration

Discuss

add eslint-config-prettier? 🤔

[shinGangan]

Draft

Considering the reusability of the module, it may be easier to maintain it by cutting it out as eslint-config. 🤔

eslint-plugin-import-access

I often create monorepo configurations using pnpm workspace. Therefore, I think that eslint-plugin-import-access is also effective. I haven't used it so far

• ref: https://zenn.dev/uhyo/articles/eslint-plugin-import-access

eslint-plugin-vue-scoped-css

• https://future-architect.github.io/eslint-plugin-vue-scoped-css/
• https://github.com/future-architect/eslint-plugin-vue-scoped-css

eslint-plugin-vuejs-accessibility

• https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility
• https://vue-a11y.github.io/eslint-plugin-vuejs-accessibility/

[shinGangan]

こちらで整理する

https://zenn.dev/gangannikki/scraps/adc7f3d0a19d9a