feat: stricter settings.json snippets schema validation

For example now we report unknown properties in snippets configuration
Also now we display a suggestion in hover when possible to move property to when clause

Author: zardoy

.gitignore

@@ -26,5 +26,5 @@ experiment-*
 
 out
 src/generated.ts
-# TODO have no idea why TJS generates it
 src/configurationType.js
+src/configurationTypeCache.jsonc

src/configurationType.ts

@@ -1,4 +1,5 @@
 import * as vscode from 'vscode'
+import { Simplify } from 'type-fest'
 import { snippetLocation } from './constants'
 // import { SyntaxKind } from 'typescript/lib/tsserverlibrary'
 
@@ -46,6 +47,8 @@ export type GeneralSnippet = {
      * }]
      */
     body: string | string[] | false
+    /** @suggestSortText "3" */
+    extends?: string
     /**
      * @suggestSortText "4"
      */
@@ -180,11 +183,6 @@ export type TypingSnippetUnresolved = GeneralSnippet & {
     }
 }
 
-type TypingSnippetResolved = (Pick<TypingSnippetUnresolved, 'body' | 'sequence'> | { /** @suggestSortText "3" */ extends: string }) &
-    Omit<TypingSnippetUnresolved, 'body' | 'sequence'>
-type CustomSnippetResolved = (Pick<CustomSnippetUnresolved, 'body' | 'name'> | { /** @suggestSortText "3" */ extends: string }) &
-    Omit<CustomSnippetUnresolved, 'body' | 'name'>
-
 export type Configuration = {
     /**
      * Include builtin JS/MD snippets
@@ -231,11 +229,11 @@ export type Configuration = {
     /**
      * @suggestSortText betterSnippets.1
      */
-    customSnippets: CustomSnippetResolved[]
+    customSnippets: Array<Simplify<CustomSnippetUnresolved>>
     /**
      * @suggestSortText betterSnippets.2
      */
-    typingSnippets: TypingSnippetResolved[]
+    typingSnippets: Array<Simplify<TypingSnippetUnresolved>>
     /** @default true */
     typingSnippetsUndoStops: boolean
     /**
@@ -254,7 +252,10 @@ export type Configuration = {
      * @default true
      * */
     'snippetCreator.showSnippetAfterCreation': boolean
-    /** Override default values for every snippet */
+    /**
+     * Override default values for every snippet
+     * @additionalProperties false
+     */
     customSnippetDefaults: {
         sortText?: string
         iconType?: SnippetType

src/debugCommands.ts

@@ -1,16 +1,15 @@
 import * as vscode from 'vscode'
 import { showQuickPick } from '@zardoy/vscode-utils/build/quickPick'
-import { getExtensionSetting, getExtensionSettingId, registerExtensionCommand, VSCodeQuickPickItem } from 'vscode-framework'
+import { getExtensionSetting, getExtensionSettingId, registerExtensionCommand } from 'vscode-framework'
 import { compact } from '@zardoy/utils'
-import { CustomSnippetUnresolved, TypingSnippetUnresolved } from './configurationType'
 import { getAllExtensionSnippets, mergeSnippetWithDefaults } from './snippet'
 import { getConfigValueFromAllScopes } from './util'
 
 export default () => {
     registerExtensionCommand('showAllResolvedSnippets', async () => {
         // todo reuse getters from views.ts
-        const customUser = (getConfigValueFromAllScopes('customSnippets') as CustomSnippetUnresolved[]).map(snippet => mergeSnippetWithDefaults(snippet))
-        const typingUser = (getConfigValueFromAllScopes('typingSnippets') as TypingSnippetUnresolved[]).map(snippet => mergeSnippetWithDefaults(snippet))
+        const customUser = getConfigValueFromAllScopes('customSnippets').map(snippet => mergeSnippetWithDefaults(snippet))
+        const typingUser = getConfigValueFromAllScopes('typingSnippets').map(snippet => mergeSnippetWithDefaults(snippet))
 
         const customExt = getAllExtensionSnippets('customSnippets')
         const typingExt = getAllExtensionSnippets('typingSnippets')

src/extension.ts

@@ -29,7 +29,6 @@ import {
 import { getAllLoadedSnippets } from './loadedSnippets'
 import registerForceInsertSnippet from './forceInsertSnippet'
 import { ExposedExtensionApi } from './extensionApi'
-import { TypingSnippetUnresolved } from './configurationType'
 import registerDebugCommands from './debugCommands'
 import { isOtherLinesMatches } from './otherLines'
 
@@ -154,7 +153,7 @@ export const activate = () => {
 
         const snippetsToLoadByLang = getAllLoadedSnippets()
         const typingSnippets: CustomTypingSnippet[] = [
-            ...(getConfigValueFromAllScopes('typingSnippets') as TypingSnippetUnresolved[]).map(snippet => mergeSnippetWithDefaults(snippet)),
+            ...getConfigValueFromAllScopes('typingSnippets').map(snippet => mergeSnippetWithDefaults(snippet)),
             ...getAllExtensionSnippets('typingSnippets'),
         ]
         const snippetsToLoadFlattened = [...Object.values(snippetsToLoadByLang).flat(1), ...typingSnippets]

src/settingsHelper.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode'
 import { findNodeAtLocation, getLocation, getNodeValue, JSONPath, Node, parseTree } from 'jsonc-parser'
-import { getExtensionSettingId } from 'vscode-framework'
+import { extensionCtx, getExtensionSettingId } from 'vscode-framework'
 import { getJsonCompletingInfo, jsonPathEquals, jsonValuesToCompletions } from '@zardoy/vscode-utils/build/jsonCompletions'
 import { oneOf } from '@zardoy/utils'
 import { uniqBy } from 'lodash'
@@ -198,9 +198,28 @@ export default () => {
 
     vscode.languages.registerHoverProvider(selector, {
         provideHover(document: vscode.TextDocument, position: vscode.Position, token: any) {
+            const location = getLocation(document.getText(), document.offsetAt(position))
+            if (location.isAtPropertyKey && location.path[0]?.toString().startsWith('betterSnippets')) {
+                const diagnosticUnderCursor = vscode.languages.getDiagnostics(document.uri).find(({ range }) => range.contains(position))
+                const unknownSnippetProp = diagnosticUnderCursor && /Property (\w+) is not allowed./.exec(diagnosticUnderCursor.message)?.[1]
+                if (unknownSnippetProp) {
+                    const allPossibleWhenProps: string[] = []
+                    for (const { properties } of extensionCtx.extension.packageJSON.contributes.configuration.properties['betterSnippets.customSnippets'].items
+                        .properties.when.allOf) {
+                        allPossibleWhenProps.push(...Object.keys(properties))
+                    }
+
+                    if (allPossibleWhenProps.includes(unknownSnippetProp)) {
+                        return {
+                            contents: [new vscode.MarkdownString(`Did you mean to move \`${unknownSnippetProp}\` to \`when\` clause?`)],
+                        }
+                    }
+                }
+            }
+
             const sharedParsingInfo = getSharedParsingInfo(document, position)
             if (!sharedParsingInfo) return
-            const { isAnySnippet, localPath, insideStringRange, nodeValue } = sharedParsingInfo
+            const { nodeValue, insideStringRange, isAnySnippet, localPath } = sharedParsingInfo
             if (!insideStringRange) return
             let providerResult: vscode.Hover | undefined
             try {

src/views.ts

@@ -5,7 +5,6 @@ import { CommandHandler, getExtensionCommandId, getExtensionContributionsPrefix,
 import { groupBy, sort } from 'rambda'
 import { watchExtensionSettings } from '@zardoy/vscode-utils/build/settings'
 import { CommonSnippet, getSnippetsSettingValue, RevealSnippetOptions } from './settingsJsonSnippetCommands'
-import { GeneralSnippet } from './configurationType'
 import { getSnippetsDefaults, mergeSnippetWithDefaults, normalizeWhenLangs } from './snippet'
 
 const SCHEME = `${getExtensionContributionsPrefix()}virtualSnippets`

vscode-framework.config.js

@@ -40,6 +40,23 @@ const config = defineConfig({
                 },
             }
         },
+        ({ generatedManifest }) => {
+            // @ts-ignore
+            const { properties } = generatedManifest.contributes.configuration
+            for (const [i, key] of ['betterSnippets.customSnippets', 'betterSnippets.typingSnippets'].entries()) {
+                const snippetsProp = properties[key].items
+                const requiredProps = [[i ? 'sequence' : 'name', 'body'], ['extends']]
+                snippetsProp.anyOf = requiredProps.map(props => ({ required: props }))
+                snippetsProp.required = undefined
+                snippetsProp.additionalProperties = false
+                snippetsProp.patternProperties = {
+                    '^\\$': {},
+                }
+            }
+
+            properties['betterSnippets.extendsGroups'].additionalProperties.additionalProperties = false
+            return {}
+        },
     ],
 })