Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(language-core): add checkUnknownDirectives option #5141

Merged
merged 5 commits into from
Feb 14, 2025
Merged

feat(language-core): add checkUnknownDirectives option #5141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
66f3e4e
feat: add `checkUnknownDirectives` option
KazariEX Jan 22, 2025
d56d260
fix: `withoutHighlight`
KazariEX Feb 13, 2025
3ad211b
Merge branch 'master' of https://github.com/vuejs/language-tools into…
KazariEX Feb 14, 2025
aaf14ee
chore: restore
KazariEX Feb 14, 2025
e9a0074
docs: update schema
KazariEX Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/language-core/lib/codegen/script/scriptSetup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { combineLastMapping, endOfLine, generateSfcBlockSection, newLine } from
import { generateComponent, generateEmitsOption } from './component';
import { generateComponentSelf } from './componentSelf';
import type { ScriptCodegenContext } from './context';
import { ScriptCodegenOptions, generateScriptSectionPartiallyEnding } from './index';
import { type ScriptCodegenOptions, generateScriptSectionPartiallyEnding } from './index';
import { generateTemplate } from './template';

export function* generateScriptSetupImports(
Expand Down
2 changes: 1 addition & 1 deletion packages/language-core/lib/codegen/template/context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export function createTemplateCodegenContext(options: Pick<TemplateCodegenOption
shouldReport: () => {
token.errors++;
return false;
}
},
},
};
}
Expand Down
23 changes: 17 additions & 6 deletions packages/language-core/lib/codegen/template/elementDirectives.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import * as CompilerDOM from '@vue/compiler-dom';
import { camelize } from '@vue/shared';
import type { Code } from '../../types';
import { hyphenateAttr } from '../../utils/shared';
import { codeFeatures } from '../codeFeatures';
import { endOfLine, wrapWith } from '../utils';
import { generateCamelized } from '../utils/camelized';
import { generateStringLiteralKey } from '../utils/stringLiteralKey';
Expand All @@ -10,6 +11,15 @@ import type { TemplateCodegenOptions } from './index';
import { generateInterpolation } from './interpolation';
import { generateObjectProperty } from './objectProperty';

const builtInDirectives = new Set([
'cloak',
'html',
'memo',
'once',
'show',
'text',
]);

export function* generateElementDirectives(
options: TemplateCodegenOptions,
ctx: TemplateCodegenContext,
Expand All @@ -34,7 +44,7 @@ export function* generateElementDirectives(
prop.loc.end.offset,
ctx.codeFeatures.verification,
`__VLS_asFunctionalDirective(`,
...generateIdentifier(ctx, prop),
...generateIdentifier(options, ctx, prop),
`)(null!, { ...__VLS_directiveBindingRestFields, `,
...generateArg(options, ctx, prop),
...generateModifiers(options, ctx, prop),
Expand All @@ -46,6 +56,7 @@ export function* generateElementDirectives(
}

function* generateIdentifier(
options: TemplateCodegenOptions,
ctx: TemplateCodegenContext,
prop: CompilerDOM.DirectiveNode
): Generator<Code> {
Expand All @@ -58,16 +69,16 @@ function* generateIdentifier(
...generateCamelized(
rawName,
prop.loc.start.offset,
{
...ctx.codeFeatures.withoutHighlight,
ctx.resolveCodeFeatures({
...codeFeatures.withoutHighlight,
// fix https://github.com/vuejs/language-tools/issues/1905
...ctx.codeFeatures.additionalCompletion,
verification: false,
...codeFeatures.additionalCompletion,
verification: options.vueCompilerOptions.checkUnknownDirectives && !builtInDirectives.has(prop.name),
navigation: {
resolveRenameNewName: camelize,
resolveRenameEditText: getPropRenameApply(prop.name),
},
}
})
)
);
}
Expand Down
1 change: 1 addition & 0 deletions packages/language-core/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export interface VueCompilerOptions {
jsxSlots: boolean;
checkUnknownProps: boolean;
checkUnknownEvents: boolean;
checkUnknownDirectives: boolean;
checkUnknownComponents: boolean;
skipTemplateCodegen: boolean;
fallthroughAttributes: boolean;
Expand Down
1 change: 1 addition & 0 deletions packages/language-core/lib/utils/ts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ export function getDefaultCompilerOptions(target = 99, lib = 'vue', strictTempla
jsxSlots: false,
checkUnknownProps: strictTemplates,
checkUnknownEvents: strictTemplates,
checkUnknownDirectives: strictTemplates,
checkUnknownComponents: strictTemplates,
skipTemplateCodegen: false,
fallthroughAttributes: false,
Expand Down
5 changes: 5 additions & 0 deletions packages/language-core/schemas/vue-tsconfig.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@
"default": false,
"markdownDescription": "Check unknown events. If not set, uses the 'strictTemplates' value."
},
"checkUnknownDirectives": {
"type": "boolean",
"default": false,
"markdownDescription": "Check unknown directives. If not set, uses the 'strictTemplates' value."
},
"checkUnknownComponents": {
"type": "boolean",
"default": false,
Expand Down