feat: add highly customizable arrayMethodsSnippets!

No reason to not enable them! Disabled by defeault, just to not suprprise everyone!

Author: zardoy

README.MD

@@ -37,6 +37,18 @@ You can turn off emmet integration in JSX and stable emmet suggestion will be *a
 
 - supports only tag expansion for now, have 2 modes
 
+### Array Method Snippets
+
+(*disabled by default*)
+
+Edits array suggestions that receive predicate in the following way:
+
+```ts
+const usersList = []
+
+usersList.map // -> usersList.map((user) => )
+```
+
 ### Remove Definition From References
 
 (*enabled by default*)

package.json

@@ -54,7 +54,6 @@
         "type-fest": "^2.13.1",
         "typed-jsonfile": "^0.2.1",
         "typescript": "^4.8.3",
-        "typescript-essential-plugins": "workspace:*",
         "typescript-old": "npm:[email protected]",
         "vitest": "^0.15.1",
         "vscode-manifest": "^0.0.4"
@@ -64,6 +63,7 @@
         "@types/glob": "^8.0.0",
         "@types/lodash": "^4.14.182",
         "@types/mocha": "^9.1.1",
+        "@types/pluralize": "^0.0.29",
         "@vscode/emmet-helper": "^2.8.4",
         "@vscode/test-electron": "^2.1.5",
         "@zardoy/utils": "^0.0.9",
@@ -81,6 +81,7 @@
         "lodash.throttle": "^4.1.1",
         "mocha": "^10.0.0",
         "modify-json-file": "^1.2.2",
+        "pluralize": "github:plurals/pluralize#36f03cd2d573fa6d23e12e1529fa4627e2af74b4",
         "require-from-string": "^2.0.2",
         "string-dedent": "^3.0.1",
         "vscode-framework": "^0.0.18"

pnpm-lock.yaml

