lisilinhart / eslint-plugin-pinia Goto Github PK

View Code? Open in Web Editor NEW

23.0 2.0 2.0 363 KB

Eslint Plugin for Pinia

Home Page: https://www.npmjs.com/package/eslint-plugin-pinia

License: MIT License

TypeScript 100.00%

eslint-plugin-pinia's Introduction

eslint-plugin-pinia

Eslint plugin that enforces some best practices for writing pinia stores

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-pinia:

npm install eslint-plugin-pinia --save-dev

Usage

Add pinia to the plugins section of your .eslintrc or eslint.config.js configuration file. You can omit the eslint-plugin- prefix:

// .eslintrc [Legacy Config]
{
  "plugins": ["pinia"]
}

// eslint.config.js
import pinia from 'eslint-plugin-pinia'

export default [
  plugins: {
    pinia
  }
]

Rule Configuration

Then configure the rules you want to use under the rules section.

// .eslintrc [Legacy Config]
{
  "rules": {
    "pinia/require-export-define-store": [
      "warn"
    ]
  }
}

// eslint.config.js
import pinia from 'eslint-plugin-pinia'

export default [
  {
    plugin: {
      pinia
    },
    rules: {
      "pinia/require-export-define-store": ["warn"]
    }
  }
]

all rules

To use the all configuration, extend it in your .eslintrc or eslint.config.js file:

// .eslintrc [Legacy Config]
{
  "extends": ["plugin:pinia/all"]
}

// eslint.config.js
import pinia from 'eslint-plugin-pinia'

export default [
  pinia.configs["all-flat"],
]

Rules

💼 Configurations enabled in.
⚠️ Configurations set to warn in.
🚫 Configurations disabled in.
🌐 Set in the all configuration.
🌐 Set in the all-flat configuration.
✅ Set in the recommended configuration.
✅ Set in the recommended-flat configuration.

Name	Description	💼	⚠️	🚫
never-export-initialized-store	Never export an initialized named or default store.	✅ ✅	🌐 🌐
no-duplicate-store-ids	Disallow duplicate store ids.	✅ ✅	🌐 🌐
no-return-global-properties	Disallows returning globally provided properties from Pinia stores.	✅ ✅	🌐 🌐
no-store-to-refs-in-store	Disallow use of storeToRefs inside defineStore	✅ ✅	🌐 🌐
prefer-single-store-per-file	Encourages defining each store in a separate file.			🌐 🌐
prefer-use-store-naming-convention	Enforces the convention of naming stores with the prefix `use` followed by the store name.		🌐 🌐 ✅ ✅
require-setup-store-properties-export	In setup stores all state properties must be exported.	✅ ✅	🌐 🌐

Credits

eslint-plugin-vitest The core repository structure came from this eslint plugin

Licence

Contributing

Please check the Contributing file.

This project exists thanks to all the people who contribute 😍!

eslint-plugin-pinia's People

Contributors

Stargazers

Watchers

Forkers

pjfontillas 9romise

eslint-plugin-pinia's Issues

no-duplicate-store-ids 这个有bug

只要你打开编辑器，然后关掉，再打开就会报错

Rule: no-return-global-properties

Warns against returning global properties like route or appProvided in setup stores.

Rule: Unique store ids

See vuejs/pinia#1394

Have a rule to warn when creating a computed property that receives arguments

Would be awesome to have a linting rule to generate a warning when trying to use create a computed property with arguments , as you will take a performance hit by no catching the results and recalculating every time.

As per the documentation:

export const useStore = defineStore('main', {
  getters: {
    getActiveUserById(state) {
      const activeUsers = state.users.filter((user) => user.active)
      return (userId) => activeUsers.find((user) => user.id === userId)
    },
  },
})

When doing this, getters are no longer cached. They are simply functions you invoke.

Taken from: https://pinia.vuejs.org/core-concepts/getters.html#Passing-arguments-to-getters

And in v10 the classical config style will be removed.

It would be nice if it could be easily set up as follows:

import vue from 'eslint-plugin-vue'
import pinia from 'eslint-plugin-pinia'

export default [
  ...vue.configs['flat/recommended'],
  ...pinia.configs.recommended,

  // Currently it can be configured as follows
  // {
  //   files: ['**/*.ts'],
  //   plugins: { pinia },
  //   rules: {
  //     ...pinia.configs.recommended.rules,
  //   },
  // },
]

Since eslint provides an API compatibility list, I think it would be possible to provide rules that work before v9.
https://eslint.org/blog/2023/09/preparing-custom-rules-eslint-v9/

if it were supported it would be great, because this plugin could be used for projects that have not yet been migrated that also support it.

The default value in the 'prefer-use-store-naming-convention' document is incorrect.

It's true in the documentation, but actually it's false

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

Got TypeError when I define a store with no return value

Reproduction:

import { defineStore } from 'pinia';

export const useAStore = defineStore('a', () => {
});

Rule: Disallow modifying state

See vuejs/pinia#58 (should be off by default)

And: vuejs/pinia#2612 (comment)