|
| 1 | +use oxc_ast::{ |
| 2 | + AstKind, |
| 3 | + ast::{ImportDeclarationSpecifier, ModuleExportName}, |
| 4 | +}; |
| 5 | +use oxc_diagnostics::OxcDiagnostic; |
| 6 | +use oxc_macros::declare_oxc_lint; |
| 7 | +use oxc_span::{Atom, Span}; |
| 8 | + |
| 9 | +use crate::{AstNode, context::LintContext, frameworks::FrameworkOptions, rule::Rule}; |
| 10 | + |
| 11 | +fn no_import_compiler_macros_diagnostic(span: Span, name: &Atom) -> OxcDiagnostic { |
| 12 | + OxcDiagnostic::warn(format!("'{name}' is a compiler macro and doesn't need to be imported.")) |
| 13 | + .with_help("Remove the import statement for this macro.") |
| 14 | + .with_label(span) |
| 15 | +} |
| 16 | + |
| 17 | +#[derive(Debug, Default, Clone)] |
| 18 | +pub struct NoImportCompilerMacros; |
| 19 | + |
| 20 | +declare_oxc_lint!( |
| 21 | + /// ### What it does |
| 22 | + /// |
| 23 | + /// Disallow importing Vue compiler macros. |
| 24 | + /// |
| 25 | + /// ### Why is this bad? |
| 26 | + /// |
| 27 | + /// Compiler Macros like: |
| 28 | + /// - `defineProps` |
| 29 | + /// - `defineEmits` |
| 30 | + /// - `defineExpose` |
| 31 | + /// - `withDefaults` |
| 32 | + /// - `defineModel` |
| 33 | + /// - `defineOptions` |
| 34 | + /// - `defineSlots` |
| 35 | + /// |
| 36 | + /// are globally available in Vue 3's `<script setup>` and do not require explicit imports. |
| 37 | + /// |
| 38 | + /// ### Examples |
| 39 | + /// |
| 40 | + /// Examples of **incorrect** code for this rule: |
| 41 | + /// ```vue |
| 42 | + /// <script setup> |
| 43 | + /// import { defineProps, withDefaults } from 'vue' |
| 44 | + /// </script> |
| 45 | + /// ``` |
| 46 | + /// |
| 47 | + /// Examples of **correct** code for this rule: |
| 48 | + /// ```vue |
| 49 | + /// <script setup> |
| 50 | + /// import { ref } from 'vue' |
| 51 | + /// </script> |
| 52 | + /// ``` |
| 53 | + NoImportCompilerMacros, |
| 54 | + vue, |
| 55 | + restriction, |
| 56 | + fix |
| 57 | +); |
| 58 | + |
| 59 | +const COMPILER_MACROS: &[&str; 7] = &[ |
| 60 | + "defineProps", |
| 61 | + "defineEmits", |
| 62 | + "defineExpose", |
| 63 | + "withDefaults", |
| 64 | + "defineModel", |
| 65 | + "defineOptions", |
| 66 | + "defineSlots", |
| 67 | +]; |
| 68 | + |
| 69 | +const VUE_MODULES: &[&str; 3] = &["vue", "@vue/runtime-core", "@vue/runtime-dom"]; |
| 70 | + |
| 71 | +impl Rule for NoImportCompilerMacros { |
| 72 | + fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) { |
| 73 | + let AstKind::ImportDeclaration(import_decl) = node.kind() else { |
| 74 | + return; |
| 75 | + }; |
| 76 | + |
| 77 | + let Some(specifiers) = &import_decl.specifiers else { |
| 78 | + return; |
| 79 | + }; |
| 80 | + |
| 81 | + if !VUE_MODULES.contains(&import_decl.source.value.as_str()) { |
| 82 | + return; |
| 83 | + } |
| 84 | + |
| 85 | + for (index, specifier) in specifiers.iter().enumerate() { |
| 86 | + let ImportDeclarationSpecifier::ImportSpecifier(import_specifier) = &specifier else { |
| 87 | + continue; |
| 88 | + }; |
| 89 | + |
| 90 | + let ModuleExportName::IdentifierName(imported_name) = &import_specifier.imported else { |
| 91 | + continue; |
| 92 | + }; |
| 93 | + |
| 94 | + if !COMPILER_MACROS.contains(&imported_name.name.as_str()) { |
| 95 | + continue; |
| 96 | + } |
| 97 | + #[expect(clippy::cast_possible_truncation)] |
| 98 | + ctx.diagnostic_with_fix( |
| 99 | + no_import_compiler_macros_diagnostic(import_specifier.span, &imported_name.name), |
| 100 | + |fixer| { |
| 101 | + if specifiers.len() == 1 { |
| 102 | + fixer.delete(import_decl) |
| 103 | + } else if index == 0 { |
| 104 | + let part_source = ctx.source_range(Span::new( |
| 105 | + import_specifier.span.end, |
| 106 | + import_decl.span.end, |
| 107 | + )); |
| 108 | + let next_comma_index = part_source.find(',').unwrap_or_default(); |
| 109 | + fixer.delete_range(Span::new( |
| 110 | + import_specifier.span.start, |
| 111 | + import_specifier.span.end + next_comma_index as u32 + 1, |
| 112 | + )) |
| 113 | + } else { |
| 114 | + let part_source = ctx.source_range(Span::new( |
| 115 | + import_decl.span.start, |
| 116 | + import_specifier.span.start, |
| 117 | + )); |
| 118 | + let last_comma_index = part_source.rfind(',').unwrap_or_default(); |
| 119 | + fixer.delete_range(Span::new( |
| 120 | + import_decl.span.start + last_comma_index as u32, |
| 121 | + import_specifier.span.end, |
| 122 | + )) |
| 123 | + } |
| 124 | + }, |
| 125 | + ); |
| 126 | + } |
| 127 | + } |
| 128 | + |
| 129 | + fn should_run(&self, ctx: &crate::context::ContextHost) -> bool { |
| 130 | + if cfg!(test) { |
| 131 | + // enable it fully for tests, the `with_fix` tests are not available with custom filepaths, |
| 132 | + // to load partial source text. |
| 133 | + true |
| 134 | + } else { |
| 135 | + ctx.frameworks_options() == FrameworkOptions::VueSetup |
| 136 | + } |
| 137 | + } |
| 138 | +} |
| 139 | + |
| 140 | +#[test] |
| 141 | +fn test() { |
| 142 | + use crate::tester::Tester; |
| 143 | + use std::path::PathBuf; |
| 144 | + |
| 145 | + let pass = vec![ |
| 146 | + ( |
| 147 | + " |
| 148 | + <script setup> |
| 149 | + import { ref, computed } from 'vue' |
| 150 | + import { someFunction } from '@vue/runtime-core' |
| 151 | + </script> |
| 152 | + ", |
| 153 | + None, |
| 154 | + None, |
| 155 | + Some(PathBuf::from("test.vue")), |
| 156 | + ), |
| 157 | + ( |
| 158 | + " |
| 159 | + <script> |
| 160 | + import { defineProps } from 'some-other-package' |
| 161 | + </script> |
| 162 | + ", |
| 163 | + None, |
| 164 | + None, |
| 165 | + Some(PathBuf::from("test.vue")), |
| 166 | + ), |
| 167 | + ]; |
| 168 | + |
| 169 | + let fail = vec![ |
| 170 | + ( |
| 171 | + " |
| 172 | + <script setup> |
| 173 | + import { defineProps } from 'vue' |
| 174 | + </script> |
| 175 | + ", |
| 176 | + None, |
| 177 | + None, |
| 178 | + Some(PathBuf::from("test.vue")), |
| 179 | + ), |
| 180 | + ( |
| 181 | + " |
| 182 | + <script setup> |
| 183 | + import { |
| 184 | + ref, |
| 185 | + defineProps |
| 186 | + } from 'vue' |
| 187 | + </script> |
| 188 | + ", |
| 189 | + None, |
| 190 | + None, |
| 191 | + Some(PathBuf::from("test.vue")), |
| 192 | + ), |
| 193 | + ( |
| 194 | + " |
| 195 | + <script setup> |
| 196 | + import { ref, defineProps } from 'vue' |
| 197 | + import { defineEmits, computed } from '@vue/runtime-core' |
| 198 | + import { defineExpose, watch, withDefaults } from '@vue/runtime-dom' |
| 199 | + </script> |
| 200 | + ", |
| 201 | + None, |
| 202 | + None, |
| 203 | + Some(PathBuf::from("test.vue")), |
| 204 | + ), |
| 205 | + ( |
| 206 | + " |
| 207 | + <script setup> |
| 208 | + import { defineModel, defineOptions } from 'vue' |
| 209 | + </script> |
| 210 | + ", |
| 211 | + None, |
| 212 | + None, |
| 213 | + Some(PathBuf::from("test.vue")), |
| 214 | + ), |
| 215 | + ( |
| 216 | + r#" |
| 217 | + <script setup lang="ts"> |
| 218 | + import { ref as refFoo, defineSlots as defineSlotsFoo, type computed } from '@vue/runtime-core' |
| 219 | + </script> |
| 220 | + "#, |
| 221 | + None, |
| 222 | + None, |
| 223 | + Some(PathBuf::from("test.vue")), |
| 224 | + ), // { "parserOptions": { "parser": require.resolve("@typescript-eslint/parser") } } |
| 225 | + ]; |
| 226 | + |
| 227 | + let fix = vec![ |
| 228 | + ("import { defineProps } from 'vue'", "", None), |
| 229 | + ( |
| 230 | + " |
| 231 | + import { |
| 232 | + ref, |
| 233 | + defineProps |
| 234 | + } from 'vue' |
| 235 | + ", |
| 236 | + " |
| 237 | + import { |
| 238 | + ref |
| 239 | + } from 'vue' |
| 240 | + ", |
| 241 | + None, |
| 242 | + ), |
| 243 | + ( |
| 244 | + " |
| 245 | + import { ref, defineProps } from 'vue' |
| 246 | + import { defineEmits, computed } from '@vue/runtime-core' |
| 247 | + import { defineExpose, watch, withDefaults } from '@vue/runtime-dom' |
| 248 | + ", |
| 249 | + " |
| 250 | + import { ref } from 'vue' |
| 251 | + import { computed } from '@vue/runtime-core' |
| 252 | + import { watch } from '@vue/runtime-dom' |
| 253 | + ", |
| 254 | + None, |
| 255 | + ), |
| 256 | + ( |
| 257 | + " |
| 258 | + import { defineModel, defineOptions } from 'vue' |
| 259 | + ", |
| 260 | + " |
| 261 | + import { defineOptions } from 'vue' |
| 262 | + ", |
| 263 | + None, |
| 264 | + ), |
| 265 | + ( |
| 266 | + r" |
| 267 | + import { ref as refFoo, defineSlots as defineSlotsFoo, type computed } from '@vue/runtime-core' |
| 268 | + ", |
| 269 | + r" |
| 270 | + import { ref as refFoo, type computed } from '@vue/runtime-core' |
| 271 | + ", |
| 272 | + None, |
| 273 | + ), |
| 274 | + ]; |
| 275 | + Tester::new(NoImportCompilerMacros::NAME, NoImportCompilerMacros::PLUGIN, pass, fail) |
| 276 | + .expect_fix(fix) |
| 277 | + .test_and_snapshot(); |
| 278 | +} |
0 commit comments