@@ -55,10 +55,26 @@ export type Configuration = {
     'suggestions.keywordsInsertText': 'none' | 'space'
     // TODO! corrent watching!
     /**
-     *
+     * Wether to enable snippets for array methods like `items.map(item => )`
+     * @default false
+     */
+    'arrayMethodsSnippets.enable': boolean
+    /**
+     * Add tabstop at arg so you can easily change it or add `i`
+     * If set to `false`, arg is added without parentheses
      * @default true
      */
-    // 'patchArrayMethods.enable': boolean
+    'arrayMethodsSnippets.addArgTabStop': boolean
+    /**
+     * Add outer tabstop so you can easily pass callback instead
+     * @default false
+     */
+    'arrayMethodsSnippets.addOuterTabStop': boolean
+    /**
+     * If set to `false` and singular item name can't be inffered, feature will be disabled
+     * @default item
+     */
+    'arrayMethodsSnippets.defaultItemName': string | false
     /**
      * Highlight and lift non-function methods. Also applies for static class methods. Uses `bind`, `call`, `caller` detection.
      * @default true
@@ -136,7 +152,7 @@ export type Configuration = {
     /** Diagnostics (if not handled by eslint) & completions */
     // 'dotImportsMap.enable': boolean,
     /**
-     * One of the most powerful setting here. It lets you remove/edit any suggestion that comes from TS.
+     * One of the most powerful setting here. It lets you remove/edit any suggestion that comes from TS. However its' experimental and can conflict with our completion changes.
      * **Please** try to always specify kind (e.g. variable) of the suggestion to ensure you don't remove word-suggestion or postfix snippet
      * @default []
      */
@@ -178,7 +194,7 @@ export type Configuration = {
      */
     supportTsDiagnosticDisableComment: boolean
     /**
-     * Patch TypeScript outline!
+     * Extend TypeScript outline!
      * Extend outline with:
      * - JSX Elements
      * more coming soon...

pnpm-workspace.yaml

@@ -0,0 +1,50 @@
+import { GetConfig } from '../types'
+import { findChildContainingPosition, getLineTextBeforePos } from '../utils'
+import { singular } from 'pluralize'
+
+export default (entries: ts.CompletionEntry[], _node: ts.Node | undefined, position: number, sourceFile: ts.SourceFile, c: GetConfig): ts.CompletionEntry[] => {
+    if (!c('arrayMethodsSnippets.enable')) return entries
+    /** Methods to patch */
+    const arrayMethods = [
+        'forEach',
+        'map',
+        'flatMap',
+        'filter',
+        'find',
+        'findIndex',
+        //  'reduce',
+        //  'reduceRight',
+        'some',
+        'every',
+    ]
+    const fullText = sourceFile.getText()
+    if (fullText.slice(position, position + 1) === '(') return entries
+    const isSeemsArray = arrayMethods.every(comparingName =>
+        entries.some(({ name, isSnippet, kind }) => name === comparingName && !isSnippet && kind === ts.ScriptElementKind.memberFunctionElement),
+    )
+    if (!isSeemsArray) return entries
+    const lineTextBefore = getLineTextBeforePos(sourceFile, position)
+    const postfixRemoveLength = /\.\w*$/.exec(lineTextBefore)?.[0]?.length
+    if (postfixRemoveLength === undefined) return entries
+    const nodeBeforeDot = findChildContainingPosition(ts, sourceFile, position - postfixRemoveLength - 1)
+    if (!nodeBeforeDot) return entries
+    if (!ts.isIdentifier(nodeBeforeDot)) return entries
+    const cleanSourceText = nodeBeforeDot.text.replace(/^(?:all)?(.+?)(?:List)?$/, '$1')
+    let inferredName = singular(cleanSourceText)
+    const defaultItemName = c('arrayMethodsSnippets.defaultItemName')
+    if (inferredName === cleanSourceText) {
+        if (defaultItemName === false) return entries
+        inferredName = defaultItemName
+    }
+    return entries.map(entry => {
+        if (!arrayMethods.includes(entry.name)) return entry
+        const arrayItemSnippet = c('arrayMethodsSnippets.addArgTabStop') ? `(\${2:${inferredName}})` : inferredName
+        let insertInnerSnippet = `${arrayItemSnippet} => $3`
+        if (c('arrayMethodsSnippets.addOuterTabStop')) insertInnerSnippet = `\${1:${insertInnerSnippet}}`
+        return {
+            ...entry,
+            insertText: `${entry.insertText ?? entry.name}(${insertInnerSnippet})`,
+            isSnippet: true,
+        }
+    })
+}

src/configurationType.ts

@@ -8,6 +8,7 @@ import indexSignatureAccessCompletions from './completions/indexSignatureAccess'
 import fixPropertiesSorting from './completions/fixPropertiesSorting'
 import { isGoodPositionBuiltinMethodCompletion } from './completions/isGoodPositionMethodCompletion'
 import improveJsxCompletions from './completions/jsxAttributes'
+import arrayMethods from './completions/arrayMethods'
 
 export type PrevCompletionMap = Record<string, { originalName?: string; documentationOverride?: string | tslib.SymbolDisplayPart[] }>
 
@@ -208,6 +209,8 @@ export const getCompletionsAtPosition = (
         })
     }
 
+    prior.entries = arrayMethods(prior.entries, node, position, sourceFile, c)
+
     if (c('improveJsxCompletions') && leftNode) prior.entries = improveJsxCompletions(ts, prior.entries, leftNode, position, sourceFile, c('jsxCompletionsMap'))
 
     for (const rule of c('replaceSuggestions')) {

typescript/src/completions/arrayMethods.ts

@@ -52,3 +52,8 @@ export const findClosestParent = (ts: typeof tslib, node: tslib.Node, stopKinds:
 
     return node
 }
+
+export const getLineTextBeforePos = (sourceFile: ts.SourceFile, position: number) => {
+    const { character } = sourceFile.getLineAndCharacterOfPosition(position)
+    return sourceFile.getText().slice(position - character, position)
+}