feat: add no-duplicate-store-ids

README.md

@@ -77,6 +77,7 @@ To use the all configuration, extend it in your `.eslintrc` file:
 
 | Name                                                                                         | Description                                                                                | 💼 | ⚠️ | 🚫 |
 | :------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :- | :- | :- |
+| [no-duplicate-store-ids](docs/rules/no-duplicate-store-ids.md)                               | Disallow duplicate store ids                                                               | ✅  | 🌐 |    |
 | [no-return-global-properties](docs/rules/no-return-global-properties.md)                     | Disallows returning globally provided properties from Pinia stores.                        | ✅  | 🌐 |    |
 | [prefer-single-store-per-file](docs/rules/prefer-single-store-per-file.md)                   | Encourages defining each store in a separate file.                                         |    |    | 🌐 |
 | [prefer-use-store-naming-convention](docs/rules/prefer-use-store-naming-convention.md)       | Enforces the convention of naming stores with the prefix `use` followed by the store name. |    | 🌐 |    |

docs/rules/no-duplicate-store-ids.md

@@ -0,0 +1,55 @@
+# Disallow duplicate store ids (`pinia/no-duplicate-store-ids`)
+
+💼⚠️ This rule is enabled in the ✅ `recommended` config. This rule _warns_ in the 🌐 `all` config.
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+❌ Examples of **incorrect** code for this rule:
+
+```js
+// a.js
+export const useBarStore = defineStore('bar', () => {
+  const bar = ref(0)
+
+  return { bar }
+})
+
+// b.js
+export const useAnotherBarStore = defineStore('bar', () => {
+  const foo = ref(0)
+
+  return { foo }
+})
+```
+
+```js
+export const useBarStore = defineStore('bar', () => {
+  const bar = ref(0)
+
+  return { bar }
+})
+
+export const useAnotherBarStore = defineStore('bar', () => {
+  const foo = ref(0)
+
+  return { foo }
+})
+```
+
+✅ Examples of **correct** code for this rule:
+
+```js
+export const useBarStore = defineStore('bar', () => {
+  const bar = ref(0)
+
+  return { bar }
+})
+
+export const useAnotherCounterStore = defineStore('foo', () => {
+  const foo = ref(0)
+
+  return { foo }
+})
+```

src/index.ts

@@ -14,6 +14,10 @@ import noReturnGlobalProperties, {
   RULE_NAME as noReturnGlobalPropertiesName
 } from './rules/no-return-global-properties'
 
+import noDuplicateStoreIds, {
+  RULE_NAME as noDuplicateStoreIdsName
+} from './rules/no-duplicate-store-ids'
+
 const createConfig = (rules: Record<string, string>) => ({
   plugins: ['pinia'],
   rules: Object.keys(rules).reduce((acc, ruleName) => {
@@ -28,20 +32,23 @@ const allRules = {
   [requireSetupStorePropsName]: 'warn',
   [preferNamingConventionName]: 'warn',
   [preferSingleStoreName]: 'off',
-  [noReturnGlobalPropertiesName]: 'warn'
+  [noReturnGlobalPropertiesName]: 'warn',
+  [noDuplicateStoreIdsName]: 'warn'
 }
 
 const recommended = {
   [requireSetupStorePropsName]: 'error',
-  [noReturnGlobalPropertiesName]: 'error'
+  [noReturnGlobalPropertiesName]: 'error',
+  [noDuplicateStoreIdsName]: 'error'
 }
 
 export default {
   rules: {
     [requireSetupStorePropsName]: requireSetupStoreProps,
     [preferNamingConventionName]: preferNamingConvention,
     [preferSingleStoreName]: preferSingleStore,
-    [noReturnGlobalPropertiesName]: noReturnGlobalProperties
+    [noReturnGlobalPropertiesName]: noReturnGlobalProperties,
+    [noDuplicateStoreIdsName]: noDuplicateStoreIds
   },
   configs: {
     all: createConfig(allRules),

src/rules/no-duplicate-store-ids.ts

@@ -0,0 +1,50 @@
+import { createEslintRule } from '../utils/rule-creator'
+import { AST_NODE_TYPES } from '@typescript-eslint/utils'
+
+export const RULE_NAME = 'no-duplicate-store-ids'
+export type MESSAGE_IDS = 'duplicatedStoreIds'
+type Options = []
+
+const usingStoreIds = new Set<string>()
+
+export default createEslintRule<Options, MESSAGE_IDS>({
+  name: RULE_NAME,
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallow duplicate store ids.'
+    },
+    schema: [],
+    messages: {
+      duplicatedStoreIds: 'No duplicated store ids allowed: {{storeId}}'
+    }
+  },
+  defaultOptions: [],
+  create: (context) => {
+    return {
+      CallExpression(node) {
+        const callee = node.callee
+        if (callee.type !== 'Identifier' || callee.name !== 'defineStore')
+          return
+
+        const storeId = node.arguments && node.arguments[0]
+
+        if (!storeId || storeId.type !== AST_NODE_TYPES.Literal) return
+
+        const value = storeId.value as string
+
+        if (usingStoreIds.has(value)) {
+          context.report({
+            node: storeId,
+            messageId: 'duplicatedStoreIds',
+            data: {
+              storeId: storeId.value
+            }
+          })
+        } else {
+          usingStoreIds.add(value)
+        }
+      }
+    }
+  }
+})

tests/rules/no-duplicate-store-ids.test.ts

@@ -0,0 +1,43 @@
+import rule, { RULE_NAME } from '../../src/rules/no-duplicate-store-ids'
+import { ruleTester } from '../rule-tester'
+
+ruleTester.run(RULE_NAME, rule, {
+  valid: [
+    {
+      code: `import { defineStore } from 'pinia'
+      export const useCounterStore = defineStore()`
+    },
+    {
+      code: `import { defineStore } from 'pinia'
+export const useCounterStore = defineStore('counter', () => {
+  const count = ref(0)
+  return { count }
+})
+  export const useTodoStore = defineStore('todo', () => {
+    const todo = ref(0)
+    return { todo }
+})`
+    }
+  ],
+  invalid: [
+    {
+      code: `import { defineStore } from 'pinia'
+
+const useCounterStore = defineStore('counter', () => {
+  const count = ref(0)
+  return { count }
+})
+
+const useCounter2Store = defineStore('counter', () => {
+})`,
+      errors: [
+        {
+          messageId: 'duplicatedStoreIds'
+        },
+        {
+          messageId: 'duplicatedStoreIds'
+        }
+      ]
+    }
+  ]
+})