eslint-plugin-vue-perfectionist 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-PRESENT ntnyq <https://github.com/ntnyq>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,94 @@
+# eslint-plugin-vue-perfectionist
+
+[![CI](https://github.com/ntnyq/eslint-plugin-vue-perfectionist/workflows/CI/badge.svg)](https://github.com/ntnyq/eslint-plugin-vue-perfectionist/actions)
+[![NPM VERSION](https://img.shields.io/npm/v/eslint-plugin-vue-perfectionist.svg)](https://www.npmjs.com/package/eslint-plugin-vue-perfectionist)
+[![NPM DOWNLOADS](https://img.shields.io/npm/dy/eslint-plugin-vue-perfectionist.svg)](https://www.npmjs.com/package/eslint-plugin-vue-perfectionist)
+[![LICENSE](https://img.shields.io/github/license/ntnyq/eslint-plugin-vue-perfectionist.svg)](https://github.com/ntnyq/eslint-plugin-vue-perfectionist/blob/main/LICENSE)
+
+ESLint rules for consistent, readable, and maintainable Vue 3 code.
+
+Starting with configurable ordering for `<script setup>`, this plugin aims to provide a growing collection of Vue-specific rules for code organization, consistency, and maintainability. Sorting is the first area of focus, with more rules planned beyond ordering.
+
+**Supports Vue 3 only. Vue 2 is not supported.**
+
+## Status
+
+This project is in early development. The first rule and flat ESLint configuration presets are implemented. The API may change before the first stable release.
+
+## Scope
+
+The first rule targets top-level statements inside Vue 3 `<script setup>` blocks, including JavaScript and TypeScript. It is intended to help organize compiler macros, type declarations, reactive state, computed values, functions, watchers, and lifecycle hooks.
+
+Ordinary `<script>` blocks, Options API component options, and function bodies are outside the first rule's scope. Future rules may cover other aspects of Vue 3 code.
+
+The plugin is intended to complement `eslint-plugin-vue` and `eslint-plugin-perfectionist`. Existing rules can continue to handle Vue correctness checks, import sorting, and ordering within objects or types.
+
+## Rules
+
+| Rule                                                                       | Description                                                                             | Status    |
+| -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------- |
+| [`vue-perfectionist/sort-script-setup`](./docs/rules/sort-script-setup.md) | Enforce configurable grouping and ordering of top-level statements in `<script setup>`. | Available |
+
+### sort-script-setup
+
+The sorting API is inspired by `eslint-plugin-perfectionist`, with Vue-specific statement groups:
+
+- `groups` defines the order of statement categories.
+- `customGroups` allows project-specific classification, such as custom composables.
+- `type` and `order` control sorting within a group. The default, `type: 'unsorted'`, preserves the original order within groups while still enforcing group order.
+- `newlinesBetween` and `newlinesInside` control spacing between groups and statements.
+- `partitionByComment` and `partitionByNewLine` define separate sorting regions.
+
+Execution dependencies take priority over the configured order. Automatic fixes apply only to changes that can be verified to preserve behavior; recognizing a Vue API call does not make it safe to move. Fixes cover independent type declarations, primitive constant declarations, ordinary function declarations, and spacing. Reordering runtime calls, watchers, or lifecycle registrations is reported without an automatic fix.
+
+The rule keeps imports in place and leaves import sorting to `perfectionist/sort-imports`. Disable `perfectionist/sort-modules` and `vue/define-macros-order` for the same `.vue` files when this rule manages their declarations and macros.
+
+See the [rule documentation](./docs/rules/sort-script-setup.md) for all options, matching semantics, and safety limits. Full compatibility with Perfectionist's options is not promised.
+
+## Install
+
+Requires ESLint 9.10+ or 10 and `vue-eslint-parser` 10. TypeScript SFCs also require `@typescript-eslint/parser`.
+
+```shell
+npm install -D eslint-plugin-vue-perfectionist
+```
+
+```shell
+yarn add -D eslint-plugin-vue-perfectionist
+```
+
+```shell
+pnpm add -D eslint-plugin-vue-perfectionist
+```
+
+## Usage
+
+```js
+import tsParser from '@typescript-eslint/parser'
+import vueParser from 'vue-eslint-parser'
+import vuePerfectionist from 'eslint-plugin-vue-perfectionist'
+
+export default [
+  {
+    files: ['**/*.vue'],
+    languageOptions: {
+      parser: vueParser,
+      parserOptions: { parser: tsParser },
+    },
+  },
+  vuePerfectionist.configs.recommended,
+]
+```
+
+For JavaScript-only SFCs, omit `parserOptions.parser`. Existing Vue configurations can supply the parsers instead. The plugin also exports `recommended-natural` and `recommended-alphabetical` presets through `configs`.
+
+## Credits
+
+- [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist) for inspiring the sorting rule names, grouping model, and configuration API.
+- [eslint-plugin-vue](https://github.com/vuejs/eslint-plugin-vue) and [vue-eslint-parser](https://github.com/vuejs/vue-eslint-parser) for their work on Vue linting and single-file component parsing.
+
+This is an independent project and is not an official extension of `eslint-plugin-perfectionist` or `eslint-plugin-vue`.
+
+## License
+
+[MIT](./LICENSE) License © 2026-PRESENT [ntnyq](https://github.com/ntnyq)

package/dist/index.d.mts

@@ -0,0 +1,94 @@
+import "@typescript-eslint/utils";
+import { ESLint, Linter } from "eslint";
+//#region src/types/plugins.d.ts
+type PresetName = 'recommended-alphabetical' | 'recommended-natural' | 'recommended';
+type PluginConfigs = Record<PresetName, Linter.Config>;
+/**
+ * Public plugin contract keeps ESLint's host types portable in declarations.
+ */
+interface VuePerfectionistPlugin extends ESLint.Plugin {
+  configs: PluginConfigs;
+  meta: {
+    name: string;
+    version: string;
+  };
+}
+//#endregion
+//#region src/types/rules/sort-script-setup.d.ts
+type SortType = 'alphabetical' | 'custom' | 'line-length' | 'natural' | 'unsorted';
+type SortOrder = 'asc' | 'desc';
+type Newlines = 'ignore' | number;
+type RegexPattern = string | {
+  pattern: string;
+  flags?: string;
+};
+type RegexOption = RegexPattern | RegexPattern[];
+type CommentPartition = boolean | RegexOption | {
+  block?: boolean | RegexOption;
+  line?: boolean | RegexOption;
+};
+interface FallbackSort {
+  type: 'subgroup-order' | SortType;
+  order?: SortOrder;
+}
+interface GroupOverrides {
+  fallbackSort?: FallbackSort;
+  newlinesInside?: Newlines;
+  order?: SortOrder;
+  type?: SortType;
+}
+type GroupEntry = string | string[] | (GroupOverrides & {
+  group: string | string[];
+}) | {
+  newlinesBetween: Newlines;
+};
+type Selector = 'call' | 'class' | 'composable' | 'computed' | 'constant' | 'define-emits' | 'define-expose' | 'define-model' | 'define-options' | 'define-props' | 'define-slots' | 'enum' | 'function' | 'inject' | 'interface' | 'lifecycle-hook' | 'provide' | 'reactive' | 'ref' | 'template-ref' | 'type' | 'variable' | 'watch';
+type Modifier = 'async' | 'const' | 'declare' | 'destructured' | 'let' | 'var';
+interface MatchCondition {
+  callNamePattern?: RegexOption;
+  elementNamePattern?: RegexOption;
+  importSourcePattern?: RegexOption;
+  modifiers?: Modifier[];
+  selector?: Selector;
+}
+type CustomGroup = GroupOverrides & {
+  groupName: string;
+} & ((MatchCondition & {
+  anyOf?: never;
+}) | {
+  anyOf: MatchCondition[];
+});
+/**
+ * Sorting preferences shared by the rule and plugin settings.
+ */
+interface CommonSortOptions {
+  alphabet?: string;
+  fallbackSort?: FallbackSort;
+  ignoreCase?: boolean;
+  locales?: string | string[];
+  newlinesBetween?: Newlines;
+  newlinesInside?: 'newlinesBetween' | Newlines;
+  order?: SortOrder;
+  partitionByComment?: CommentPartition;
+  partitionByNewLine?: boolean;
+  specialCharacters?: 'keep' | 'remove' | 'trim';
+  type?: SortType;
+}
+/**
+ * Options for ordering top-level Vue 3 script setup statements.
+ */
+interface SortScriptSetupOptions extends CommonSortOptions {
+  customGroups?: CustomGroup[];
+  fix?: 'none' | 'safe';
+  groups?: GroupEntry[];
+  vueGlobals?: string[];
+  vueImportSources?: string[];
+}
+//#endregion
+//#region src/configs.d.ts
+export declare const configs: PluginConfigs;
+//#endregion
+//#region src/index.d.ts
+export declare const plugin: VuePerfectionistPlugin;
+//#endregion
+export { type CommonSortOptions, type CustomGroup, type GroupEntry, type PluginConfigs, type PresetName, type SortScriptSetupOptions, type VuePerfectionistPlugin, plugin as default };